1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage metrics
|
---|
4 | -->
|
---|
5 | <!--
|
---|
6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
7 |
|
---|
8 | This file is part of VirtualBox base platform packages, as
|
---|
9 | available from https://www.virtualbox.org.
|
---|
10 |
|
---|
11 | This program is free software; you can redistribute it and/or
|
---|
12 | modify it under the terms of the GNU General Public License
|
---|
13 | as published by the Free Software Foundation, in version 3 of the
|
---|
14 | License.
|
---|
15 |
|
---|
16 | This program is distributed in the hope that it will be useful, but
|
---|
17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
19 | General Public License for more details.
|
---|
20 |
|
---|
21 | You should have received a copy of the GNU General Public License
|
---|
22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
23 |
|
---|
24 | SPDX-License-Identifier: GPL-3.0-only
|
---|
25 | -->
|
---|
26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
---|
28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
---|
29 | %all.entities;
|
---|
30 | ]>
|
---|
31 | <refentry id="vboxmanage-metrics" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-01-17 14:15:46 +0000 (Tue, 17 Jan 2023) $</pubdate>
|
---|
34 | <title>VBoxManage metrics</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-metrics</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-metrics</refname>
|
---|
44 | <refpurpose>мониторинг использования системных ресурсов</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-metrics-collect">
|
---|
50 | <command>VBoxManage metrics collect</command>
|
---|
51 | <arg>--detach</arg>
|
---|
52 | <arg>--list</arg>
|
---|
53 | <arg>--period=<replaceable>секунды</replaceable></arg>
|
---|
54 | <arg>--samples=<replaceable>количество</replaceable></arg>
|
---|
55 | <group>
|
---|
56 | <arg choice="plain">*</arg>
|
---|
57 | <arg choice="plain">host</arg>
|
---|
58 | <arg choice="plain"><replaceable>имя-ВМ</replaceable> <arg><replaceable>список-метрик</replaceable></arg></arg>
|
---|
59 | </group>
|
---|
60 | </cmdsynopsis>
|
---|
61 |
|
---|
62 | <cmdsynopsis id="synopsis-vboxmanage-metrics-disable">
|
---|
63 | <command>VBoxManage metrics disable</command>
|
---|
64 | <arg>--list</arg>
|
---|
65 | <group>
|
---|
66 | <arg choice="plain">*</arg>
|
---|
67 | <arg choice="plain">host</arg>
|
---|
68 | <arg choice="plain"><replaceable>имя-ВМ</replaceable> <arg><replaceable>список-метрик</replaceable></arg></arg>
|
---|
69 | </group>
|
---|
70 | </cmdsynopsis>
|
---|
71 |
|
---|
72 | <cmdsynopsis id="synopsis-vboxmanage-metrics-enable">
|
---|
73 | <command>VBoxManage metrics enable</command>
|
---|
74 | <arg>--list</arg>
|
---|
75 | <group>
|
---|
76 | <arg choice="plain">*</arg>
|
---|
77 | <arg choice="plain">host</arg>
|
---|
78 | <arg choice="plain"><replaceable>имя-ВМ</replaceable> <arg><replaceable>список-метрик</replaceable></arg></arg>
|
---|
79 | </group>
|
---|
80 | </cmdsynopsis>
|
---|
81 |
|
---|
82 | <cmdsynopsis id="synopsis-vboxmanage-metrics-list">
|
---|
83 | <command>VBoxManage metrics list</command>
|
---|
84 | <group>
|
---|
85 | <arg choice="plain">*</arg>
|
---|
86 | <arg choice="plain">host</arg>
|
---|
87 | <arg choice="plain"><replaceable>имя-ВМ</replaceable> <arg><replaceable>список-метрик</replaceable></arg></arg>
|
---|
88 | </group>
|
---|
89 | </cmdsynopsis>
|
---|
90 |
|
---|
91 | <cmdsynopsis id="synopsis-vboxmanage-metrics-query">
|
---|
92 | <command>VBoxManage metrics query</command>
|
---|
93 | <group>
|
---|
94 | <arg choice="plain">*</arg>
|
---|
95 | <arg choice="plain">host</arg>
|
---|
96 | <arg choice="plain"><replaceable>имя-ВМ</replaceable> <arg><replaceable>список-метрик</replaceable></arg></arg>
|
---|
97 | </group>
|
---|
98 | </cmdsynopsis>
|
---|
99 |
|
---|
100 | <cmdsynopsis id="synopsis-vboxmanage-metrics-setup">
|
---|
101 | <command>VBoxManage metrics setup</command>
|
---|
102 | <arg>--list</arg>
|
---|
103 | <arg>--period <replaceable>секунды</replaceable></arg>
|
---|
104 | <arg>--samples <replaceable>количество</replaceable></arg>
|
---|
105 | <group>
|
---|
106 | <arg choice="plain">*</arg>
|
---|
107 | <arg choice="plain">host</arg>
|
---|
108 | <arg choice="plain"><replaceable>имя-ВМ</replaceable> <arg><replaceable>список-метрик</replaceable></arg></arg>
|
---|
109 | </group>
|
---|
110 | </cmdsynopsis>
|
---|
111 | </refsynopsisdiv>
|
---|
112 |
|
---|
113 | <refsect1>
|
---|
114 | <title>Описание</title>
|
---|
115 | <para>
|
---|
116 | Команда <command>VBoxManage metrics</command> позволяет наблюдать
|
---|
117 | за использованием системных ресурсов в хост-системе и в
|
---|
118 | виртуальных машинах (ВМ). Например, можно контролировать
|
---|
119 | определенную метрику, такую как процент времени, затрачиваемую
|
---|
120 | ЦПУ при выполнении в пользовательском режиме
|
---|
121 | (<literal>CPU/Load/User</literal>) в течение определенного
|
---|
122 | периода.
|
---|
123 | </para>
|
---|
124 | <para>
|
---|
125 | Пока она работает, процесс <command>VBoxSVC</command> собирает
|
---|
126 | и сохраняет данные указанной метрики внутри. Процесс
|
---|
127 | <command>VBoxSVC</command> завершает работу почти сразу после
|
---|
128 | закрытия всех ВМ и интерфейсов пользователя. Используйте команду
|
---|
129 | <command>VBoxManage metrics query</command> для получения данных
|
---|
130 | в любое время.
|
---|
131 | </para>
|
---|
132 | <para>
|
---|
133 | По умолчанию, метрики не собираются, пока не будет запущена
|
---|
134 | команда <command>VBoxManage metrics setup</command>, в которой
|
---|
135 | указывается интервал выборки в секундах и количество сохраняемых
|
---|
136 | метрик.
|
---|
137 | </para>
|
---|
138 | <para>
|
---|
139 | Заметим, что включить сбор метрик можно только для запущенных ВМ.
|
---|
140 | Собранные данные и настройки сбора данных для ВМ удаляются при
|
---|
141 | выключении ВМ.
|
---|
142 | </para>
|
---|
143 | <refsect2>
|
---|
144 | <title>Метрики</title>
|
---|
145 | <para>
|
---|
146 | У хоста и ВМ есть разные наборы соответствующих метрик,
|
---|
147 | которые можно отобразить через команду <command>VBoxManage
|
---|
148 | metrics list</command>
|
---|
149 | </para>
|
---|
150 | <para>
|
---|
151 | Каждая метрика представлена строкой состоящей из категории и
|
---|
152 | метрики. Опционально, строка метрик может включать любое из
|
---|
153 | следующих: подметрика, под-подметрика и агрегат. Строка
|
---|
154 | метрик имеет следующий формат:
|
---|
155 | </para>
|
---|
156 | <screen><replaceable>категория</replaceable>/<replaceable>метрика</replaceable>[/<replaceable>подметрика</replaceable>[/<replaceable>под-подметрика</replaceable>]][:<replaceable>агрегат</replaceable>]</screen>
|
---|
157 | <itemizedlist>
|
---|
158 | <listitem><para>
|
---|
159 | <replaceable>категория</replaceable> - это тип ресурса,
|
---|
160 | такой как <literal>CPU</literal>, <literal>RAM</literal>,
|
---|
161 | <literal>FS</literal>, <literal>Net</literal>.
|
---|
162 | </para></listitem>
|
---|
163 | <listitem><para>
|
---|
164 | <replaceable>метрика</replaceable> - это тип измерения,
|
---|
165 | связанной с категорией ресурса. Например, метрики
|
---|
166 | <literal>Load</literal> и <literal>MHz</literal>
|
---|
167 | связаны с категорией ресурса <literal>CPU</literal>.
|
---|
168 | </para></listitem>
|
---|
169 | <listitem><para>
|
---|
170 | <replaceable>подметрика</replaceable> - это опциональный
|
---|
171 | тип измерения, связанный с метрикой. Например, подметрики
|
---|
172 | <literal>User</literal>, <literal>Kernel</literal> и
|
---|
173 | <literal>Idle</literal> связаны с метрикой
|
---|
174 | <literal>Load</literal>.
|
---|
175 | </para></listitem>
|
---|
176 | <listitem><para>
|
---|
177 | <replaceable>под-подметрика</replaceable> - это опциональный
|
---|
178 | тип измерения связанный с подметрикой. Например, под-подметрики
|
---|
179 | <literal>Rx</literal> и <literal>Tx</literal> связаны с
|
---|
180 | подметрикой <literal>Rate</literal> категории ресурса
|
---|
181 | <literal>Net</literal>. Связанная метрика - это сетевой
|
---|
182 | интерфейс.
|
---|
183 | </para></listitem>
|
---|
184 | <listitem><para>
|
---|
185 | <replaceable>агрегат</replaceable> - это опциональная
|
---|
186 | функция для передачи минимального, максимального и среднего
|
---|
187 | значения измерений категории ресурса. Например, метрика
|
---|
188 | <literal>RAM/Usage/Free:min</literal> представляет
|
---|
189 | минимальное количество доступной памяти найденное во всех
|
---|
190 | сохраненных данных в хост-системе.
|
---|
191 | </para></listitem>
|
---|
192 | </itemizedlist>
|
---|
193 | <para>
|
---|
194 | По умолчанию, команды <command>VBoxManage metrics</command>
|
---|
195 | оперируют хост-системой и всеми ВМ и возвращают все метрики.
|
---|
196 | Можно опционально ограничить эти команды работой только по
|
---|
197 | хост-системе или только по определенной ВМ и возвращать
|
---|
198 | список одной или нескольких метрик.
|
---|
199 | </para>
|
---|
200 | </refsect2>
|
---|
201 | <refsect2 id="vboxmanage-metrics-common-options">
|
---|
202 | <title>Общие параметры</title>
|
---|
203 | <variablelist>
|
---|
204 | <varlistentry>
|
---|
205 | <term><literal>*</literal> | <literal>host</literal> | <replaceable>имя-ВМ</replaceable></term>
|
---|
206 | <listitem><para>
|
---|
207 | Задает компонент для работы. По умолчанию, эта команда
|
---|
208 | работает по хост-системе и всем запущенным ВМ.
|
---|
209 | </para><para>
|
---|
210 | Если указать <literal>host</literal>, команда
|
---|
211 | <command>VBoxManage metrics</command> работает только по
|
---|
212 | хост-системе. Если указать звездочку (<literal>*</literal>),
|
---|
213 | команда работает по всем ВМ. Если указать имя ВМ, команда
|
---|
214 | <command>VBoxManage metrics</command> работает только
|
---|
215 | по этой ВМ.
|
---|
216 | </para></listitem>
|
---|
217 | </varlistentry>
|
---|
218 | <varlistentry>
|
---|
219 | <term><replaceable>список-метрик</replaceable></term>
|
---|
220 | <listitem><para>
|
---|
221 | Задает список одной или нескольких метрик, разделенный
|
---|
222 | запятыми.
|
---|
223 | </para><para>
|
---|
224 | Формат метрик должен включать <replaceable>категорию</replaceable>
|
---|
225 | и <replaceable>метрику</replaceable> в строке, разделенную
|
---|
226 | слэшем.
|
---|
227 | </para><para>
|
---|
228 | Заметим, что команды <command>VBoxManage metrics
|
---|
229 | enable</command> и <command>VBoxManage metrics
|
---|
230 | disable</command> требуют указания метрик как параметров.
|
---|
231 | Метрики должны включать только категорию ресурса и саму
|
---|
232 | метрику, например <literal>CPU/Load</literal> и
|
---|
233 | <literal>RAM/Usage</literal>.
|
---|
234 | </para></listitem>
|
---|
235 | </varlistentry>
|
---|
236 | </variablelist>
|
---|
237 | </refsect2>
|
---|
238 | <refsect2 id="vboxmanage-metrics-collect">
|
---|
239 | <title>Сбор данных метрик</title>
|
---|
240 | <remark role="help-copy-synopsis"/>
|
---|
241 | <para>
|
---|
242 | Команда <command>VBoxManage metrics collect</command>
|
---|
243 | собирает и выводит периодически данные, пока процесс не
|
---|
244 | будет остановлен нажатием Ctrl+C.
|
---|
245 | </para>
|
---|
246 | <variablelist>
|
---|
247 | <varlistentry>
|
---|
248 | <term><option>--detach</option></term>
|
---|
249 | <listitem><para>
|
---|
250 | Отключает сбор данных метрики, так что больше данных
|
---|
251 | не выводится. Использование этой опции равносильно
|
---|
252 | запуску команды <command>VBoxManage metrics setup</command>.
|
---|
253 | </para></listitem>
|
---|
254 | </varlistentry>
|
---|
255 | <varlistentry>
|
---|
256 | <term><option>--list</option></term>
|
---|
257 | <listitem><para>
|
---|
258 | Показывает какие метрики соответствуют указанному фильтру.
|
---|
259 | </para></listitem>
|
---|
260 | </varlistentry>
|
---|
261 | <varlistentry>
|
---|
262 | <term><option>--period=<replaceable>секунды</replaceable></option></term>
|
---|
263 | <listitem><para>
|
---|
264 | Задает количество секунд ожидания между выборками
|
---|
265 | данных метрик. По умолчанию 1.
|
---|
266 | </para></listitem>
|
---|
267 | </varlistentry>
|
---|
268 | <varlistentry>
|
---|
269 | <term><option>--samples=<replaceable>количество</replaceable></option></term>
|
---|
270 | <listitem><para>
|
---|
271 | Задает количество сохраняемых выборок данных метрик.
|
---|
272 | Для просмотра сохраненных данных используйте команду
|
---|
273 | <command>VBoxManage metrics query</command>. По
|
---|
274 | умолчанию 1.
|
---|
275 | </para></listitem>
|
---|
276 | </varlistentry>
|
---|
277 | </variablelist>
|
---|
278 | </refsect2>
|
---|
279 | <refsect2 id="vboxmanage-metrics-disable">
|
---|
280 | <title>Отключить сбор данных метрик</title>
|
---|
281 | <remark role="help-copy-synopsis"/>
|
---|
282 | <para>
|
---|
283 | Команда <command>VBoxManage metrics disable</command>
|
---|
284 | приостанавливает сбор данных. Эта команда не влияет ни на
|
---|
285 | свойства сбора данных, ни на сами собранные данные. Обратите
|
---|
286 | внимание, что указание подметрики в списке метрик не отключает
|
---|
287 | ее базовые метрики.
|
---|
288 | </para>
|
---|
289 | <para>
|
---|
290 | Заметим, что команда <command>VBoxManage metrics disable</command>
|
---|
291 | требует указания метрик как параметров. Метрики должны включать
|
---|
292 | только категорию ресурса и саму метрику, например
|
---|
293 | <literal>CPU/Load</literal> и <literal>RAM/Usage</literal>.
|
---|
294 | </para>
|
---|
295 | <variablelist>
|
---|
296 | <varlistentry>
|
---|
297 | <term><option>--list</option></term>
|
---|
298 | <listitem><para>
|
---|
299 | Показывает завершилась ли команда успешно как ожидалось.
|
---|
300 | </para></listitem>
|
---|
301 | </varlistentry>
|
---|
302 | </variablelist>
|
---|
303 | </refsect2>
|
---|
304 | <refsect2 id="vboxmanage-metrics-enable">
|
---|
305 | <title>Включение сбора данных метрики</title>
|
---|
306 | <remark role="help-copy-synopsis"/>
|
---|
307 | <para>
|
---|
308 | Команда <command>VBoxManage metrics enable</command> возобновляет
|
---|
309 | сбор данных после того, как он был приостановлен командой
|
---|
310 | <command>VBoxManage metrics disable</command>. Заметим, что
|
---|
311 | указание подметрики в списке метрик не включает его базовые
|
---|
312 | метрики.
|
---|
313 | </para>
|
---|
314 | <para>
|
---|
315 | В отличие от команды <command>VBoxManage metrics setup</command>
|
---|
316 | команда <command>VBoxManage metrics enable</command> не удаляет
|
---|
317 | предыдущие накопленные выборки для указанного набора объектов и
|
---|
318 | метрик.
|
---|
319 | </para>
|
---|
320 | <para>
|
---|
321 | Заметим, что команда <command>VBoxManage metrics enable</command>
|
---|
322 | требует указания метрик как параметров. Метрики должны включать
|
---|
323 | только категорию ресурса и саму метрику, например
|
---|
324 | <literal>CPU/Load</literal> и <literal>RAM/Usage</literal>.
|
---|
325 | </para>
|
---|
326 | <variablelist>
|
---|
327 | <varlistentry>
|
---|
328 | <term><option>--list</option></term>
|
---|
329 | <listitem><para>
|
---|
330 | Показывает, завершилась ли команда успешно как ожидалось.
|
---|
331 | </para></listitem>
|
---|
332 | </varlistentry>
|
---|
333 | </variablelist>
|
---|
334 | </refsect2>
|
---|
335 | <refsect2 id="vboxmanage-metrics-list">
|
---|
336 | <title>Показать значения метрик</title>
|
---|
337 | <remark role="help-copy-synopsis"/>
|
---|
338 | <para>
|
---|
339 | Команда <command>VBoxManage metrics list</command> показывает
|
---|
340 | доступные на текущий момент метрики. Обратите внимание, метрики,
|
---|
341 | относящиеся к ВМ, отображаются пока ВМ работает.
|
---|
342 | </para>
|
---|
343 | </refsect2>
|
---|
344 | <refsect2 id="vboxmanage-metrics-query">
|
---|
345 | <title>Показать сохраненные данные метрики</title>
|
---|
346 | <remark role="help-copy-synopsis"/>
|
---|
347 | <para>
|
---|
348 | Команда <command>VBoxManage metrics query</command>
|
---|
349 | получает и показывает сохраненные данные метрики.
|
---|
350 | </para>
|
---|
351 | <para>
|
---|
352 | Заметим, что команда <command>VBoxManage metrics query</command>
|
---|
353 | не удаляет и не сбрасывает сохраненные данные, но старые
|
---|
354 | выборки заменяются на новые в течение времени.
|
---|
355 | </para>
|
---|
356 | </refsect2>
|
---|
357 | <refsect2 id="vboxmanage-metrics-setup">
|
---|
358 | <title>Настройка свойств сбора метрик</title>
|
---|
359 | <remark role="help-copy-synopsis"/>
|
---|
360 | <para>
|
---|
361 | Команда <command>VBoxManage metrics setup</command> настраивает
|
---|
362 | свойства сбора метрик.
|
---|
363 | </para>
|
---|
364 | <para>
|
---|
365 | Заметим, что эта команда удаляет любые ранее собранные выборки
|
---|
366 | для указанного набора объектов и метрик. Для включения и отключения
|
---|
367 | сбора метрик без удаления данных используйте команды
|
---|
368 | <command>VBoxManage metrics enable</command> и
|
---|
369 | <command>VBoxManage metrics disable</command> соответственно.
|
---|
370 | </para>
|
---|
371 | <variablelist>
|
---|
372 | <varlistentry>
|
---|
373 | <term><option>--list</option></term>
|
---|
374 | <listitem><para>
|
---|
375 | Показывает какие метрики были изменены в качестве результата
|
---|
376 | выполнения команды.
|
---|
377 | </para></listitem>
|
---|
378 | </varlistentry>
|
---|
379 | <varlistentry>
|
---|
380 | <term><option>--period=<replaceable>секунды</replaceable></option></term>
|
---|
381 | <listitem><para>
|
---|
382 | Задает количество секунд ожидания между выборками данных метрик.
|
---|
383 | По умолчанию 1.
|
---|
384 | </para></listitem>
|
---|
385 | </varlistentry>
|
---|
386 | <varlistentry>
|
---|
387 | <term><option>--samples=<replaceable>количество</replaceable></option></term>
|
---|
388 | <listitem><para>
|
---|
389 | Задает количество сохраняемых выборок данных метрик.
|
---|
390 | Для просмотра сохраненных данных используйте команду
|
---|
391 | <command>VBoxManage metrics query</command>. По
|
---|
392 | умолчанию 1.
|
---|
393 | </para></listitem>
|
---|
394 | </varlistentry>
|
---|
395 | </variablelist>
|
---|
396 | </refsect2>
|
---|
397 | </refsect1>
|
---|
398 |
|
---|
399 | <refsect1>
|
---|
400 | <title>Примеры</title>
|
---|
401 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
402 | <para>
|
---|
403 | Следующая команда включает сбор метрик использования
|
---|
404 | процессора и памяти хоста каждую секунду. Опция
|
---|
405 | <option>--samples</option> сохраняет пять последних
|
---|
406 | выборок.
|
---|
407 | </para>
|
---|
408 | <screen>$ VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
|
---|
409 | <para>
|
---|
410 | Следующая команда показывает доступные метрики для хоста и ВМ:
|
---|
411 | </para>
|
---|
412 | <screen>$ VBoxManage metrics list</screen>
|
---|
413 | <para>
|
---|
414 | Заметим, что у хост-системы и ВМ разные наборы метрик.
|
---|
415 | </para>
|
---|
416 | <para>
|
---|
417 | Следующий пример показывает как запросить данные метрик о затраченном
|
---|
418 | времени ЦПУ в режимах пользователя и ядра для ВМ <literal>test</literal>:
|
---|
419 | </para>
|
---|
420 | <screen>$ VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
|
---|
421 | </refsect1>
|
---|
422 | </refentry>
|
---|