Mercurial > prosody-modules
comparison mod_http_health/README.md @ 5667:9bcd257dea4e
mod_http_health: Provide a health check HTTP endpoint
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which was simplified to produce this module.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 06 Oct 2023 16:49:57 +0200 |
| parents | |
| children | 09233b625cb9 |
comparison
equal
deleted
inserted
replaced
| 5666:e5ad3f1f48bd | 5667:9bcd257dea4e |
|---|---|
| 1 Simple module adding an endpoint meant to be used for health checks. | |
| 2 | |
| 3 # Configuration | |
| 4 | |
| 5 After installing, enable by adding to [`modules_enabled`][doc:modules_enabled] like many other modules: | |
| 6 | |
| 7 ``` lua | |
| 8 -- in the global section | |
| 9 modules_enabled = { | |
| 10 -- Other globally enabled modules here... | |
| 11 "http_health"; -- add | |
| 12 } | |
| 13 ``` | |
| 14 | |
| 15 # Details | |
| 16 | |
| 17 Adds a `http://your.prosody.example:5280/health` endpoint that returns either HTTP status code 200 when all appears to be good or 500 when any module | |
| 18 [status][doc:developers:moduleapi#logging-and-status] has been set to `error`. | |
| 19 | |
| 20 # See also | |
| 21 | |
| 22 - [mod_measure_modules] provides module statues via OpenMetrics | |
| 23 - [mod_http_status] provides all module status details as JSON via HTTP |