Mercurial > prosody-modules
view mod_http_health/README.md @ 5787:e79f9dec35c0
mod_c2s_conn_throttle: Reduce log level from error->info
Our general policy is that "error" should never be triggerable by remote
entities, and that it is always about something that requires admin
intervention. This satisfies neither condition.
The "warn" level can be used for unexpected events/behaviour triggered by
remote entities, and this could qualify. However I don't think failed auth
attempts are unexpected enough.
I selected "info" because it is what is also used for other notable session
lifecycle events.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Thu, 07 Dec 2023 15:46:50 +0000 |
parents | 09233b625cb9 |
children |
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 } ``` ## Access control By default only access via localhost is allowed. This can be adjusted with `http_health_allow_ips`. The following example shows the default: ``` http_health_allow_ips = { "::1"; "127.0.0.1" } ``` Access can also be granted to one IP range via CIDR notation: ``` http_health_allow_cidr = "172.17.2.0/24" ``` The default for `http_health_allow_cidr` is empty. # 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