...
- Клиентская. Устанавливается на одном сервере с продуктом, например ECCM, Softswitch или EVISoftWLC. В ее задачи входит сбор метрик и их отправка на серверную часть.
- Серверная. В ее задачи входит агрегация и хранение метрик, визуализация метрик в виде графиков, отправка алертов об авариях в Telegram.
Все ПО предоставляется в виде Docker-контейнеровобразов, размещенных в публичных репозиториях, и файлов docker- compose.yml и .env для деплоя контейнеров.
...
УстановкаЯкорь Установка Установка
| Установка | |
| Установка |
...
| Примечание |
|---|
Для успешной установки Peeper Server и Peeper Client на всех серверах должен быть предустановлен docker и docker compose https://docs.docker.com/engine/install/ubuntu/ |
...
Пароль для скачивания можно запросить в Коммерческом Отделе Eltex или в ServiceDesk: https://servicedesk.eltex-co.ru/
Далее распакуйте из архива файлы:
...
Cкорректируйте переменные в файле .env. Как минимум необходимо скорректировать 1 переменную: PEEPER_HOST. В ней нужно указать IP сервера Peeper, по которому пользователи и администраторы будут открывать WEB Peeper.
| Информация | ||
|---|---|---|
| ||
При установке Peeper Server автоматически производится провиженинг дашбордов и алертов для метрик Linux и Docker. Также производится провиженинг Contact Points, для того, чтобы алерты отправлялись в определенный Telegram чат с помощью определенного Telegram bot-а. Чтобы указать Telegram chat ID и Telegram bot token, необходимо отредактировать файл provisioning/alert-contact-points/contactPoint-telegram.json: скорректировать "bottoken" и "chatid". Тогда алерты, возникающие при работе Peeper Server, будут отправляться в указанный Telegram чат, Docker, Postgres, Haproxy, входящего в состав Peeper Server. |
Команда установки Peeper Server:
...
Пароль для скачивания можно запросить в Коммерческом Отделе Eltex или в ServiceDesk: https://servicedesk.eltex-co.ru/
Далее распакуйте из архива файлы:
...
Cкорректируйте переменные в файле .env. Как минимум необходимо скорректировать 2 переменные: PEEPER_HOST, PEEPER_IP. В них нужно указать доменное имя и IP хоста Peeper Server, чтобы клиент знал, куда отправлять метрики.
| Информация |
|---|
Если вы не используете для доступа к Peeper Server доменное имя, то просто укажите IP Peeper Server в обоих переменных PEEPER_HOST, PEEPER_IP |
Сгенерируйте token в WEB Grafana : зайдите в меню (https://<адрес Peeper Server>:443). Зайдите в меню "Administration" → "Users and access" → "Service accounts" → "Add service account" → "Add service account token" → "Generate token".
Опишите Сохраните token для доступа к Grafana в файле peeper-token:
| Блок кода |
|---|
echo <token> > peeper-token |
После запуска Peeper Client токен из файла peeper-token будет автоматически удален
Команда установки Peeper Client:
...
где <app> — имя ПО Элтекс, установленное на данном сервере, например eccm или softswitchsoftwlc.
Особенности установки Peeper Client для Softswitch 3.14.15.17
Версия Softswitch 3.14.15.17 может быть совместима с Peeper-Client при выполнении следующих требований:
...
| Блок кода |
|---|
ports:
- "3000:3000" |
...
| Блок кода |
|---|
ports:
- "8429:8429" |
...
| Блок кода |
|---|
[[outputs.http]]
url = "http://localhost:8429/api/v1/import/prometheus"
data_format = "prometheus" |
...
| Блок кода |
|---|
sudo docker compose down peeper-telegraf |
При установке Peeper Client на сервера с ECCM или SoftWLC необходимо распаковать архив с Peeper в дирректорию, откуда происходила установка SoftWLC или ECCM, чтобы установочные файлы Peeper оказались на одном уровне с папками "softwlc" или "eccm".
Peeper Client может быть установлен на сервер с Ubuntu без развернутых на нем приложений Элтекс для мониторинга только Linux и Docker. Тогда команда установки Peeper Client будет такой:
| Блок кода |
|---|
sudo ./setup.sh -i none |
При запуске Peeper Client предложит переопределить значение Hostname сервера, под которым данный хост будет идентифицирован на стороне Peeper Server. Можно нажать Enter и тогда будет использовано имя Hostname сервера или можно ввести новое имя, удобное администратору для идентификации хоста среди остальных.
Особенности установки Peeper Client для SoftWLC
Для корректного получения метрик от сервисов SoftWLC необходимо перезапустить SoftWLC с дополнительным файлом compose.yml.
Скопируйте файл compose.yml в директорию с docker-compose.yml, из которого вы устанавливали SoftWLC:
| Блок кода |
|---|
docker compose -f docker-compose.yml stop
sudo docker -f docker-compose.yml -f compose.yml up -d |
Особенности установки Peeper Client для ECCM
Для запуска необходимо:
- скачать compose.yml
- скачать обновленный compose-tools.sh
Подготовка:
| Блок кода | ||
|---|---|---|
| ||
# Создайте директорию peeper внутри eccm и скопируйте в нее файл compose.yml:
mkdir eccm/2.1/eccm/peeper
cp ~/Downloads/compose.yml eccm/2.1/eccm/peeper
# Сделайте бэкап предыдущей версии compose-tools.sh:
cp eccm/2.1/compose-tools.sh eccm/2.1/compose-tools.sh.bak
# Заменить файл compose-tools.sh его обновленной версией:
cp ~/Downloads/compose-tools.sh eccm/2.1/compose-tools.sh |
Запуск:
| Примечание |
|---|
Обратите внимание на расположение ключей: ключ ` |
...
| language | bash |
|---|
...
Графический интерфейс
Графический интерфейс представляет из себя GUI Grafana, доступный по адресу: https://<адрес сервера>
...
Для получения информации о каждом графике в Дашборде наведите курсор на иконку i над графиком. Отобразится текстовая подсказка с информацией по данному графику.
Troubleshooting
Проверка доступности метрик приложения для контейнера peeper-agent
...
.
...
eltex-ems-core — имя docker-контейнера приложения, отдающего метрики;
9091 — порт, на котором отдаются метрики (должен быть указан в Labels контейнера приложения);
metrics — путь, на котором отдаются метрики (должен быть указан в Labels контейнера приложения).
WEB-интерфейс peeper-agent для траблшутинга
WEB-интерфейс доступен на порту контейнера peeper-agent :8429
:8429/targets — показывает состояние доступных источников метрик;
:8429/service-discovery — показывает все docker контейнеры, обнаруженные Autodiscovery;
:8429/config — конфигурация peeper-agent.
WEB-интерфейс peeper-metrics для траблшутинга
WEB-интерфейс доступен по URL: https://<IP Peeper Server>/metrics/ (обратите внимание на последний / !)
/metrics/vmui/ — предоставляет аналог Prometheus WEB. Меню Explore Prometheus Metrics позволяет просмотреть все полученные метрики. Чтобы посмотреть метрики, полученные от конкретного приложения контейнера, можно отфильтровать их по имени job, указанной в Labels контейнеров.
Ошибка пересечения сетей
В случае возникновения подобной ошибки:
|
необходимо отредактировать в compose.yml системы Peeper номер подсети, т. к. он пересекается с одной из подсетей уже запущенного контейнера на сервере..env файл и указать значение переменной PEEPER_EXTERNAL_MODE="true" и заново ввести команду установки Peeper Client