Mercurial > prosody-modules

annotate mod_measure_storage/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 f02c0f5e44ac
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2323
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 labels:
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 - 'Stage-Alpha'
3174
f02c0f5e44ac various/README: Add a Statistics label
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
4 - Statistics
2323
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 summary: Measure storage API operations
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 ---
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 Introduction
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 ============
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 This module collects statistics from storage operations.
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 Configuration
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 =============
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 Enable tagged metrics, whatever that is:
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 ``` {.lua}
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 measure_storage_tagged_metric = true
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 ```
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 Compatibility
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 =============
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 Requires 0.10