Параметры

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

Параметры запуска экспортера и сбора метрик с него

Basic Auth Password

Пароль пользователя BasicAuth для доступа к экспортеру.

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

Basic Auth Username

Имя пользователя BasicAuth для доступа к экспортеру.

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

Port

Порт запуска экспортера.

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

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

Scrape Interval

Периодичность опроса экспортера, значение заполняется в секундах.

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

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

Scrape Timeout

Таймаут опроса таргетов.

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

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

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

Tls Cert File

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

Значение по умолчанию: /opt/skala-r/vision/cert/components_default.crt.

Tls Insecure Skip Verify

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

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

Tls Key File

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

Значение по умолчанию: /opt/skala-r/vision/cert/components_default.key.

Модуль для мониторинга vip-manager

Модуль собирает метрики vip-manager — информацию об активности службы Patroni.

Vip Manager Config Directory

Абсолютный путь к директории с конфигурационными файлами vip-manager.

Значение по умолчанию: /etc/vip-manager.

Модуль для мониторинга конфигурации компонентов Спектр S3

Модуль контролирует идентичность конфигурационных файлов в формате JSON между узлами кластера. Модуль экспортирует метрику json_config_hash; при расхождении её значений между узлами срабатывает правило оповещения ConfigHashCountIsGreaterThanOne.

Исключаемые поля

Список полей, исключаемых из вычисления хеша. Для вложенных полей поддерживается точечная нотация: cluster.password.

Укажите в списке:

секреты (пароли, приватные ключи, парольные фразы) — они не должны попадать в подсистему мониторинга;
поля, значения которых закономерно различаются на узлах (например, IP-адреса или списки резервных серверов), — иначе правило оповещения будет срабатывать постоянно.

Поля, не указанные в списке, включаются в хеш — изменение любого из них на одном из узлов вызывает срабатывание правила оповещения.

Если исключаемое поле отсутствует в конфигурации, хеш вычисляется без него, ошибка не генерируется.

Название конфигурации

Уникальное название конфигурации. Используется как значение метки config_name в метрике.

Пример: s3gateway.

Путь к файлу конфигурации

Абсолютный путь к файлу конфигурации в формате JSON на узле, где установлен плагин.

Пример: /opt/skala-r/s3gateway/s3gateway.config.json.

Для контроля конфигурации шлюза S3 ПАК МХД.О укажите следующие значения:

Исключаемые поля:
- cluster.s3_cluster_ip_address;
- cluster.s3_cluster_password;
- cluster.storage_cluster_password;
- db_connection;
- iam_settings.client_secret;
- passphrase;
- report.connection;
- report.mgment_net;
- report.reserve_servers;
Название конфигурации: s3gateway;
Путь к файлу конфигурации: /opt/skala-r/s3gateway/s3gateway.config.json.

Модуль доступности образов Docker в системе

Модуль проверяет наличие в системе образов Docker. Модуль используется в ПАК МДИ.О (МВ.ДИ).

Список образов, доступность которых проверяет модуль

gcr.io/google_containers/k8s-dns-dnsmasq-nanny-amd64;
gcr.io/google_containers/k8s-dns-kube-dns-amd64;
gcr.io/google_containers/k8s-dns-sidecar-amd64;
gcr.io/google_containers/kube-apiserver-amd64;
gcr.io/google_containers/kube-controller-manager-amd64;
gcr.io/google_containers/kube-proxy-amd64;
gcr.io/google_containers/kube-scheduler-amd64;
gcr.io/google_containers/pause-amd64;
quay.io/coreos/flannel;
registry-1:5000/3rdparty/filebeat;
registry-1:5000/3rdparty/grafana;
registry-1:5000/3rdparty/influxdb;
registry-1:5000/3rdparty/kube-keepalived-vip;
registry-1:5000/3rdparty/mongo-k8s-sidecar;
registry-1:5000/3rdparty/mongo;
registry-1:5000/3rdparty/prometheus;
registry-1:5000/3rdparty/redis;
registry-1:5000/3rdparty/registry;
registry-1:5000/3rdparty/syncthing;
registry-1:5000/de/apt-local;
registry-1:5000/de/audit-collector;
registry-1:5000/de/audit-init;
registry-1:5000/de/backup-creator;
registry-1:5000/de/cloudbroker;
registry-1:5000/de/decs3o-init;
registry-1:5000/de/decs3o;
registry-1:5000/de/grafana-init;
registry-1:5000/de/management;
registry-1:5000/de/metrics-server;
registry-1:5000/de/nginx-init;
registry-1:5000/de/nginx;
registry-1:5000/de/ntpserver;
registry-1:5000/de/prometheus-init;
registry-1:5000/de/pxeboot-base;
registry-1:5000/de/pxeboot-httpd;
registry-1:5000/de/pxeboot-init;
registry-1:5000/de/pxeboot;
registry-1:5000/de/slightcar;
registry-1:5000/de/subscriber;
registry-1:5000/de/syncthing_sidecar;
registry-1:5000/de/zero-access.

Docker Polling Interval

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

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

Модуль сбора информации о дате окончания действия сертификатов

Модуль проверяет сроки действия TLS-сертификатов для указанных серверов. Модуль используется в ПАК МДИ.О (МВ.ДИ) и МХД.О.

Servers

Список серверов для мониторинга срока действия TLS-сертификатов.

Значение параметра указывайте в формате host[:port], где:

host — имя хоста.

Может содержать буквы латинского алфавита, цифры, точки . и дефисы -.
port — необязательный номер порта.

Номер порта может принимать значения в диапазоне от 1 до 65535 включительно. Если номер порта не указан, по умолчанию используется порт 443.

Модуль сбора количества активных SSH сессий

Модуль подсчитывает активные пользовательские сессии. Модуль используется в ПАК МХД.О.

Модуль сбора метрик Basis Dynamix API

Модуль собирает метрики Basis Dynamix. Модуль используется в ПАК МДИ.О (МВ.ДИ).

Dynamix API Host

IP-адрес или доменное имя узла, предоставляющего доступ к Basis Dynamix API.

Значение параметра указывайте в формате host[:port], где:

host — имя хоста.

Может содержать буквы латинского алфавита, цифры, точки . и дефисы -.
port — необязательный номер порта.

Номер порта может принимать значения в диапазоне от 1 до 65535 включительно.

Dynamix Client ID

Идентификатор клиента, используемый для доступа к Basis Dynamix API.

Значение по умолчанию: 123*АМС.

Dynamix Client Secret

Секрет клиента, используемый для доступа к Basis Dynamix API.

Для каждого экземпляра экспортера используйте уникальный секрет клиента.

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

Dynamix Collect Period

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

Dynamix SSO Host

IP-адрес или доменное имя узла, предоставляющего SSO для Basis Dynamix.

Значение параметра указывайте в формате host[:port], где:

host — имя хоста.

Может содержать буквы латинского алфавита, цифры, точки . и дефисы -.
port — необязательный номер порта.

Номер порта может принимать значения в диапазоне от 1 до 65535 включительно.

Dynamix Timeout

Период ожидания запросов к Basis Dynamix API, в секундах.

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

Модуль сбора метрик ERA

Сбор метрик ERARAID с помощью утилиты eracli. Модуль используется в ПАК МБД.П и МХД.О.

Модуль сбора метрик Greenplum

Модуль сбора метрик кластера Greenplum. Модуль используется в ПАК МБД.Г.

Модуль сбора метрик RAIDIX

Модуль собирает информацию о следующих параметрах RAIDIX:

сети;
диски;
RAID;
LUN;
NAS;
Sparepool.

Для сбора информации используется утилита rdcli.

Модуль используется в ПАК МБД.П.

Модуль сбора метрик сервисов systemd

Модуль сбора метрик служб, управляемых с помощью systemd. Модуль используется в ПАК МХД.О.

Module Services

Настройки сбора метрик служб. Значение укажите в формате YAML следующего вида:

---
services:
  <1>:
    monitor_config_file: (2)
    monitor_port: (3)
    monitor_service: (4)
    monitor_specific_config: (5)

Здесь:

<1> — название службы без суффикса .service, обязательный параметр.
<2> — путь к конфигурационному файлу службы.
<3> — номер сетевого порта, используемого службой.
<4> — мониторинг активности и времени работы службы, обязательный параметр.
Возможные значения:
- true — включен;
- false — выключен.
<5> — название службы systemd, на основе которого модуль должен автоматически определить пути к необходимым конфигурационным файлам для их мониторинга.

Для ПАК МХД.О рекомендуется следующая конфигурация:

Узел балансировки:

---
services:
  firewalld:
    monitor_service: false
    monitor_specific_config: firewalld

  nginx.service:
    monitor_service: true
    monitor_port: 6006

  haproxy.service:
    monitor_service: true
    monitor_port: 80

  postgresql.service:
    monitor_service: true
    monitor_port: 5432

  s3gateway-compression-server.service:
    monitor_service: true
    monitor_port: 5001

  s3gateway-control-server.service:
    monitor_service: true
    monitor_port: 3000

  s3gateway-proxy-server.service:
    monitor_service: true
    monitor_port: 4000

Узлы хранения:

services:
  nginx.service:
    monitor_service: true
    monitor_port: 80

  s3gateway-ostor-server.service:
    monitor_service: true
    monitor_port: 5002

  vstorage-csd.target:
    monitor_service: true

  vstorage-mdsd.target:
    monitor_service: true

  ostor-cfgd.service:
    monitor_service: true

  ostor-agentd.service:
    monitor_service: true

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

Модуль сбора метрик статуса бондов и интерфейсов

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

Для сбора метрик используется утилита ovs-appctl.

Модуль используется в ПАК МДИ.О (МВ.ДИ).

Модуль сбора размера директорий

Модуль сбора информации о размере указанных директорий. Для получения размера используется утилита du. Модуль используется в ПАК МДИ.О (МВ.ДИ).

Directories

Список директорий, по одной записи в каждой строке.

Пути к директориям должны быть абсолютными.

Значение по умолчанию: /var/log/containers.

Directories Scan Period

Периодичность проверки размера директорий.

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

Слишком короткий период между проверками может привести к значительному снижению быстродействия системы.

Модуль сбора состояния файлов логов

Модуль сбора информации о состоянии файлов логов Basis Dynamix Enterprise и Basis Virtual Security. Модуль используется в ПАК МДИ.О (МВ.ДИ).

Logstat Paths

Список путей к директориям для мониторинга Logstat, по одной записи в каждой строке.

Пути к директориям должны быть абсолютными.

Значение по умолчанию: /var/log/containers.

Если это поле заполнено, значение настройки Lostat Server Type игнорируется.

Logstat Server Type

Список типов серверов Logstat.

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

BVS - Basis Virtual Security (надстройка над DX для ИБ)
Выбор этого значения активирует сбор информации о следующих логах:
- /var/decort/audit;
- /var/log/containers;
- /var/log/decort/vms;
- /var/log/decs3o.log;
- /var/log/haproxy.log;
- /var/log/pods;
- /var/log/redis.
DX - Basis Dynamix Enterprise — выбор этого значения активирует сбор информации о логах в директории /var/log/bvs/.

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

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

Адрес

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

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

Имя объекта

Название объекта в объектной модели. Используется для назначения меток объектной модели временным рядам.

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

Виртуальная машина.
Сервер.

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

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

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

--audit.fileMaxAge

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

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

--audit.fileMaxBackups

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

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

--audit.fileMaxSize

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

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

--audit.filePath

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

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

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

--common.config-folder

Путь к директории с конфигурационными файлами используемых модулей.

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

--common.scrape-timeout

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

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

--common.timeout

Внутренний период ожидания выполнения операций.

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

--component.shutdown-timeout

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

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

--logging.fileMaxAge

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

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

--logging.fileMaxBackups

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

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

--logging.fileMaxSize

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

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

--logging.filePath

Путь к файлу для логирования.

Используется только при --logging.output=file.

--logging.flags

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

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

--logging.flags-table

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

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

--logging.level

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

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

DEBUG;
INFO;
WARN;
ERROR;
CRITICAL.

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

--logging.output

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

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

file;
stdout;
stderr.

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

--module.bond.enable

Включение модуля bond.

--module.certificate.enable

Включение модуля certificate.

--module.directories.collect-period

Периодичность сбора метрик модуля directories, в секундах.

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

--module.directories.enable

Включение модуля directories.

--module.docker_images_availability.collect-period

Периодичность сбора метрик модуля docker_images_availability, в секундах.

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

--module.docker_images_availability.enable

Включение модуля docker_images_availability.

--module.dynamix.collect-period

Периодичность сбора метрик Dynamix, в секундах.

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

--module.dynamix.enable

Включение модуля dynamix.

--module.dynamix.timeout

Период ожидания запросов к Basis Dynamix API, в секундах.

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

--module.eraraid.enable

Включение модуля eraraid.

--module.greenplum.egrep_pattern_errors_fatal

Шаблон поиска событий FATAL и ERROR в логах для метрики greenplum_pg_log_errors_fatal. Передаётся команде grep с флагами -iE.

Значение по умолчанию: (FATAL|ERROR).

--module.greenplum.egrep_pattern_reset_panic

Шаблон поиска событий PANIC и RESET в логах для метрик greenplum_pg_log_reset_panic и greenplum_pg_log_reset_panic_for_hour_count. Передаётся команде grep с флагами -iE.

Значение по умолчанию: (PANIC|RESET) с пробелом в начале и в конце шаблона — пробелы используются намеренно.

--module.greenplum.enable

Включение модуля greenplum.

--module.logstat.enable

Включение модуля logstat.

--module.raidix.enable

Включение модуля raidix.

--module.raidix.use-sudo

Использование sudo для вызова утилиты rdcli.

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

--module.s3_config_identity.config_name

Уникальное название конфигурации, используется как значение метки config_name в метрике.

--module.s3_config_identity.config_path

Абсолютный путь к файлу конфигурации в формате JSON.

--module.s3_config_identity.enable

Включение модуля s3_config_identity.

--module.s3_config_identity.exclude_fields

Список полей, исключаемых из вычисления хеша.

--module.services.enable

Включение модуля services.

--module.session.enable

Включение модуля session.

--module.vip_manager.enable

Включение модуля vip_manager.

--module.vip_manager.vip_manager_config_directory

Путь к директории с файлами vip-manager-*.yml.

Значение по умолчанию: /etc/vip-manager.

--version

Вывод версии компонента.

--web.config.file

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

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

--web.listen-address

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

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

--web.routes-table

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

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

--web.shutdown-timeout

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

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

--web.telemetry-path

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

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