Toutsu/GmRelayBot
1
1
Fork 0
Code Issues 18 Pull Requests 1 Actions Packages Projects Releases 85 Wiki Activity

infra: добавить health check endpoints в Bot и Web #58

New Issue
Closed
opened 2026-05-12 13:25:48 +03:00 by Toutsu · 1 comment
Toutsu commented 2026-05-12 13:25:48 +03:00
Owner
Copy Link
Copy Source

Проблема

Ни GmRelay.Bot, ни GmRelay.Web не экспонируют endpoint /health (или аналогичный TCP/HTTP probe). Docker Compose не может определить, что сервис упал, и не перезапустит контейнер автоматически. При падении бота пользователи не получат уведомлений, а Web Dashboard станет недоступен без алертинга.

Критичность

  • Невозможна автоматическая реакция на сбои (restart policy бесполезен без health check).
  • Нет возможности настроить внешний мониторинг (Uptime Kuma, Pingdom и т.д.).

Предлагаемое решение

Web (GmRelay.Web)

  • Добавить middleware /health → 200 OK + JSON { "status": "healthy", "timestamp": "..." }.
  • Дополнительно проверять доступность PostgreSQL ( readiness probe ): если БД недоступна — 503.

Bot (GmRelay.Bot)

  • Добавить встроенный lightweight HTTP-сервер (например, HttpListener или ASP.NET Core minimal API) на отдельном порту (например, 8081).
  • Endpoint /health возвращает 200, если бот запущен и Webhook/Long-polling активен.

compose.yaml

  • Добавить healthcheck секции для bot и web сервисов с interval, timeout, retries.

Критерии приёмки

  • curl http://localhost:8080/health (Web) возвращает 200 и JSON.
  • curl http://localhost:8081/health (Bot) возвращает 200.
  • docker compose ps показывает статус healthy для обоих сервисов.
  • При отключении PostgreSQL Web возвращает 503 на /health.

Связь

Этап: Подготовка к production

## Проблема Ни `GmRelay.Bot`, ни `GmRelay.Web` не экспонируют endpoint `/health` (или аналогичный TCP/HTTP probe). Docker Compose не может определить, что сервис упал, и не перезапустит контейнер автоматически. При падении бота пользователи не получат уведомлений, а Web Dashboard станет недоступен без алертинга. ## Критичность - Невозможна автоматическая реакция на сбои (restart policy бесполезен без health check). - Нет возможности настроить внешний мониторинг (Uptime Kuma, Pingdom и т.д.). ## Предлагаемое решение ### Web (`GmRelay.Web`) - Добавить middleware `/health` → `200 OK` + JSON `{ "status": "healthy", "timestamp": "..." }`. - Дополнительно проверять доступность PostgreSQL ( readiness probe ): если БД недоступна — `503`. ### Bot (`GmRelay.Bot`) - Добавить встроенный lightweight HTTP-сервер (например, `HttpListener` или ASP.NET Core minimal API) на отдельном порту (например, `8081`). - Endpoint `/health` возвращает `200`, если бот запущен и Webhook/Long-polling активен. ### `compose.yaml` - Добавить `healthcheck` секции для `bot` и `web` сервисов с `interval`, `timeout`, `retries`. ## Критерии приёмки - [ ] `curl http://localhost:8080/health` (Web) возвращает 200 и JSON. - [ ] `curl http://localhost:8081/health` (Bot) возвращает 200. - [ ] `docker compose ps` показывает статус `healthy` для обоих сервисов. - [ ] При отключении PostgreSQL Web возвращает 503 на `/health`. ## Связь Этап: **Подготовка к production**
Toutsu added this to the Подготовка к production milestone 2026-05-12 13:25:48 +03:00
Toutsu added the priority:p0 label 2026-05-12 13:25:48 +03:00
Toutsu commented 2026-05-15 11:57:20 +03:00
Author
Owner
Copy Link
Copy Source

Реализовано в PR #63 и выпущено в v2.0.0.

Итоговый вариант согласован с PR #79: вместо отдельного 1.16.0 health checks вошли в общий релиз 2.0.0 на merge-коммите 7cecb72.

Проверки:

  • PR #63 after version reconciliation: Gitea Actions run #183 — success
  • deploy main: Gitea Actions run #182 — success
Реализовано в PR #63 и выпущено в [v2.0.0](https://git.codeanddice.ru/Toutsu/GmRelayBot/releases/tag/v2.0.0). Итоговый вариант согласован с PR #79: вместо отдельного `1.16.0` health checks вошли в общий релиз `2.0.0` на merge-коммите `7cecb72`. Проверки: - PR #63 after version reconciliation: Gitea Actions run #183 — success - deploy `main`: Gitea Actions run #182 — success
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area:bot
Telegram bot and worker logic
 area:data
Database schema, migrations and persistence model
 area:discord
Discord bot service and Discord adapter
 area:infra
Infrastructure, runtime and deployment
 area:miniapp
Telegram Mini App dashboard
 area:platform
Platform-neutral abstractions and adapter boundaries
 area:shared
Shared domain and rendering contracts
 area:web
Blazor web dashboard
 in-progress
В работе (issue взят агентом)
 next-up
Recommended immediate backlog
 pending-approval
Ждёт согласования плана решения
 platform:discord
Discord-specific behavior or adapter work
 platform:multi
Cross-platform or platform-neutral work
 platform:telegram
Telegram-specific behavior or adapter work
 priority:p0
Critical priority
 priority:p0
Блокирующий приоритет: задача должна быть выполнена до признания решения production-ready
 priority:p1
High priority
 priority:p2
Medium priority
 priority:p3
Lower priority
 security
Security-sensitive work
 type:bug
Bug fix or corrective work
 type:chore
Maintenance and supporting work
 type:feature
New product functionality
 type:refactor
Structural change without direct feature growth
 type:test
Testing and coverage work
No Label priority:p0
Milestone
No items
No Milestone Подготовка к production
Projects
Clear projects
No project
Assignees
Clear assignees
Toutsu
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Toutsu/GmRelayBot#58
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?