Документация: ПО Факел — разрабатываемая версия

Мониторинг¶

Обзор¶

ПО Факел передает сведения о работе маршрутизатора во внешние системы мониторинга. В разделе service monitoring настраиваются два независимых механизма:

агент сбора метрик (telegraf) — собирает метрики маршрутизатора и отправляет их во внешние хранилища или предоставляет их для опроса по протоколу Prometheus;
агент Zabbix (zabbix-agent) — отвечает на запросы сервера Zabbix и выполняет активные проверки.

Агент сбора метрик¶

Команда telegraf source выбирает группы собираемых параметров: использование оборудования (процессор, диски, память), сетевые параметры, системные параметры (система, процессы, прерывания), журналы и внутреннюю статистику агента. По умолчанию собираются все группы (all).

Метрики передаются в одно или несколько хранилищ. Для каждого хранилища задаются его адрес и параметры аутентификации:

InfluxDB версии 2 (influxdb) — URL, порт (по умолчанию 8086), корзина (bucket), организация и токен. URL, организация и токен обязательны;
Azure Data Explorer (azure-data-explorer) — URL, база данных, идентификаторы приложения и клиента, секрет приложения и способ группировки метрик по таблицам. URL, база данных и все три параметра аутентификации обязательны; в режиме одной таблицы (group-metrics single-table) обязательно и имя таблицы;
Splunk (splunk) — URL и токен авторизации; оба параметра обязательны. Метрики отправляются по указанному URL без изменений, поэтому URL должен содержать полный путь приема данных (например, http://<адрес>:8088/services/collector);
Loki (loki) — URL (обязателен), порт (по умолчанию 3100), метка имени метрики и, при необходимости, имя пользователя и пароль, которые задаются вместе. Метрики передаются в Loki как записи журнала, а метка имени метрики содержит имя группы метрик.

Агент отправляет метрики в хранилища каждые 15 секунд.

Если обязательный параметр хранилища не задан, проверка конфигурации завершается ошибкой, например Monitoring loki "url" is mandatory! или Authentication "username" and "password" are mandatory!.

Раздел prometheus-client включает на маршрутизаторе сервер, который система Prometheus опрашивает сама: задаются адрес и порт (по умолчанию 9273), сети, из которых разрешены запросы, имя пользователя и пароль, а также версия преобразования метрик. На запрос из сети, которая не указана в allow-from, сервер отвечает кодом HTTP 403. Если заданы имя пользователя и пароль, запрос без них получает ответ с кодом HTTP 401. Команда telegraf vrf переносит агент сбора метрик в экземпляр VRF (см. Виртуальная маршрутизация).

Агент Zabbix¶

Агент Zabbix принимает запросы сервера Zabbix на адресах listen-address (по умолчанию на всех адресах IPv4) и порту port (по умолчанию 10050). Серверы Zabbix, которым разрешено опрашивать агент (пассивные проверки), задает команда server. Подключения с других адресов агент сбрасывает. Без команды server проверка конфигурации завершается ошибкой Server is required!. Серверы активных проверок задает команда server-active: агент сам подключается к этим серверам, получает от них список проверок и отправляет результаты. Дополнительно настраиваются имя узла агента, время ожидания обработки элемента данных, параметры буфера (limits), журнал агента (log) и каталог с дополнительными файлами конфигурации агента (directory).

В текущей версии ПО Факел параметр zabbix-agent log remote-commands не дает запуститься агенту Zabbix, а telegraf source не ограничивает сбор групп метрик (см. Ограничения).

Список команд¶

Режим «Конфигурирование»¶

service monitoring telegraf azure-data-explorer authentication client-id <client-id>¶

Описание:

Задает идентификатор приложения (client id) для аутентификации в Azure Data Explorer.

Синтаксис:

set service monitoring telegraf azure-data-explorer authentication client-id <client-id>
delete service monitoring telegraf azure-data-explorer authentication client-id <client-id>
show service monitoring telegraf azure-data-explorer authentication client-id

Аргументы:

<client-id> — идентификатор приложения. Формат: строка из латинских букв, цифр, знаков - и _.

Режим: «Конфигурирование».

service monitoring telegraf azure-data-explorer authentication client-secret <client-secret>¶

Описание:

Задает секрет приложения (client secret) для аутентификации в Azure Data Explorer.

Синтаксис:

set service monitoring telegraf azure-data-explorer authentication client-secret <client-secret>
delete service monitoring telegraf azure-data-explorer authentication client-secret <client-secret>
show service monitoring telegraf azure-data-explorer authentication client-secret

Аргументы:

<client-secret> — секрет приложения. Формат: строка из латинских букв, цифр, знаков - и _.

Режим: «Конфигурирование».

service monitoring telegraf azure-data-explorer authentication tenant-id <tenant-id>¶

Описание:
Задает идентификатор клиента (tenant id) для аутентификации в Azure Data Explorer.
Для Azure Data Explorer необходимо задать client-id, client-secret и tenant-id, иначе проверка конфигурации завершается ошибкой.

Синтаксис:

set service monitoring telegraf azure-data-explorer authentication tenant-id <tenant-id>
delete service monitoring telegraf azure-data-explorer authentication tenant-id <tenant-id>
show service monitoring telegraf azure-data-explorer authentication tenant-id

Аргументы:

<tenant-id> — идентификатор клиента. Формат: строка из латинских букв, цифр, знаков - и _.

Режим: «Конфигурирование».

service monitoring telegraf azure-data-explorer database <database>¶

Описание:
Задает имя базы данных Azure Data Explorer.
Параметр обязателен для отправки метрик в Azure Data Explorer.

Синтаксис:

set service monitoring telegraf azure-data-explorer database <database>
delete service monitoring telegraf azure-data-explorer database <database>
show service monitoring telegraf azure-data-explorer database

Аргументы:

<database> — имя базы данных. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf azure-data-explorer group-metrics <group-metrics>¶

Описание:

Задает способ группировки метрик при отправке в Azure Data Explorer.

Синтаксис:

set service monitoring telegraf azure-data-explorer group-metrics <group-metrics>
delete service monitoring telegraf azure-data-explorer group-metrics <group-metrics>
show service monitoring telegraf azure-data-explorer group-metrics

Аргументы:

<group-metrics> — способ группировки метрик. Возможные значения: single-table — все метрики хранятся в одной таблице; table-per-metric — отдельная таблица для каждой группы метрик с одним именем. Значение по умолчанию: table-per-metric.

Режим: «Конфигурирование».

service monitoring telegraf azure-data-explorer table <table>¶

Описание:
Задает имя таблицы для режима, в котором метрики хранятся в одной таблице (group-metrics single-table).
В этом режиме параметр обязателен, иначе проверка конфигурации завершается ошибкой Monitoring "table" name for single-table mode is mandatory!.

Синтаксис:

set service monitoring telegraf azure-data-explorer table <table>
delete service monitoring telegraf azure-data-explorer table <table>
show service monitoring telegraf azure-data-explorer table

Аргументы:

<table> — имя таблицы. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf azure-data-explorer url <url>¶

Описание:
Задает URL сервера Azure Data Explorer.
Параметр обязателен для отправки метрик в Azure Data Explorer.

Синтаксис:

set service monitoring telegraf azure-data-explorer url <url>
delete service monitoring telegraf azure-data-explorer url <url>
show service monitoring telegraf azure-data-explorer url

Аргументы:

<url> — URL сервера (HTTP или HTTPS). Формат: URL.

Режим: «Конфигурирование».

service monitoring telegraf influxdb authentication organization <organization>¶

Описание:

Задает организацию для аутентификации в InfluxDB версии 2.

Синтаксис:

set service monitoring telegraf influxdb authentication organization <organization>
delete service monitoring telegraf influxdb authentication organization <organization>
show service monitoring telegraf influxdb authentication organization

Аргументы:

<organization> — имя организации. Формат: строка длиной от 3 до 51 символа, начинается с латинской буквы.

Режим: «Конфигурирование».

service monitoring telegraf influxdb authentication token <token>¶

Описание:
Задает токен для аутентификации в InfluxDB версии 2.
Для InfluxDB необходимо задать организацию и токен, иначе проверка конфигурации завершается ошибкой.

Синтаксис:

set service monitoring telegraf influxdb authentication token <token>
delete service monitoring telegraf influxdb authentication token <token>
show service monitoring telegraf influxdb authentication token

Аргументы:

<token> — токен. Формат: строка из 88 символов: 86 латинских букв, цифр, знаков - и _, за которыми следуют знаки ==.

Режим: «Конфигурирование».

service monitoring telegraf influxdb bucket <bucket>¶

Описание:

Задает корзину (bucket) InfluxDB, в которую записываются метрики.

Синтаксис:

set service monitoring telegraf influxdb bucket <bucket>
delete service monitoring telegraf influxdb bucket <bucket>
show service monitoring telegraf influxdb bucket

Аргументы:

<bucket> — имя корзины. Формат: строка. Значение по умолчанию: main.

Режим: «Конфигурирование».

service monitoring telegraf influxdb port <port>¶

Описание:

Задает номер порта сервера InfluxDB.

Синтаксис:

set service monitoring telegraf influxdb port <port>
delete service monitoring telegraf influxdb port <port>
show service monitoring telegraf influxdb port

Аргументы:

<port> — номер порта. Формат: целое число. Диапазон значений: от 1 до 65535. Значение по умолчанию: 8086.

Режим: «Конфигурирование».

service monitoring telegraf influxdb url <url>¶

Описание:
Задает URL сервера InfluxDB.
Параметр обязателен для отправки метрик в InfluxDB.

Синтаксис:

set service monitoring telegraf influxdb url <url>
delete service monitoring telegraf influxdb url <url>
show service monitoring telegraf influxdb url

Аргументы:

<url> — URL сервера (HTTP или HTTPS). Формат: URL.

Режим: «Конфигурирование».

service monitoring telegraf loki authentication password <password>¶

Описание:
Задает пароль для аутентификации на сервере Loki.
Если задан раздел authentication, необходимо задать и имя пользователя, и пароль, иначе проверка конфигурации завершается ошибкой.

Синтаксис:

set service monitoring telegraf loki authentication password <password>
delete service monitoring telegraf loki authentication password <password>
show service monitoring telegraf loki authentication password

Аргументы:

<password> — пароль. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf loki authentication username <username>¶

Описание:

Задает имя пользователя для аутентификации на сервере Loki.

Синтаксис:

set service monitoring telegraf loki authentication username <username>
delete service monitoring telegraf loki authentication username <username>
show service monitoring telegraf loki authentication username

Аргументы:

<username> — имя пользователя. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf loki metric-name-label <metric-name-label>¶

Описание:

Задает метку, в которой передается имя метрики (имя группы метрик, например cpu или systemd_units).

Синтаксис:

set service monitoring telegraf loki metric-name-label <metric-name-label>
delete service monitoring telegraf loki metric-name-label <metric-name-label>
show service monitoring telegraf loki metric-name-label

Аргументы:

<metric-name-label> — имя метки. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf loki port <port>¶

Описание:

Задает номер порта сервера Loki.

Синтаксис:

set service monitoring telegraf loki port <port>
delete service monitoring telegraf loki port <port>
show service monitoring telegraf loki port

Аргументы:

<port> — номер порта. Формат: целое число. Диапазон значений: от 1 до 65535. Значение по умолчанию: 3100.

Режим: «Конфигурирование».

service monitoring telegraf loki url <url>¶

Описание:
Задает URL сервера Loki.
Параметр обязателен для отправки данных в Loki.

Синтаксис:

set service monitoring telegraf loki url <url>
delete service monitoring telegraf loki url <url>
show service monitoring telegraf loki url

Аргументы:

<url> — URL сервера (HTTP или HTTPS). Формат: URL.

Режим: «Конфигурирование».

service monitoring telegraf prometheus-client allow-from <allow-from>¶

Описание:

Задает сети, из которых разрешены запросы к серверу метрик Prometheus на маршрутизаторе. На запрос из другой сети сервер отвечает кодом HTTP 403.

Синтаксис:

set service monitoring telegraf prometheus-client allow-from <allow-from>
delete service monitoring telegraf prometheus-client allow-from <allow-from>
show service monitoring telegraf prometheus-client allow-from

Аргументы:

<allow-from> — IPv4- или IPv6-префикс. Формат: IPv4-префикс (x.x.x.x/x) или IPv6-префикс (h:h:h:h:h:h:h:h/x). Можно задать несколько значений.

Режим: «Конфигурирование».

service monitoring telegraf prometheus-client authentication password <password>¶

Описание:

Задает пароль для аутентификации запросов к серверу метрик Prometheus.

Синтаксис:

set service monitoring telegraf prometheus-client authentication password <password>
delete service monitoring telegraf prometheus-client authentication password <password>
show service monitoring telegraf prometheus-client authentication password

Аргументы:

<password> — пароль. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf prometheus-client authentication username <username>¶

Описание:

Задает имя пользователя для аутентификации запросов к серверу метрик Prometheus.

Синтаксис:

set service monitoring telegraf prometheus-client authentication username <username>
delete service monitoring telegraf prometheus-client authentication username <username>
show service monitoring telegraf prometheus-client authentication username

Аргументы:

<username> — имя пользователя. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf prometheus-client listen-address <listen-address>¶

Описание:

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

Синтаксис:

set service monitoring telegraf prometheus-client listen-address <listen-address>
delete service monitoring telegraf prometheus-client listen-address <listen-address>
show service monitoring telegraf prometheus-client listen-address

Аргументы:

<listen-address> — локальный IP-адрес. Формат: IPv4-адрес (x.x.x.x) или IPv6-адрес (h:h:h:h:h:h:h:h).

Режим: «Конфигурирование».

service monitoring telegraf prometheus-client metric-version <metric-version>¶

Описание:

Задает версию преобразования метрик в формат Prometheus.

Синтаксис:

set service monitoring telegraf prometheus-client metric-version <metric-version>
delete service monitoring telegraf prometheus-client metric-version <metric-version>
show service monitoring telegraf prometheus-client metric-version

Аргументы:

<metric-version> — версия метрик. Формат: целое число. Диапазон значений: от 1 до 2. Значение по умолчанию: 2.

Режим: «Конфигурирование».

service monitoring telegraf prometheus-client port <port>¶

Описание:

Задает номер порта, на котором сервер метрик Prometheus принимает запросы.

Синтаксис:

set service monitoring telegraf prometheus-client port <port>
delete service monitoring telegraf prometheus-client port <port>
show service monitoring telegraf prometheus-client port

Аргументы:

<port> — номер порта. Формат: целое число. Диапазон значений: от 1 до 65535. Значение по умолчанию: 9273.

Режим: «Конфигурирование».

service monitoring telegraf source <source>¶

Описание:

Задает группы параметров, которые собирает агент сбора метрик.

Синтаксис:

set service monitoring telegraf source <source>
delete service monitoring telegraf source <source>
show service monitoring telegraf source

Аргументы:

<source> — группа параметров. Возможные значения: all — все параметры; hardware-utilization — использование оборудования (процессор, диски, память); logs — журналы; network — сетевые параметры (интерфейсы, сетевые соединения, межсетевой экран ядра); system — системные параметры (система, процессы, прерывания); telegraf — внутренняя статистика агента сбора метрик. Значение по умолчанию: all. Можно задать несколько значений.

Режим: «Конфигурирование».

service monitoring telegraf splunk authentication insecure¶

Описание:

Включает TLS без проверки подлинности узла Splunk.

Синтаксис:

set service monitoring telegraf splunk authentication insecure
delete service monitoring telegraf splunk authentication insecure
show service monitoring telegraf splunk authentication insecure

Режим: «Конфигурирование».

service monitoring telegraf splunk authentication token <token>¶

Описание:
Задает токен авторизации на сервере Splunk.
Параметр обязателен для отправки метрик в Splunk.

Синтаксис:

set service monitoring telegraf splunk authentication token <token>
delete service monitoring telegraf splunk authentication token <token>
show service monitoring telegraf splunk authentication token

Аргументы:

<token> — токен авторизации. Формат: строка.

Режим: «Конфигурирование».

service monitoring telegraf splunk url <url>¶

Описание:
Задает URL сервера Splunk. Метрики отправляются по этому URL без изменений, поэтому URL должен содержать полный путь приема данных, например http://<адрес>:8088/services/collector.
Параметр обязателен для отправки метрик в Splunk.

Синтаксис:

set service monitoring telegraf splunk url <url>
delete service monitoring telegraf splunk url <url>
show service monitoring telegraf splunk url

Аргументы:

<url> — URL сервера (HTTP или HTTPS). Формат: URL.

Режим: «Конфигурирование».

service monitoring telegraf vrf <vrf>¶

Описание:

Задает экземпляр VRF, в котором работает агент сбора метрик.

Синтаксис:

set service monitoring telegraf vrf <vrf>
delete service monitoring telegraf vrf <vrf>
show service monitoring telegraf vrf

Аргументы:

<vrf> — имя экземпляра VRF. Формат: строка.

Режим: «Конфигурирование».

service monitoring zabbix-agent directory <directory>¶

Описание:
Задает каталог с отдельными файлами конфигурации агента Zabbix. Агент читает из каталога файлы с расширением .conf.
Каталог должен существовать, иначе значение не принимается: Incorrect path <directory>: no such file or directory.

Синтаксис:

set service monitoring zabbix-agent directory <directory>
delete service monitoring zabbix-agent directory <directory>
show service monitoring zabbix-agent directory

Аргументы:

<directory> — путь к каталогу. Формат: строка.

Режим: «Конфигурирование».

service monitoring zabbix-agent host-name <host-name>¶

Описание:

Задает имя узла агента Zabbix.

Синтаксис:

set service monitoring zabbix-agent host-name <host-name>
delete service monitoring zabbix-agent host-name <host-name>
show service monitoring zabbix-agent host-name

Аргументы:

<host-name> — имя узла. Формат: строка из латинских букв, цифр, точек и дефисов; начинается и заканчивается буквой или цифрой.

Режим: «Конфигурирование».

service monitoring zabbix-agent limits buffer-flush-interval <buffer-flush-interval>¶

Описание:

Задает максимальное время в секундах, в течение которого данные хранятся в буфере.

Синтаксис:

set service monitoring zabbix-agent limits buffer-flush-interval <buffer-flush-interval>
delete service monitoring zabbix-agent limits buffer-flush-interval <buffer-flush-interval>
show service monitoring zabbix-agent limits buffer-flush-interval

Аргументы:

<buffer-flush-interval> — время в секундах. Формат: целое число. Диапазон значений: от 1 до 3600. Значение по умолчанию: 5.

Режим: «Конфигурирование».

service monitoring zabbix-agent limits buffer-size <buffer-size>¶

Описание:

Задает максимальное количество значений в буфере в памяти.

Синтаксис:

set service monitoring zabbix-agent limits buffer-size <buffer-size>
delete service monitoring zabbix-agent limits buffer-size <buffer-size>
show service monitoring zabbix-agent limits buffer-size

Аргументы:

<buffer-size> — количество значений. Формат: целое число. Диапазон значений: от 2 до 65535. Значение по умолчанию: 100.

Режим: «Конфигурирование».

service monitoring zabbix-agent listen-address <listen-address>¶

Описание:

Задает локальные IP-адреса, на которых агент Zabbix принимает подключения.

Синтаксис:

set service monitoring zabbix-agent listen-address <listen-address>
delete service monitoring zabbix-agent listen-address <listen-address>
show service monitoring zabbix-agent listen-address

Аргументы:

<listen-address> — локальный IP-адрес. Формат: IPv4-адрес (x.x.x.x) или IPv6-адрес (h:h:h:h:h:h:h:h). Значение по умолчанию: 0.0.0.0. Можно задать несколько значений.

Режим: «Конфигурирование».

service monitoring zabbix-agent log debug-level <debug-level>¶

Описание:

Задает уровень детализации журнала агента Zabbix.

Синтаксис:

set service monitoring zabbix-agent log debug-level <debug-level>
delete service monitoring zabbix-agent log debug-level <debug-level>
show service monitoring zabbix-agent log debug-level

Аргументы:

<debug-level> — уровень детализации журнала. Возможные значения: basic — основные сведения; critical — критические сообщения; error — ошибки; warning — предупреждения; debug — отладочные сведения; extended-debug — расширенные отладочные сведения. Значение по умолчанию: warning.

Режим: «Конфигурирование».

service monitoring zabbix-agent log remote-commands¶

Описание:

Включает запись выполненных команд оболочки в журнал агента Zabbix как предупреждений.

Синтаксис:

set service monitoring zabbix-agent log remote-commands
delete service monitoring zabbix-agent log remote-commands
show service monitoring zabbix-agent log remote-commands

Режим: «Конфигурирование».

service monitoring zabbix-agent log size <size>¶

Описание:

Задает размер файла журнала агента Zabbix в мегабайтах.

Синтаксис:

set service monitoring zabbix-agent log size <size>
delete service monitoring zabbix-agent log size <size>
show service monitoring zabbix-agent log size

Аргументы:

<size> — размер файла журнала в мегабайтах. Формат: целое число. Диапазон значений: от 0 до 1024. Значение по умолчанию: 0.

Режим: «Конфигурирование».

service monitoring zabbix-agent port <port>¶

Описание:

Задает номер порта, на котором агент Zabbix принимает подключения.

Синтаксис:

set service monitoring zabbix-agent port <port>
delete service monitoring zabbix-agent port <port>
show service monitoring zabbix-agent port

Аргументы:

<port> — номер порта. Формат: целое число. Диапазон значений: от 1 до 65535. Значение по умолчанию: 10050.

Режим: «Конфигурирование».

service monitoring zabbix-agent server <server>¶

Описание:
Задает сервер Zabbix, которому разрешено опрашивать агент (пассивные проверки). Подключения с других адресов агент сбрасывает.
Сервер необходимо задать, иначе проверка конфигурации завершается ошибкой.

Синтаксис:

set service monitoring zabbix-agent server <server>
delete service monitoring zabbix-agent server <server>
show service monitoring zabbix-agent server

Аргументы:

<server> — адрес сервера Zabbix. Формат: IPv4-адрес (x.x.x.x), IPv6-адрес (h:h:h:h:h:h:h:h) или имя узла. Можно задать несколько значений.

Режим: «Конфигурирование».

service monitoring zabbix-agent server-active <server-active>¶

Описание:

Задает сервер Zabbix <server-active>, от которого агент получает активные проверки. Агент сам подключается к этому серверу.

Синтаксис:

set service monitoring zabbix-agent server-active <server-active>
delete service monitoring zabbix-agent server-active <server-active>
show service monitoring zabbix-agent server-active

Аргументы:

<server-active> — адрес сервера. Формат: IPv4-адрес (x.x.x.x), IPv6-адрес (h:h:h:h:h:h:h:h) или имя узла.

Режим: «Конфигурирование».

service monitoring zabbix-agent server-active <server-active> port <port>¶

Описание:

Задает номер порта сервера активных проверок <server-active>.

Синтаксис:

set service monitoring zabbix-agent server-active <server-active> port <port>
delete service monitoring zabbix-agent server-active <server-active> port <port>
show service monitoring zabbix-agent server-active <server-active> port

Аргументы:

<server-active> — адрес сервера активных проверок.
<port> — номер порта. Формат: целое число. Диапазон значений: от 1 до 65535.

Режим: «Конфигурирование».

service monitoring zabbix-agent timeout <timeout>¶

Описание:

Задает время ожидания обработки элемента данных в секундах.

Синтаксис:

set service monitoring zabbix-agent timeout <timeout>
delete service monitoring zabbix-agent timeout <timeout>
show service monitoring zabbix-agent timeout

Аргументы:

<timeout> — время ожидания в секундах. Формат: целое число. Диапазон значений: от 1 до 30. Значение по умолчанию: 3.

Режим: «Конфигурирование».