Close
Log in to Zabbix Blog
Email
Password
Show password Hide password
Forgot password?
Incorrect e-mail and/or password
or
By creating an account or logging in with an existing account, you agree to our Terms of Service
Как сделатьТехнический постВойти

Zabbix и Docker API, часть 2: Adapt

В этой статье я покажу, как создать шаблон для мониторинга сервера Docker только с помощью вызовов API (без агента Zabbix 2). Вместо того чтобы создавать шаблон, элементы данных шаблона, правила LLD и прототипы триггеров с нуля, мы адаптируем их из существующего шаблона «Docker by Zabbix agent 2». Как это делает агент Zabbix 2? Если вам […]

В этой статье я покажу, как создать шаблон для мониторинга сервера Docker только с помощью вызовов API (без агента Zabbix 2). Вместо того чтобы создавать шаблон, элементы данных шаблона, правила LLD и прототипы триггеров с нуля, мы адаптируем их из существующего шаблона «Docker by Zabbix agent 2».

Как это делает агент Zabbix 2?

Если вам интересно, как агент Zabbix 2 собирает данные, загляните в исходный код и посмотрите, какая магия происходит за кулисами: https://github.com/zabbix/zabbix/blob/master/src/go/plugins/docker/metrics.go.

Если коротко, он использует сокет UNIX-домена (не TCP), выполняет запросы к Docker API на узле сети и возвращает объекты JSON. Но ведь из предыдущей статьи мы уже знаем, как использовать его самостоятельно, верно?

Чтобы агент Zabbix 2 мог работать с шаблоном Docker, ему нужен доступ к сокету UNIX-домена: для этого нужно либо добавить пользователя Zabbix в группу Docker, либо запускать Zabbix-agent2 от имени root.

Рис. 1. Исходный код плагина Docker для агента Zabbix 2

Как это сделаем мы

Я могу адаптировать этот шаблон, импровизировать всякий раз, когда сталкиваюсь с несуществующей метрикой, и, приложив усилия, преодолеть любую техническую трудность! По большей части в шаблоне есть несколько элементов данных агента Zabbix, которые массово собирают данные, и множество зависимых элементов данных (а также прототипов зависимых элементов данных из правил LLD).

Дальнейший путь довольно прост — мы клонируем шаблон, заменим тип элементов данных «агент Zabbix» на «HTTP агент» и добавим дополнительные параметры, показанные ниже. Я также добавлю в шаблон дополнительные пользовательские макросы, в том числе для IP-адреса и порта сервера Docker, а также для имен файлов CA, SSL-сертификата и ключа, чтобы их можно было изменять на уровне узла сети.

Рис. 2. Порядок изменения шаблонов

Клонирование шаблона и изменение типа элемента данных

Сначала клонируйте шаблон «Docker by Zabbix agent 2» и дайте ему новое имя: «Docker stats by HTTP». Затем измените настройки элементов данных шаблона типа «агент Zabbix», указав следующие параметры:

Рис. 3. Изменение настроек элемента данных шаблона

Изменение элементов данных шаблона «Docker by HTTP»:

● Modify item: Get containers
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers/json?all=true     
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● Modify item: Get data_usage
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/system/df
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● Modify item: Get images
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/images/json
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
●Modify item: Get info
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/info
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● Modify item: Ping
  ▪ Type HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/_ping
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
♯ Preprocessing (additional first step)
  ▪ Boolean to Decimals

Также нужно изменить настройки правила LLD. Измените тип элемента данных с «агент Zabbix» на «HTTP агент»:

Рис. 4. Изменение правила низкоуровневого обнаружения: containers discovery
Modify LLD rule: Containers discovery
● Discovery rule
  ▪ Type: HTTP agent
  ▪ Key: docker.containers.discovery[true]
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers/json?all=true     
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
  ▪ Update interval: 1h
● LLD macros
  ▪ {#ID}   $.Id
  ▪ {#NAME} $.Names.first()
Modify LLD rule: Images discovery
● Discovery rule
  ▪ Type: Dependent item
  ▪ Master item: item> Get images
● LLD macros
  ▪ {#ID}   $.Id
  ▪ {#NAME} $.RepoTags

После этого мы также внесем изменения в правило LLD «Containers discovery»: изменим несколько существующих прототипов элементов данных (типа «агент Zabbix») и добавим новый элемент данных. Ниже приведены прототипы элементов данных, которые нужно изменить:

● In LLD rule Containers discovery, modify parameters for item prototype: Container {#NAME}: Get info
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers{#NAME}/json       
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● In LLD rule Containers discovery, modify item prototype: Container {#NAME}: Get stats
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers{#NAME}/stats?stream=false  
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● In LLD rule Containers discovery, modify parameters for item prototype: Container {#NAME}: CPU percent usage
  ▪ Type: Calculated
  ▪ Formula: last(//docker.container_stats.cpu_usage.total.rate["{#NAME}"])/last(//docker.container_stats.system_cpu_usage.total.rate["{#NAME}"])*last(//docker.container_stats.online_cpus["{#NAME}"])*100
♯ Preprocessing (delete preprocessing step JSONPath)
● In LLD rule Containers discovery, add new item prototype: Container {#NAME}: System CPU total usage per second
  ▪ Name: Container {#NAME}: System CPU total usage per second
  ▪ Type: Dependent item
  ▪ Key: docker.container_stats.system_cpu_usage.total.rate["{#NAME}"]
  ▪ Type of information Numeric (float)
  ▪ Master item    prototype > Container {#NAME}: Get stats

♦ Tags (name:value)        
  ▪ component:cpu
  ▪ container:{#NAME}      

♯ Preprocessing

  ▪ JSONPath       $.cpu_stats.system_cpu_usage
  ▪ Change per second
  ▪ Custom multiplier: 1.0E-9

Клонирование шаблона (еще раз) и небольшие изменения

Далее я клонирую шаблон «Docker statistics by HTTP» и дам копии новое имя — «Docker containers by HTTP». В шаблоне «Docker containers by HTTP» удалите правило LLD Images discovery; удалите элементы данных шаблона; в правиле LLD «Containers discovery» удалите все прототипы сущностей (прототипы элементов данных) и добавьте в правило LLD фильтр (показан ниже):

In LLD rule Containers discovery rule, in Filter tab: add additional filter option
Filters [type of calculation: A and B and C]
   ▪ {#ID} matches {HOST.HOST}

Я также создал группу узлов сети «Docker», в которую будут добавляться обнаруженные узлы сети контейнеров. В шаблоне «Docker statistics by HTTP» удалите все прототипы элементов данных в правиле LLD «Containers discovery». Мы создадим прототип узла сети в правиле низкоуровневого обнаружения «Containers discovery» — его параметры показаны ниже:

Host prototype in LLD rule: Containers discovery
  ▪ Host name:     {#ID}
  ▪ Visible name:  {#NAME}
  ▪ Templates:     Docker containers by HTTP
Рис. 5. Настройки прототипа узла сети в правиле LLD: Containers discovery
Рис. 6. Клонированные и измененные шаблоны

Создание узла сети и привязка шаблона

Теперь осталось только создать узел сети и привязать к нему шаблон «Docker statistics by HTTP». Не забудьте указать в пользовательском макросе правильный IP-адрес или DNS-имя Docker.

Я создал новый узел сети «Docker server», привязал к нему шаблон и изменил пользовательский макрос с IP-адресом Docker. Этот узел сети будет собирать общую статистику Docker. После выполнения низкоуровневого обнаружения имена контейнеров будут обнаружены автоматически, и будут созданы узлы сети контейнеров с привязанным шаблоном.

Рис. 7. Обнаруженные узлы сети контейнеров с привязанными шаблонами

Если по какой-то причине вы выполняете мониторинг нескольких экземпляров Docker, могут быть обнаружены одинаковые имена контейнеров, что приведет к ошибкам LLD, поскольку не может быть узлов сети с одинаковым именем (ID контейнера) или отображаемым именем (имя контейнера). Быстрое решение — для каждого экземпляра Docker добавить префикс к имени каждого контейнера. Другое решение — не разделять шаблон на две части: тогда элементы данных будут обнаружены в рамках одного узла сети, и этой проблемы не возникнет.

Узел сети «Docker server» показывает общую информацию о состоянии и статусе сервера Docker в целом:

Рис. 8. Последние данные узла сети «Docker server»

Для каждого обнаруженного контейнера будет автоматически создан узел сети, который будет собирать метрики производительности этого контейнера:

Рис. 9. Последние данные контейнера zabbix-agent2

Заключение

Теперь мы с вами знаем немного больше о том, как агент Zabbix 2 собирает метрики Docker. В этой статье было показано, как импровизировать и адаптировать существующие шаблоны к разным методам сбора данных. Zabbix — очень универсальный инструмент, который при наличии технических ограничений позволяет получать данные множеством способов. Прилагаемый шаблон также можно использовать как есть или изменить под свои нужды.

Prev Post Prev Post Next Post Next Post
Подписаться
Уведомить о
0 Comments
Старые
Новые Популярные
0
Оставьте комментарий! Напишите, что думаете по поводу статьи.x