annotate mod_query_client_ver/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 9842979f3034
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2994
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # Introduction
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module sends a [version query][xep0092] to clients when they
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 connect, and logs the response, allowing statistics of client usage to
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 be recorded.
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 Note that since this is per connection, there will be a bias towards
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 mobile clients on bad connections.
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 ## Example
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 info Running Running Swift version 4.0