Получение метрик¶

Выгрузка метрик напрямую из collectd¶

Вы можете напрямую выгружать метрики, собранные collectd, в инструменты, которые поддерживают работу с потоком данных в формате collectd.

Выгрузка метрик с помощью плагина Network¶

Настройте и подключите плагин Network к collectd:

1. Создайте в директории /etc/collectd/collectd.conf.d/ файл конфигурации для плагина с расширением .conf (например, export-via-network.conf) и следующим содержимым:

   LoadPlugin network
   
   <Plugin "network">
     Server "Server IPv4/v6 address or FQDN" "Server port"
   </Plugin>
   

   Согласно этому конфигурационному файлу, плагин будет запускаться при старте collectd, работать в режиме клиента и пересылать данные о метриках WAF‑ноды на указанный сервер.

2. Настройте сервер, который будет принимать данные от collectd-клиента. Необходимые шаги по настройке зависят от выбранного сервера (примеры: collectd, InfluxDB).

3. Перезапустите сервис collectd, выполнив команду, соответствующую операционной системе, на которой установлена WAF‑нода:

   Ubuntu 14.04 LTSДругие поддерживаемые дистрибутивы

   sudo service wallarm-collectd restart
   

   sudo systemctl restart wallarm-collectd.service
   

Выгрузка метрик с помощью write‑плагина collectd¶

Для того, чтобы настроить выгрузку метрик с помощью write‑плагина collectd, обратитесь к документации соответствующего плагина.

Выгрузка метрик с помощью утилиты collectd-nagios¶

Для выгрузки метрик с помощью этого способа:

1. Установите утилиту collectd-nagios на хост с WAF‑нодой, выполнив одну из следующих команд (для WAF‑ноды, установленной на Linux):

   DEB-based дистрибутивыRPM‑based дистрибутивы

   sudo apt install --no-install-recommends collectd-utils
   

   sudo yum install collectd-utils
   

   Образ Docker

   Образ Docker c WAF‑нодой уже содержит в себе предустановленную утилиту collectd-nagios.

2. Убедитесь, что у вас есть возможность запускать эту утилиту с повышенными правами либо от имени пользователя суперпользователя (например, root), либо с помощью sudo путем добавления необходимых пользователей в файл sudoers с директивой NOPASSWD.

   Работа с Docker‑контейнером

   При вызове утилиты collectd-nagios из Docker‑контейнера с WAF‑нодой повышение прав не требуется.

3. Подключите и настройте плагин UnixSock для передачи метрик collectd через сокет домена Unix. Для этого создайте файл /etc/collectd/collectd.conf.d/unixsock.conf со следующим содержимым:

   LoadPlugin unixsock
   
   <Plugin unixsock>
       SocketFile "/var/run/wallarm-collectd-unixsock"
       SocketGroup "root"
       SocketPerms "0770"
       DeleteSocket true
   </Plugin>
   

4. Перезапустите сервис collectd, выполнив команду, соответствующую операционной системе, на которой установлена WAF‑нода:

   Ubuntu 14.04 LTSДругие поддерживаемые дистрибутивы

   sudo service wallarm-collectd restart
   

   sudo systemctl restart wallarm-collectd.service
   

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

   LinuxDocker

   /usr/bin/collectd-nagios -s /var/run/wallarm-collectd-unixsock -n <название метрики без указания имени хоста> -H <полное доменное имя хоста с WAF‑нодой, на котором запускается утилита>
   

   docker exec <имя контейнера> /usr/bin/collectd-nagios -s /var/run/wallarm-collectd-unixsock -n <название метрики без указания имени хоста> -H <идентификатор контейнера>
   

   Получение идентификатора контейнера Docker

   Вы можете узнать значение идентификатора контейнера, выполнив команду docker ps (см. столбец «CONTAINER ID»).

Примеры вызова утилиты:

• Чтобы получить значение метрики curl_json-wallarm_nginx/gauge-abnormal на Linux‑хосте node.example.local с WAF‑нодой, необходимо выполнить следующую команду:

  /usr/bin/collectd-nagios -s /var/run/wallarm-collectd-unixsock -n curl_json-wallarm_nginx/gauge-abnormal -H node.example.local
  

• Чтобы получить значение метрики curl_json-wallarm_nginx/gauge-abnormal (на момент вызова collectd-nagios) для WAF‑ноды, запущенной в Docker‑контейнере с именем wallarm-node и с идентификатором 95d278317794, необходимо выполнить следующую команду:

  docker exec wallarm-node /usr/bin/collectd-nagios -s /var/run/wallarm-collectd-unixsock -n curl_json-wallarm_nginx/gauge-abnormal -H 95d278317794
  

Отправка уведомлений от collectd¶

Уведомления настраиваются в файле:

/etc/collectd/wallarm-collectd.conf.d/traps.conf

/etc/collectd.d/traps.conf

Общее описание работы уведомлений доступно здесь.
Подробное описание процесса настройки уведомлений доступно здесь.

Возможные методы для отправки уведомлений:

• NSCA и NSCA-ng,

• SNMP TRAP,

• почтовые сообщения,

• собственные скрипты.

Выгрузка метрик в формате prometheus¶

Метрики, которые отслеживаются в модуле постаналитики, можно получить в формате prometheus, для этого используются переменные окружения:

• WMX_TARANTOOL_METRICS_HOST

• WMX_TARANTOOL_METRICS_PORT

С помощью переменных можно управлять адресом и портом HTTP-сервера с метриками.

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

• Меганода

• Пакетная установка

Метрики Prometheus доступны по пути /metrics/prometheus:

$ curl http://127.0.0.1:3314/metrics/prometheus
# HELP export_drops_flag Have dropped before export in the past minute?
# TYPE export_drops_flag gauge
export_drops_flag 0
# HELP last_request_id Last request ID
# TYPE last_request_id gauge
last_request_id 1
# HELP export_drops Dropped before export
# TYPE export_drops gauge
export_drops 0
# HELP timeframe_size Time between first and last stored requests
# TYPE timeframe_size gauge
timeframe_size 1
# HELP export_delay Export delay
# TYPE export_delay gauge
export_delay 0