prosody-modules
7c264a2cb970
mod_http_health/README.md
Software / code / prosody-modules
File
mod_http_health/README.md @ 5707:7c264a2cb970
mod_storage_ejabberdsql_readonly: Don't use MySQL-specific syntax
util.sql should take care of transformation when MySQL is in use.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Mon, 30 Oct 2023 12:28:12 +0000 |
| parent | 5690:9bcd257dea4e |
| child | 5712:09233b625cb9 |
line wrap: on
line source
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
