Mercurial > prosody-modules

comparison mod_host_status_check/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_host_status_check/README.markdown@694b62d8a82f
children
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - Stage-Beta
4 summary: Host status check
5 ...
6
7 Introduction
8 ============
9
10 This module allows you to monitor the state of hosts and components in your Prosody server. For example,
11 it will track whether components are connected and (if the component supports it) listen for heartbeats
12 sent by the component to indicate that it is functioning.
13
14 This module does not expose any interface to access the status information itself. See [mod\_http\_host\_status\_check]
15 for a module that allows you to access host status information over HTTP(S).
16
17 Configuration
18 =============
19
20 There are no configuration options for this module.
21
22 You should enable it on every host that you want to monitor, by adding it to modules\_enabled. Note
23 that to monitor components, adding to the global modules\_enabled list will not suffice - you will
24 need to add it to the component's own modules\_enabled, like this:
25
26 ``` {.lua}
27 Component "mycomponent.example.com"
28 modules_enabled = { "host_status_check" }
29 ```
30
31 Compatibility
32 =============
33
34 Works with Prosody 0.9.x and later.