Mercurial > prosody-modules
comparison mod_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 |
| parents | |
| children | 42eafc1c61d9 |
comparison
equal
deleted
inserted
replaced
| 2218:0ca0fdad3b2c | 2219:5fcf9d558250 |
|---|---|
| 1 --- | |
| 2 labels: Stage-Beta | |
| 3 description: Host status check | |
| 4 ... | |
| 5 | |
| 6 Introduction | |
| 7 ============ | |
| 8 | |
| 9 This module allows you to monitor the state of hosts and components in your Prosody server. For example, | |
| 10 it will track whether components are connected and (if the component supports it) listen for heartbeats | |
| 11 sent by the component to indicate that it is functioning. | |
| 12 | |
| 13 This module does not expose any interface to access the status information itself. See mod\_http\_host\_status\_check | |
| 14 for a module that allows you to access host status information over HTTP(S). | |
| 15 | |
| 16 Configuration | |
| 17 ============= | |
| 18 | |
| 19 There are no configuration options for this module. | |
| 20 | |
| 21 You should enable it on every host that you want to monitor, by adding it to modules\_enabled. Note | |
| 22 that to monitor components, adding to the global modules\_enabled list will not suffice - you will | |
| 23 need to add it to the component's own modules\_enabled, like this: | |
| 24 | |
| 25 ``` {.lua} | |
| 26 Component "mycomponent.example.com" | |
| 27 modules_enabled = { "host_status_check" } | |
| 28 ``` | |
| 29 | |
| 30 Compatibility | |
| 31 ============= | |
| 32 | |
| 33 Works with Prosody 0.9.x and later. |