Параметры

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

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

Basic Auth Password

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

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

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

Basic Auth Username

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

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

Bird Socket Path

Путь к управляющему сокету службы BIRD.

Значение по умолчанию: /run/bird.ctl.

Bird Use Sudo

Выполнение утилиты birdc через sudo.

Значение по умолчанию: True (sudo используется).

Port

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

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

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

Scrape Interval

Периодичность опроса экспортера.

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

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

Рекомендуемое значение — от 15 до 30 секунд.

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:17056.

Имя объекта

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

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

  • Сервер.

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

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

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

--audit.fileMaxAge

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

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

--audit.fileMaxBackups

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

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

--audit.fileMaxSize

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

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

--audit.filePath

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

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

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

--bird.socket-path

Путь к управляющему сокету службы BIRD.

Значение по умолчанию: отсутствует (используется путь /run/bird.ctl).

--bird.use-sudo

Выполнение утилиты birdc через sudo.

Значение по умолчанию: true (sudo используется).

--common.scrape-timeout

Ограничение по времени на запрос метрик в секундах.

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

--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.

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

--logging.flags

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

Значение по умолчанию: false (вывод отключен).

--logging.flags-table

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

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

--logging.level

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

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

  • DEBUG;

  • INFO;

  • WARN;

  • ERROR;

  • CRITICAL.

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

--logging.output

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

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

  • file;

  • stdout;

  • stderr.

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

--version

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

Значение по умолчанию: false (выключен).

--web.config.file

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

Значение по умолчанию: отсутствует.

--web.listen-address

Адрес и порт, которые слушает компонент.

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

--web.routes-table

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

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

--web.shutdown-timeout

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

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

--web.telemetry-path

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

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