| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Версия ПО 0.7 |
Оглавление
Общая информация
Peeper — система мониторинга программных продуктов Eltex.
...
Все ПО предоставляется в виде Docker-образов, размещенных в публичных репозиториях, и файлов compose.yml и .env для деплоя контейнеров.
Зачем необходим Peeper
Peeper нужен, чтобы:
- предотвратить появление чрезвычайной ситуации на серверах и приложениях клиента заранее;
- в случае ЧС иметь возможность постфактум распутать клубок инцидента (иметь всю необходимую информацию в одном месте для того, чтобы завершить расследование);
- иметь возможность оперативно оценить внутреннее состояние системы по ее внешним показателям, а не просто констатировать факт, что система сломалась.
Функции и свойства Peeper
Peeper прост в развертывании и эксплуатации, что крайне важно для системы мониторинга. Также Peeper позволяет:
- собирать, хранить метрики и логи;
- визуализировать данные в виде дашбордов, графиков, диаграмм, таблиц;
- высылать алерты в случае срабатывания триггера по какой-либо метрике.
Архитектура Peeper
В архитектуре Peeper предусмотрено, что для получения метрик со стороны Peeper Client не требуется открывать никаких дополнительных портов на стороне сервера с программным продуктом Eltex. Отправка метрик с этого сервера производится методом Push.
Все входящие запросы в Peeper Server идут по HTTPs через Peeper Proxy по 443 порту.
УстановкаЯкорь Установка Установка
| Установка | |
| Установка |
| Примечание |
|---|
Для успешной установки Peeper Server и Peeper Client на всех серверах должен быть предустановлен docker и docker compose https://docs.docker.com/engine/install/ubuntu/ |
Peeper Server
Требования к серверу
| ОС | Ubuntu 22.04 Server или выше |
| CPU | 2 |
| RAM | 4 ГБ |
| Disk | 100 ГБ |
| Предустановленное ПО | Docker, Docker Compose |
Для установки скачайте на сервер для peeper-server архив с файлами: https://cloud.eltex-co.ru/index.php/s/n4RRd4rgx9pgxUO/download?path=%2F&files=peeper-deploy.tar
| Блок кода |
|---|
mkdir peeper-server && cd peeper-server wget "https://cloud.eltex-co.ru/index.php/s/n4RRd4rgx9pgxUO/download?path=%2F&files=peeper-deploy.tar" -O peeper-deploy.tar |
...
Начиная с версии 0.7, скрипт установки поддерживает дополнительные параметры запуска, которые позволяют включать отдельные модули. Параметры могут вызываться как длинными, так и короткими ключами.
| Модуль | Длинный ключ | Короткий ключ | Описание |
|---|---|---|---|
| backup | --backup | -B | Включает модуль резервного копирования. |
| blackbox | --blackbox | -b | Включает модуль мониторинга через Blackbox Exporter. |
| -e | Включает модуль отправки уведомлений по email. |
Пример запуска с ключами:
...
| Информация |
|---|
В compose.yml Peeper Server для сервиса peeper-grafana используется volume "peeper-grafana-config", который монтируется в директорию /etc/grafana в контейнере. Часто при настройке LDAP в Grafana или других функций через WEB вручную конфигурация сохраняется в /etc/grafana, например, в таких файлах как grafana.ini Таким образом, чтобы при переустановке Peeper не потерять эти данные, достаточно не удалять этот volume, а примонтировать его к новой инсталляции Peeper: все настройки будут сохранены. |
Peeper Client
Для установки Peeper Client скачайте на сервер peeper-client архив с файлами: https://cloud.eltex-co.ru/index.php/s/n4RRd4rgx9pgxUO/download?path=%2F&files=peeper-client.tar
| Информация |
|---|
Для продукта ECSS-10 не требуется установка Peeper Client на сервер с ECSS-10. ECSS-10 содержит внутреннюю реализацию функционала Peeper Client в своем составе. |
| Информация |
|---|
Для установки Peeper Client на сервере с SoftWLC архив peeper-client.tar нужно скачать в дирректорию /opt/eltex-softwlc/data/peeper/ |
| Блок кода |
|---|
wget "https://cloud.eltex-co.ru/index.php/s/n4RRd4rgx9pgxUO/download?path=%2F&files=peeper-client.tar" -O peeper-client.tar |
Далее распакуйте из архива файлы:
...
Команда установки Peeper Client:
| Блок кода |
|---|
sudo ./setup.sh -i |
| Информация |
|---|
В случае, если при установке Peeper Client командой ./setup.sh -i появилась ошибка "Error response from daemon: error while removing network", то необходимо в .env файле изменить значение опции PEEPER_EXTERNAL_MODE на "true" и запустить скрипт инсталляции еще раз |
При установке Peeper Client на сервера с ECCM или SoftWLC необходимо распаковать архив с Peeper в дирректорию, откуда происходила установка SoftWLC или ECCM, чтобы установочные файлы Peeper оказались на одном уровне с папкой "provisioning".
...
Начиная с версии 0.7, установка peeper-client поддерживает дополнительные параметры запуска для включения модулей экспортеров.
Параметры можно вызывать как длинными, так и короткими ключами.
| Модуль | Длинный ключ | Короткий ключ | Описание |
|---|---|---|---|
| mysql | --mysql | -m | Включает модуль peeper-exporter-mysql для сбора метрик MySQL. |
| postgres | --postgres | -o | Включает модуль peeper-exporter-postgres для сбора метрик PostgreSQL. |
Пример запуска с ключами:
...
| Информация | ||
|---|---|---|
| ||
Для корректной работы модулей peeper-exporter-mysql и peeper-exporter-mysql недостаточно только включить их через ключи или *_ENABLED=true.
Без этих значений экспортеры не смогут подключиться к базам данных и начать сбор метрик. |
Графический интерфейс
Графический интерфейс представляет из себя GUI Grafana, доступный по адресу: https://<адрес сервера>
...
Для получения информации о каждом графике в Дашборде наведите курсор на иконку i над графиком. Отобразится текстовая подсказка с информацией по данному графику.
Настройка отправки уведомлений в Telegram
Для того, чтобы уведомления в результате срабатывания Алертов отправлялись в чат Telegram, необходимо в WEB интерфейсе Grafana перейти в раздел "Alerting" → "Contact Points". Там для Contact Point "Telegram" нажимаем "Edit", в поле Chat ID вводим ID чата Telegram, куда должны отправляться уведомления, а в поле Bot API Token нажимаем Reset и вводим token Telegram бота, который должен быть добавлен в чат. Проверить корректность введенных данных и доставку алертов в чат можно кнопкой "Test".
Далее сохраняем настройки кнопкой "Save Contact Point".
Использование модуля peeper-blackbox для мониторинга доступности сайтов
На данный момент при стандартной установке peeper-server, устанавливает peeper-exporter-blackbox, который позволяет нам мониторить необходимые сайты, следить за состоянием сертификатов и уведомлять нас о проблемах с доступностью.
...
Есть 6 видов скрейп модулей для мониторинга разных по функциональности сайтов:
| Название модуля | Описание | Протокол | Особенности |
|---|---|---|---|
http_2xx | Стандартный модуль для мониторинга большинства сайтов | HTTP/HTTPS | Проверка доступности и получения кода ответа 2xx |
http_2xx_custom_ca | Стандартный модуль для мониторинга сайтов с кастомным CA | HTTPS | Требует CA сертификат по пути certificates/ca/ca.crt |
http_2xx_tls_strict | Модуль для мониторинга только HTTPS сайтов | HTTPS | Строгая проверка TLS/SSL соединения |
http_tls_expiry | Модуль для мониторинга SSL сертификатов | HTTPS | Проверяет срок действия сертификата без загрузки контента |
http_post_json_2xx | Модуль для мониторинга POST JSON endpoints | HTTP/HTTPS | Отправка POST запросов с JSON данными, проверка кода 2xx |
icmp | Модуль для проверки доступности по IP | ICMP | Проверка доступности узла через ping |
Резервное копирование Peeper
Контейнер с бэкапами умеет записывать метрику vm_backup_status и vm_backup_timestamp. Внутри peeper есть алерт, который показывает, если последний бэкап завершился с ошибкой или не выполнился.
Снятие резервных копий
Для резервного копирования peeper-server есть отдельный контейнер, который запускается вместе со всем peeper. Данный контейнер, с помощью утилит резервного копирования Victoria Metrics осуществляет резервное копирование истории метрик. конифгурация данного контейнера происходит в .env.backup файле:
...
| Блок кода | ||
|---|---|---|
| ||
docker exec peeper-vmbackup-toolbox sh /backup.sh |
Восстановление резервных копий
Для восстановления из резервной копии, необходимо действовать так:
...
| Блок кода | ||
|---|---|---|
| ||
docker ps | grep peeper |
Взаимодействие с сертификатами Peeper
Для работы peeper используется несколько сертификатов, которые описаны ниже:
...
| Блок кода |
|---|
docker restart peeper-exporter-blackbox |
Ошибка пересечения сетей
В случае возникновения подобной ошибки:
...