view mod_host_status_check/README.markdown @ 4954:e8a487c42b36 default tip

merge upstream
author Goffi <>
date Sat, 28 May 2022 16:43:04 +0200
parents 2a16a6c67288
line wrap: on
line source

labels: Stage-Beta
summary: Host status check


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).


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 ""
   modules_enabled = { "host_status_check" }


Works with Prosody 0.9.x and later.