# VBoxManage metrics

VBoxManage-metrics

1

VBoxManage-metrics

мониторинг использования системных ресурсов

&product-name;

          VBoxManage metrics collect
          --detach
          --list
          --period=секунды
          --samples=количество

            *
            host
            имя-ВМ список-метрик

          VBoxManage metrics disable
          --list

            *
            host
            имя-ВМ список-метрик

          VBoxManage metrics enable
          --list

            *
            host
            имя-ВМ список-метрик

          VBoxManage metrics list

            *
            host
            имя-ВМ список-метрик

          VBoxManage metrics query

            *
            host
            имя-ВМ список-метрик

          VBoxManage metrics setup
          --list
          --period секунды
          --samples количество

            *
            host
            имя-ВМ список-метрик

## Описание

Команда `VBoxManage metrics` позволяет наблюдать за использованием системных ресурсов в хост-системе и в виртуальных машинах (ВМ). Например, можно контролировать определенную метрику, такую как процент времени, затрачиваемую ЦПУ при выполнении в пользовательском режиме (`CPU/Load/User`) в течение определенного периода.

Пока она работает, процесс `VBoxSVC` собирает и сохраняет данные указанной метрики внутри. Процесс `VBoxSVC` завершает работу почти сразу после закрытия всех ВМ и интерфейсов пользователя. Используйте команду `VBoxManage metrics query` для получения данных в любое время.

По умолчанию, метрики не собираются, пока не будет запущена команда `VBoxManage metrics setup`, в которой указывается интервал выборки в секундах и количество сохраняемых метрик.

Заметим, что включить сбор метрик можно только для запущенных ВМ. Собранные данные и настройки сбора данных для ВМ удаляются при выключении ВМ.

### Метрики

У хоста и ВМ есть разные наборы соответствующих метрик, которые можно отобразить через команду `VBoxManage metrics list`

Каждая метрика представлена строкой состоящей из категории и метрики. Опционально, строка метрик может включать любое из следующих: подметрика, под-подметрика и агрегат. Строка метрик имеет следующий формат:

    категория/метрика[/подметрика[/под-подметрика]][:агрегат]

- `категория` - это тип ресурса, такой как `CPU`, `RAM`, `FS`, `Net`.

- `метрика` - это тип измерения, связанной с категорией ресурса. Например, метрики `Load` и `MHz` связаны с категорией ресурса `CPU`.

- `подметрика` - это опциональный тип измерения, связанный с метрикой. Например, подметрики `User`, `Kernel` и `Idle` связаны с метрикой `Load`.

- `под-подметрика` - это опциональный тип измерения связанный с подметрикой. Например, под-подметрики `Rx` и `Tx` связаны с подметрикой `Rate` категории ресурса `Net`. Связанная метрика - это сетевой интерфейс.

- `агрегат` - это опциональная функция для передачи минимального, максимального и среднего значения измерений категории ресурса. Например, метрика `RAM/Usage/Free:min` представляет минимальное количество доступной памяти найденное во всех сохраненных данных в хост-системе.

По умолчанию, команды `VBoxManage metrics` оперируют хост-системой и всеми ВМ и возвращают все метрики. Можно опционально ограничить эти команды работой только по хост-системе или только по определенной ВМ и возвращать список одной или нескольких метрик.

### Общие параметры

`*` | `host` | `имя-ВМ`

- Задает компонент для работы. По умолчанию, эта команда работает по хост-системе и всем запущенным ВМ.

  Если указать `host`, команда `VBoxManage metrics` работает только по хост-системе. Если указать звездочку (`*`), команда работает по всем ВМ. Если указать имя ВМ, команда `VBoxManage metrics` работает только по этой ВМ.

`список-метрик`

- Задает список одной или нескольких метрик, разделенный запятыми.

  Формат метрик должен включать `категорию` и `метрику` в строке, разделенную слэшем.

  Заметим, что команды `VBoxManage metrics enable` и `VBoxManage metrics disable` требуют указания метрик как параметров. Метрики должны включать только категорию ресурса и саму метрику, например `CPU/Load` и `RAM/Usage`.

### Сбор данных метрик

Команда `VBoxManage metrics collect` собирает и выводит периодически данные, пока процесс не будет остановлен нажатием Ctrl+C.

`--detach`

- Отключает сбор данных метрики, так что больше данных не выводится. Использование этой опции равносильно запуску команды `VBoxManage metrics setup`.

`--list`

- Показывает какие метрики соответствуют указанному фильтру.

`--period=`секунды``

- Задает количество секунд ожидания между выборками данных метрик. По умолчанию 1.

`--samples=`количество``

- Задает количество сохраняемых выборок данных метрик. Для просмотра сохраненных данных используйте команду `VBoxManage metrics query`. По умолчанию 1.

### Отключить сбор данных метрик

Команда `VBoxManage metrics disable` приостанавливает сбор данных. Эта команда не влияет ни на свойства сбора данных, ни на сами собранные данные. Обратите внимание, что указание подметрики в списке метрик не отключает ее базовые метрики.

Заметим, что команда `VBoxManage metrics disable` требует указания метрик как параметров. Метрики должны включать только категорию ресурса и саму метрику, например `CPU/Load` и `RAM/Usage`.

`--list`

- Показывает завершилась ли команда успешно как ожидалось.

### Включение сбора данных метрики

Команда `VBoxManage metrics enable` возобновляет сбор данных после того, как он был приостановлен командой `VBoxManage metrics disable`. Заметим, что указание подметрики в списке метрик не включает его базовые метрики.

В отличие от команды `VBoxManage metrics setup` команда `VBoxManage metrics enable` не удаляет предыдущие накопленные выборки для указанного набора объектов и метрик.

Заметим, что команда `VBoxManage metrics enable` требует указания метрик как параметров. Метрики должны включать только категорию ресурса и саму метрику, например `CPU/Load` и `RAM/Usage`.

`--list`

- Показывает, завершилась ли команда успешно как ожидалось.

### Показать значения метрик

Команда `VBoxManage metrics list` показывает доступные на текущий момент метрики. Обратите внимание, метрики, относящиеся к ВМ, отображаются пока ВМ работает.

### Показать сохраненные данные метрики

Команда `VBoxManage metrics query` получает и показывает сохраненные данные метрики.

Заметим, что команда `VBoxManage metrics query` не удаляет и не сбрасывает сохраненные данные, но старые выборки заменяются на новые в течение времени.

### Настройка свойств сбора метрик

Команда `VBoxManage metrics setup` настраивает свойства сбора метрик.

Заметим, что эта команда удаляет любые ранее собранные выборки для указанного набора объектов и метрик. Для включения и отключения сбора метрик без удаления данных используйте команды `VBoxManage metrics enable` и `VBoxManage metrics disable` соответственно.

`--list`

- Показывает какие метрики были изменены в качестве результата выполнения команды.

`--period=`секунды``

- Задает количество секунд ожидания между выборками данных метрик. По умолчанию 1.

`--samples=`количество``

- Задает количество сохраняемых выборок данных метрик. Для просмотра сохраненных данных используйте команду `VBoxManage metrics query`. По умолчанию 1.

## Примеры

Следующая команда включает сбор метрик использования процессора и памяти хоста каждую секунду. Опция `--samples` сохраняет пять последних выборок.

    $ VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage

Следующая команда показывает доступные метрики для хоста и ВМ:

    $ VBoxManage metrics list

Заметим, что у хост-системы и ВМ разные наборы метрик.

Следующий пример показывает как запросить данные метрик о затраченном времени ЦПУ в режимах пользователя и ядра для ВМ `test`:

    $ VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel