Skip to content

Add healthcheck endpoint #90

@oto-macenauer-absa

Description

@oto-macenauer-absa

Background

As of now there are only e2e tests run once a day to monitor if the service runs, so outages between runs can go undetected. The service should include a lightweight healthcheck endpoint to enable integration with monitoring systems, surface liveness/readiness status, and provide faster alerting.

Feature

Expose an authenticated or IP-restricted HTTP endpoint that returns the service status (dependencies reachable, configuration loaded, migrations applied) with clear success/failure semantics for monitoring probes.

Example [Optional]

GET /internal/health returns { "status": "ok", "uptime_seconds": 12345 } when all checks pass, or { "status": "degraded", "db": "unreachable" } with a 503 when a dependency is down.

Proposed Solution [Optional]

Solution Ideas:
1) Add a dedicated controller/route that aggregates quick dependency checks (database, message broker, configuration store) with reasonable timeouts.
2) Include unit/integration tests plus a lightweight synthetic probe that can be reused by CI or staging environments.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions