Отдаёт в формате prometheus метрики по состоянию заведённых в staytus сервисов.
# HELP service_status Service Status
# TYPE service_status gauge
service_status{service_permalink="web-application",service_status="ok"} 0.0
service_status{service_permalink="web-application",service_status="minor"} 1.0
service_status{service_permalink="web-application",service_status="major"} 0.0
service_status{service_permalink="web-application",service_status="maintenance"} 0.0
service_status{service_permalink="api",service_status="ok"} 0.0
service_status{service_permalink="api",service_status="minor"} 0.0
service_status{service_permalink="api",service_status="major"} 0.0
service_status{service_permalink="api",service_status="maintenance"} 1.0
service_status{service_permalink="public-website",service_status="ok"} 0.0
service_status{service_permalink="public-website",service_status="minor"} 0.0
service_status{service_permalink="public-website",service_status="major"} 1.0
service_status{service_permalink="public-website",service_status="maintenance"} 0.0
service_status{service_permalink="customer-support",service_status="ok"} 1.0
service_status{service_permalink="customer-support",service_status="minor"} 0.0
service_status{service_permalink="customer-support",service_status="major"} 0.0
service_status{service_permalink="customer-support",service_status="maintenance"} 0.0
# HELP staytus_health Staytus Health
# TYPE staytus_health gauge
staytus_health{staytus_health="healthy"} 1.0
staytus_health{staytus_health="unhealthy"} 0.0
service_statusсодержит 2 лэйбла:service_permalink(уникальный человекочитаемый идентификатор сервиса из staytus) иservice_status(одно из 4х типов состояний сервиса:ok,minor,majorилиmaintenance) в качестве значения может быть 1 (означает, что сервисservice_permalinkпребывает в состоянииservice_status) или 0 (не пребывает в указанном состоянии);staytus_healthсодержит лэйблstaytus_health(принимает 2 значения:healthy, если staytus нормально взаимодействует с экспортером, илиunhealthy, если при взаимодействии возникают ошибки).
Экспортер принимает конфигурацию через переменные окружения.
| Переменная | Значение по умолчанию | Описание |
|---|---|---|
| POLLING_INTERVAL_SECONDS | 2 | интервал опроса staytus |
| EXPORTER_PORT | 9877 | порт, на котором отдаются метрики |
| STAYTUS_API_URL | http://localhost:8787/ | url staytus, по которому экспортер запрашивает данные о сервисах |
| STAYTUS_API_TOKEN | - | обязательный токен API staytus |
| STAYTUS_API_SECRET | - | обязательный секрет от токена |
| DEBUG | False | Включение дебажных логов (что бы включить, задать "True", "true", "1" или "yes") |
Создать виртуальное окружение python:
python3 -m venv venvУстановить зависимости:
./venv/bin/python3 -m pip install -r src/requirements.txt -r tests/requirements.txtПоднять локальный staytus:
docker-compose upВ первый раз придётся пройти wizard настройки staytus в его webUI. Какими значениями заполнять поля большого значения для целей локальной разработки не имеет. По итогу нужно обязательно выпустить токен доступа к API и забрать значение токена и его секрета.
Подготовить файл с переменными окружения:
cat .env.sample > .envПосле руками вписать STAYTUS_API_TOKEN и STAYTUS_API_SECRET, которые забрали из webUI.
Нижеперечисленные шаги дублируются в CI.
Проверить, что контейнер с экспортером собирается и работает
docker-compose -f docker-compose.yaml -f docker-compose.exporter.yaml up --buildПрогнать unit-тесты:
./venv/bin/python3 -m pytest testsОтформатировать код и импорты:
./venv/bin/python3 -m isort src
./venv/bin/python3 -m black srcПроверить код pylint и mypy:
./venv/bin/python3 -m pylint src
./venv/bin/python3 -m mypy src