Mercurial > prosody-modules

comparison mod_measure_modules/README.md @ 5668:ecfd7aece33b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents
children
comparison
equal deleted inserted replaced
5667:9bcd257dea4e 5668:ecfd7aece33b
1 # Introduction
2
3 This module reports [module status priorities][doc:developers:moduleapi#logging-and-status] as metrics, which are a kind of persistent log messages
4 indicating whether the module is functioning properly.
5
6 This concept was introduced in [Prosody 0.12.0][doc:release:0.12.0#api] and is not used extensively yet, primarily for reporting failure to load
7 modules or e.g. [mod_component] not being connected to its external component yet.
8
9 Besides using this to report problems, this metric could also be used to count how many modules are loaded or monitor for when critical modules aren't
10 loaded at all.
11
12 # Configuration
13
14 After installing, enable by adding to [`modules_enabled`][doc:modules_enabled] like many other modules:
15
16 ``` lua
17 -- in the global section
18 modules_enabled = {
19 -- Other globally enabled modules here...
20 "http_openmetrics";
21 "measure_modules"; -- add
22 }
23 ```
24
25 # Example OpenMetrics
26
27 ``` openmetrics
28 # HELP prosody_module_status Prosody module status
29 # UNIT prosody_module_status
30 # TYPE prosody_module_status gauge
31 prosody_module_status{host="example.org",module="message"} 0
32 prosody_module_status{host="example.org",module="presence"} 0
33 prosody_module_status{host="groups.example.org",module="muc"} 0
34 ```
35
36 # Details
37
38 The priorities are reported as the following values:
39
40 0
41 : `core` - no problem, nothing to report
42
43 1
44 : `info` - no problem, but a module had something important to say
45
46 2
47 : `warn` - something is not right
48
49 3
50 : `error` - something has gone wrong
51
52 Status changes are generally also reported in Prosodys logs, so look there for details.
53
54 # See also
55
56 - [mod_http_status] provides all module status details as JSON via HTTP