This module integrates with mod_host_status_check to provide heartbeats at regular intervals.

The only time you will generally want this, is if you are using mod_component_client to run Prosody as an external component of another Prosody server that has mod_host_status_check loaded and waiting for heartbeats.

Alternatively you can run this on the same Prosody host as mod_http_host_status_check and it will simply update a variable periodically to indicate that Prosody and timers are functional.


The following configuration options are supported:

-- The number of seconds to wait between sending heartbeats
status_check_heartbeat_interval = 5

-- Set this to "remote" (the default) if you are using mod_component_client
-- and you want to send a heartbeat to a remote server. Otherwise
-- set it to "local" to send to mod_host_status_check on the same server.
status_check_heartbeat_mode = "remote"


Works with Prosody 0.9.x and later.


With the plugin installer in Prosody 0.12 you can use:

sudo prosodyctl install --server= mod_host_status_heartbeat

For earlier versions see the documentation for installing 3rd party modules