DevOpsTools/MessageGateway
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b1e2f7fd2215d6c42e5b2a2a411bdbcc412cb420
MessageGateway/docs/api/health.md
Sergey Antropov b90def35ed Initial commit: Message Gateway project 
- FastAPI приложение для отправки мониторинговых алертов в мессенджеры
- Поддержка Telegram и MAX/VK
- Интеграция с Grafana, Zabbix, AlertManager
- Автоматическое создание тикетов в Jira
- Управление группами мессенджеров через API
- Декораторы для авторизации и скрытия эндпоинтов
- Подробная документация в папке docs/

Автор: Сергей Антропов
Сайт: https://devops.org.ru
2025-11-12 20:25:11 +03:00

1.5 KiB
Raw Blame History

API для проверки здоровья

Проверка здоровья и готовности приложения

GET /api/v1/health

Пример ответа (здорово):

{
  "status": "healthy",
  "state": "online",
  "telegram_bot_configured": true,
  "groups_config_available": true
}

Пример ответа (не готово):

{
  "status": "not_ready",
  "state": "online",
  "checks": {
    "telegram_bot_configured": false,
    "groups_config_available": true
  }
}

Примечания

  • Не требует аутентификации
  • Возвращает 503 если приложение не готово
  • Используется Kubernetes для liveness и readiness probes
  • Настройте liveness и readiness probes в kubernetes.yaml
  • Приложение считается готовым, если все проверки пройдены

Проверки

  • telegram_bot_configured - наличие токена Telegram (TELEGRAM_BOT_TOKEN)
  • groups_config_available - доступность файла конфигурации групп (config/groups.json)

Использование в Kubernetes

Настройте liveness и readiness probes в kubernetes.yaml:

livenessProbe:
  httpGet:
    path: /api/v1/health
    port: 8000
  initialDelaySeconds: 30
  periodSeconds: 10

readinessProbe:
  httpGet:
    path: /api/v1/health
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 5