Skip to content

Commit e5a2bb4

Browse files
committed
update README
1 parent ac4ef35 commit e5a2bb4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,11 @@ To integrate Telegram events with the Observer, you need the Telegram group chat
6161

6262
Use this ID in the `publishers.yaml` configuration to correctly set up Telegram events.
6363

64+
## Health Endpoints
65+
66+
The Observer exposes HTTP endpoints for health checks, suitable for Kubernetes liveness and readiness probes:
67+
68+
- **Liveness probe**: `GET /live` always returns `200 OK` with body `OK`.
69+
- **Readiness probe**: `GET /ready` returns `200 OK` with body `OK` if the observer is ready, otherwise returns `503 Not Ready`.
70+
71+
By default, these endpoints are served on port 8080. You can use them in your Kubernetes deployment to monitor the application's health.

0 commit comments

Comments
 (0)