Mercurial > prosody-modules

annotate mod_pubsub_stats/README.markdown @ 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 f1a63271dcfc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4451
f1a63271dcfc Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents: 3409
diff changeset
1 ---
f1a63271dcfc Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents: 3409
diff changeset
2 labels:
f1a63271dcfc Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents: 3409
diff changeset
3 - 'Statistics'
f1a63271dcfc Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents: 3409
diff changeset
4 ...
f1a63271dcfc Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents: 3409
diff changeset
5
3409
1900280e2a90 mod_pubsub_stats/README: Link to docs for Prosodys statistics
Kim Alvefur <zash@zash.se>
parents: 3156
diff changeset
6 This module publishes data from [Prosody's `internal` statistics][doc:statistics]
1900280e2a90 mod_pubsub_stats/README: Link to docs for Prosodys statistics
Kim Alvefur <zash@zash.se>
parents: 3156
diff changeset
7 into a PubSub node in [XEP-0039] format.
3156
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 The node defaults to `stats` but can be changed with the option
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 `pubsub_stats_node`.
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 ``` lua
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 Component "pubsub.example.com" "pubsub"
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 modules_enabled = {
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 "pubsub_stats";
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 }
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 pubsub_stats_node = "statistics"
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 ```