Параметры

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

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

Basic Auth Password

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

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

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

Basic Auth Username

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

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

Port

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

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

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

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.

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

Поддерживает несколько таргетов.

Адрес

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

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

Версия SNMP

SNMP v1 использует GETNEXT, v2 и v3 — GETBULK.

Допустимые значения:

  • 1;

  • 2;

  • 3.

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

Имя объекта

Допустимый тип объектов — Коммутатор.

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

Имя пользователя

Аналогичен ключу -u для NetSNMP. Требуется для SNMP v3.

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

Контекстное имя

Аналогичен ключу -n для NetSNMP. Требуется, если на устройстве настроен context.

Только SNMP v3.

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

Модуль SNMP-метрик

Модуль для сбора и преобразования метрик из определённых OID.

Допустимые значения:

  • Коммутаторы;

  • Tatlin.Unified v3.1.x.

Значение по умолчанию: Коммутаторы.

Пароль

Аналогичен ключу -A (authKey) для NetSNMP. Требуется, если уровень безопасности равен authNoPriv или authPriv.

Только SNMP v3.

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

Пароль шифрования

Аналогичен ключу -X (privKey) для NetSNMP. Требуется, если уровень безопасности (security_level) равен authPriv.

Только SNMP v3.

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

Протокол авторизации

Аналогичен ключу -a для NetSNMP. Требуется, если уровень безопасности (security_level) равен authNoPriv или authPriv.

Только SNMP v3.

Допустимые значения:

  • MD5;

  • SHA224;

  • SHA256;

  • SHA384;

  • SHA512.

  • SHA;

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

Протокол шифрования

Аналогичен ключу -x для NetSNMP. Требуется, если уровень безопасности (security_level) равен authPriv.

Только SNMP v3.

Допустимые значения:

  • AES192C;

  • AES192;

  • AES256C;

  • AES256;

  • AES;

  • DES.

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

Строка сообщества

Community String.

Только SNMP v1 и v2.

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

Уровень безопасности

Аналогичен ключу -l для NetSNMP. Требуется для SNMP v3.

Допустимые значения:

  • authNoPriv;

  • authPriv;

  • noAuthNoPriv.

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

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

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

--audit.fileMaxAge

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

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

--audit.fileMaxSize

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

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

--audit.filePath

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

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

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

--config.expand-environment-variables

Получение секретов из переменных окружения.

--config.file

Путь к файлу конфигурации экспортера.

--dry-run

Запуск в режиме проверки конфигурации.

--h, --help

Вывод справки.

--log.format

Формат сообщений в логах.

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

  • json;

  • logfmt.

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

--log.level

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

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

  • debug;

  • info;

  • warn;

  • error.

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

--no-config.expand-environment-variables

Отключение получения параметров из переменных окружения.

--no-dry-run

Отключение проверки конфигурации.

--no-help

Отключение вывода справки.

--no-snmp.debug-packets

Отключение отладки с полной трассировкой пакетов SNMP-трафика.

--no-snmp.wrap-large-counters

Отключение использования 64-битных счётчиков для обхода ошибок округления.

--no-version

Отключение вывода версии.

--no-web.systemd-socket

Отключение прослушивания сокета systemd вместо сетевого порта.

--snmp.debug-packets

Включение отладки с полной трассировкой пакетов SNMP-трафика.

--snmp.module-concurrecy

Количество одновременно выполняемых модулей скрепинга.

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

--snmp.source-address

Исходный адрес для отправки запросов в формате <address>:<port>. Если порт не указан или равен нулю, он будет выбран случайным образом.

--snmp.wrap-large-counters

Использование 64-битных счётчиков для обхода ошибок округления.

--version

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

--web.config.file

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

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

--web.listen-address

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

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

--web.systemd-socket

Прослушивание сокета systemd вместо сетевого порта.

--web.telemetry-path

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

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