Software / code / prosody-modules
Comparison
mod_http_host_status_check/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: HTTP Host Status Check | |
| 4 ... | |
| 5 | |
| 6 Introduction | |
| 7 ============ | |
| 8 | |
| 9 This module exposes serves over HTTP the information collected by mod\_host\_status\_check and | |
| 10 mod\_host\_status\_heartbeat in a convenient format for automated monitoring tools. | |
| 11 | |
| 12 Configuration | |
| 13 ============= | |
| 14 | |
| 15 mod\_http\_status\_check relies on Prosodys HTTP server and mod\_http for | |
| 16 serving HTTP requests. See [Prosodys HTTP server | |
| 17 documentation](https://prosody.im/doc/http) for information about how to | |
| 18 configure ports, HTTP Host names etc. | |
| 19 | |
| 20 Simply add this module to modules\_enabled for the host you would like to serve it from. | |
| 21 | |
| 22 There is a single configuration option: | |
| 23 | |
| 24 ``` {.lua} | |
| 25 -- The maximum number of seconds that a host can go without sending a heartbeat, | |
| 26 -- before we mark it as TIMEOUT (default: 5) | |
| 27 status_check_heartbeat_threshold = 5; | |
| 28 ``` | |
| 29 | |
| 30 Compatibility | |
| 31 ============= | |
| 32 | |
| 33 Works with Prosody 0.9.x and later. |