Mercurial > prosody-modules
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_http_health/README.md Fri Oct 06 16:49:57 2023 +0200 @@ -0,0 +1,23 @@ +Simple module adding an endpoint meant to be used for health checks. + +# Configuration + +After installing, enable by adding to [`modules_enabled`][doc:modules_enabled] like many other modules: + +``` lua +-- in the global section +modules_enabled = { + -- Other globally enabled modules here... + "http_health"; -- add +} +``` + +# Details + +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 +[status][doc:developers:moduleapi#logging-and-status] has been set to `error`. + +# See also + +- [mod_measure_modules] provides module statues via OpenMetrics +- [mod_http_status] provides all module status details as JSON via HTTP