Software / code / prosody-modules
Comparison
mod_host_status_heartbeat/README.markdown @ 2219:5fcf9d558250
Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Tue, 28 Jun 2016 22:33:13 +0100 |
| child | 2230:42eafc1c61d9 |
comparison
equal
deleted
inserted
replaced
| 2218:0ca0fdad3b2c | 2219:5fcf9d558250 |
|---|---|
| 1 --- | |
| 2 labels: Stage-Beta | |
| 3 description: Host status heartbeat | |
| 4 ... | |
| 5 | |
| 6 Introduction | |
| 7 ============ | |
| 8 | |
| 9 This module integrates with mod\_host\_status\_check to provide heartbeats at regular intervals. | |
| 10 | |
| 11 The only time you will generally want this, is if you are using mod\_component\_client to run Prosody as | |
| 12 an external component of another Prosody server that has mod\_host\_status\_check loaded and waiting for | |
| 13 heartbeats. | |
| 14 | |
| 15 Alternatively you can run this on the same Prosody host as mod\_http\_status\_check and it will simply | |
| 16 update a variable periodically to indicate that Prosody and timers are functional. | |
| 17 | |
| 18 Configuration | |
| 19 ============= | |
| 20 | |
| 21 The following configuration options are supported: | |
| 22 | |
| 23 ```{.lua} | |
| 24 -- The number of seconds to wait between sending heartbeats | |
| 25 status_check_heartbeat_interval = 5 | |
| 26 | |
| 27 -- Set this to "remote" (the default) if you are using mod_component_client | |
| 28 -- and you want to send a heartbeat to a remote server. Otherwise | |
| 29 -- set it to "local" to send to mod_host_status_check on the same server. | |
| 30 status_check_heartbeat_mode = "remote" | |
| 31 ``` | |
| 32 | |
| 33 Compatibility | |
| 34 ============= | |
| 35 | |
| 36 Works with Prosody 0.9.x and later. |