annotate mod_listusers/README.markdown @ 5668:ecfd7aece33b

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 b56a635220f6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5412
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
1 ---
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
2 labels:
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
3 - 'Stage-Obsolete'
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
4 ---
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
5
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
6 ::: {.alert .alert-warning}
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
7 As of Prosody 0.12.x, `prosodyctl shell user list HOST` can be used
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
8 instead of this module.
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
9 :::
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
10
2323
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 This module adds a command to `prosodyctl` for listing users.
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 ``` sh
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 prosodyctl mod_listusers
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 ```