Параметры

Описание параметров плагина vision_utilizer.

Параметры сбора метрик

Basic Auth Password

Пароль пользователя Basic Auth для доступа к плагину.

Только запись.

Значение по умолчанию: skala-r.

Basic Auth Username

Имя пользователя Basic Auth для доступа к плагину.

Значение по умолчанию: vision.

Config

Настройки сбора метрик. Значением этого поля указывайте в следующем виде:

queries:
  cpu_cores: "<cpu_cores_query>"
  cpu_usage: "<cpu_usage_query>"
  ram_total: "<ram_total_query>"
  ram_used:  "<ram_used_query>"
  rom_total: "<rom_total_query>"
  rom_used:  "<rom_used_query>"
objects: []

В блоке queries укажите запросы MetricsQL для получения соответствующих метрик:

Поле Метрика Описание

cpu_cores

utlz_cpu_cores

Количество ядер CPU

cpu_usage

utlz_cpu_usage

Степень утилизации ресурсов CPU

ram_total

utlz_ram_total

Объём оперативной памяти, установленной на узле

ram_used

utlz_ram_used

Объём используемой оперативной памяти

rom_total

utlz_rom_total

Объём хранилища

rom_used

utlz_rom_total

Используемый объём хранилища

В блоке objects при необходимости укажите дополнительные параметры сбора и расчёта метрик. При значении [] значения всех перечисленных метрик собираются без изменений.

В блоке objects при необходимости задайте правила обработки значений рассчитанных метрик:

---
#...
objects:
  - node_id: (1)
    cpu:
      cores: (2)
      used:  (3)
    ram:
      total: (4)
      used:  (5)
    rom:
      - type: (6)
        mountpoints: (7)
        total: (8)
        used: (9)

Здесь:

1 Название узла в объектной модели.
2 Настройки сбора метрики utlz_cpu_cores.
3 Настройки сбора метрики utlz_cpu_usage.
4 Настройки сбора метрики utlz_ram_total.
5 Настройки сбора метрики utlz_ram_used.
6 Фильтрация по типу накопителя.
7 Список точек монтирования.
8 Настройки сбора метрики utlz_disk_total.
9 Настройки сбора метрики utlz_disk_used.

Каждая настройка сбора метрики задаётся в виде структуры со следующими полями:

  • add — указанное значение прибавляется к значению метрики.

  • enable — сбор метрики.

    Это поле обязательно для заполнения.

  • factor — множитель значения метрики;

  • set — указанное значение используется вместо рассчитанного значения метрики.

Пусть необходимо собирать для узла MBDP-01-NODE-02 следующие метрики:

  • степень утилизации CPU в процентах;

  • объёмы установленной и используемой оперативной памяти;

  • степень заполнения разделов /var/data/postgresql и /var/log на накопителях SSD.

В этом случае настройки сбора метрик нужно заполнить следующим образом:

---
queries:
  cpu_usage: 'avg without (mode,cpu) (1 - rate(node_cpu_seconds_total{mode="idle"}[15s])) * 100'
  cpu_cores: 'count without(cpu, mode) (node_cpu_seconds_total{mode="idle"})'
  ram_total: "node_memory_MemTotal_bytes"
  ram_used: "node_memory_MemTotal_bytes - node_memory_MemAvailable_bytes"
  rom_total: "node_filesystem_size_bytes"
  rom_used: "node_filesystem_size_bytes - node_filesystem_free_bytes"
objects:
  - node_id: MBDP-01-NODE-02  # Название узла
    cpu:
      cores:
        enable: false  # Сбор количества ядер CPU выключен
      used:
        enable: true  # Сбор утилизации ресурсов CPU включен
    ram:
      total:
        enable: true  # Сбор метрики установленного объёма RAM включен
      used:
        enable: true  # Сбор метрики используемого объёма RAM включен
    rom:
      - type: "ssd"  # Тип дисков — SSD
        mountpoints:  # Точки монтирования
          - /var/data/postgresql
          - /var/log

        total:
          enable: true  # Сбор объёма хранилища включен
        used:
          enable: true  # Сбор используемого объёма хранилища включен

Значения для поля objects можно сформировать в полуавтоматическом режиме:

  1. Установите плагины vision_utilizer и node_exporter на нужные узлы.

  2. Сформируйте инвентарь Ansible, следуя инструкции.

  3. Подключитесь к узлу управления подсистемой мониторинга.

  4. Перейдите в директорию /opt/skala-r/vision/server/inventory/:

    cd /opt/skala-r/vision/server/inventory/

  5. Из нужного файла инвентаря удалите узлы, для которых не нужно рассчитывать метрики утилизации.

  6. Перейдите в директорию utilizer/ в директории с файлами дистрибутива подсистемы мониторинга:

    cd vision-distrib-1.12.1-1402/utilizer/

  7. Выполните команду:

    bash ./config_utilizer.sh /path/to/inventory.yml

    Она создаст в каталоге utilizer/ файл utilizer_<название_инвентаря>.yml, в который выведет список дисковых устройств.

  8. Проверьте содержимое сгенерированного файла на наличие ошибок и при необходимости добавьте недостающие значения.

Port

Порт запуска плагина.

Допустимые значения: от 1 до 65535 включительно.

Значение по умолчанию: 17099.

Route Prefix

URL-префикс, добавляемый ко всем путям, которые обрабатывает HTTP-сервер плагина.

Scheme

Схема доступа к сервису.

Возможные значения:

  • http;

  • https.

Значение по умолчанию: http.

Scrape Interval

Периодичность опроса плагина.

Период времени.

Значение по умолчанию: 1m (1 минута).

Scrape Timeout

Периодичность опроса таргетов.

Значение не должно превышать значение параметра Scrape Interval.

Период времени.

Значение по умолчанию: 2m (2 минуты).

TLS CA File

Путь к файлу сертификата на узле, где установлен плагин. Используется для проверки сертификата сервера при установке TLS-соединения.

Значение по умолчанию: '' (пустая строка).

TLS Cert File

Путь к файлу клиентского сертификата на узле, где установлен плагин. Используется для прохождения клиентской аутентификации на сервере (mTLS).

Значение по умолчанию: '' (пустая строка).

TLS Insecure Skip Verify

Пропуск проверки сертификата сервера (CA и имени хоста).

Значение по умолчанию: False (проверка сертификата включена).

TLS Key File

Путь к файлу приватного ключа на узле, где установлен плагин. Используется для прохождения клиентской аутентификации на сервере (mTLS).

Значение по умолчанию: '' (пустая строка).

Параметры таргетов

Ограничение в один таргет.

Адрес

Адрес и порт узла, которому принадлежит таргет.

Значение по умолчанию: 127.0.0.1:17099.

Имя объекта

Допустимые типы объектов:

  • Виртуальная машина.

  • Сервер.

Значение по умолчанию: имя объекта.

Параметры запуска

Параметры, с которыми может быть запущен vision_utilizer.

--audit.fileMaxAge

Продолжительность хранения файлов аудита в днях.

Значение по умолчанию: 7.

--audit.fileMaxBackups

Максимальное количество ротированных файлов аудита.

Значение по умолчанию: 5.

--audit.fileMaxSize

Максимальный размер одного файла аудита в МБ.

Значение по умолчанию: 100.

--audit.filePath

Путь к файлу для сохранения журнала аудита.

Пустое значение отключает аудит.

Значение по умолчанию: /opt/skala-r/var/log/vision/audit/agent/vision_utilizer/audit.log.

--common.scrape-timeout

Длительность в секундах периода ожидания при запросе метрик.

Значение по умолчанию: 10.

--component.shutdown-timeout

Период ожидания при плавном завершении работы компонента.

Значение по умолчанию: 15s (15 секунд).

--config.file

Путь к конфигурационному файлу с настройками извлечения метрик.

Значение по умолчанию: config.yml.

--logging.fileMaxAge

Максимальное число дней логирования в одном файле. Используется при --logging.output=file.

Значение по умолчанию: 31.

--logging.fileMaxBackups

Максимальное количество ротированных файлов логов. Используется при --logging.output=file.

Значение по умолчанию: 5.

--logging.fileMaxSize

Максимальный размер одного файла логирования в мегабайтах. Используется при --logging.output=file.

Значение по умолчанию: 100.

--logging.filePath

Путь к файлу записи логов. Используется при --logging.output=file.

Значение по умолчанию: /opt/skala-r/var/log/vision/agent/vision_utilizer/vision_utilizer.log.

--logging.flags

Вывод установленных флагов при запуске.

Значение по умолчанию: false.

--logging.flags-table

Вывод флагов компонента в виде таблицы.

Значение по умолчанию: false.

--logging.level

Уровень логирования.

Возможные значения в порядке уменьшения подробности вывода:

  • DEBUG;

  • INFO;

  • WARN;

  • ERROR;

  • CRITICAL.

Значение по умолчанию: INFO.

--logging.output

Место логирования.

Возможные значения:

  • file;

  • stdout;

  • stderr.

Значение по умолчанию: file.

--version

Вывод версии плагина.

--victoria.endpoint

Точка подключения к VictoriaMetrics.

Значение по умолчанию: 127.0.0.1:8428.

--victoria.password

Пароль пользователя для аутентификации Basic Auth в VictoriaMetrics.

Значение шифруется средствами подсистемы мониторинга.
--victoria.username

Имя пользователя для аутентификации Basic Auth в VictoriaMetrics.

Значение по умолчанию: vision.

--victoria.verify

Проверка сертификатов при подключении к VictoriaMetrics.

Значение по умолчанию: false.

--web.config.file

Путь к файлу веб-конфигурации компонента.

Значение по умолчанию: /opt/skala-r/etc/vision/agent/vision_utilizer/web.yml.

--web.listen-address

Адрес для прослушивания входящих HTTP-запросов.

Значение по умолчанию: localhost:17099.

--web.routes-table

Вывод маршрутов в виде таблицы.

Значение по умолчанию: false.

--web.shutdown-timeout

Период ожидания при плавном завершении работы HTTP-сервера.

Значение по умолчанию: 15s (15 секунд).

--web.telemetry-path

Путь для выдачи метрик.

Значение по умолчанию: /metrics.