Mercurial > prosody-modules
view mod_host_status_check/README.markdown @ 5668:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 06 Oct 2023 18:34:39 +0200 |
parents | 2a16a6c67288 |
children | 694b62d8a82f |
line wrap: on
line source
--- labels: Stage-Beta summary: Host status check ... Introduction ============ This module allows you to monitor the state of hosts and components in your Prosody server. For example, it will track whether components are connected and (if the component supports it) listen for heartbeats sent by the component to indicate that it is functioning. This module does not expose any interface to access the status information itself. See [mod\_http\_host\_status\_check] for a module that allows you to access host status information over HTTP(S). Configuration ============= There are no configuration options for this module. You should enable it on every host that you want to monitor, by adding it to modules\_enabled. Note that to monitor components, adding to the global modules\_enabled list will not suffice - you will need to add it to the component's own modules\_enabled, like this: ``` {.lua} Component "mycomponent.example.com" modules_enabled = { "host_status_check" } ``` Compatibility ============= Works with Prosody 0.9.x and later.