Mercurial > prosody-modules

comparison mod_prometheus/README.markdown @ 3315:bbf20293bc43

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_prometheus: Add more documentation.
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Wed, 12 Sep 2018 18:54:49 +0200
parents 07a2ba55de4d
children 39ec478a752e
comparison
equal deleted inserted replaced
3314:ab67f222d88b 3315:bbf20293bc43
1 --- 1 ---
2 labels:
3 - Statistics
2 summary: Implementation of the Prometheus protocol 4 summary: Implementation of the Prometheus protocol
3 ... 5 ...
4 6
5 Summary 7 Description
6 ======= 8 ===========
7 9
8 This module implements the Prometheus reporting protocol, allowing you 10 This module implements the Prometheus reporting protocol, allowing you
9 to collect statistics directly from Prosody into Prometheus. 11 to collect statistics directly from Prosody into Prometheus.
10 12
11 See the [Prometheus documentation][prometheusconf] on the format for 13 See the [Prometheus documentation][prometheusconf] on the format for
12 more information. 14 more information.
13 15
14 [prometheusconf]: https://prometheus.io/docs/instrumenting/exposition_formats/ 16 [prometheusconf]: https://prometheus.io/docs/instrumenting/exposition_formats/
17
18 Configuration
19 =============
20
21 mod\_prometheus itself doesn’t have any configuration option, but it
22 requires Prosody’s [internal statistics
23 provider](https://prosody.im/doc/statistics#built-in_providers) to be
24 enabled. You may also want to change the default collection interval
25 to the one your statistics consumer is using.
26
27 ```lua
28 statistics = "internal"
29 statistics_interval = 15 -- in seconds
30 ```
31
32 See also the documentation of Prosody’s [HTTP
33 server](https://prosody.im/doc/http), since Prometheus is an HTTP
34 protocol that is how you can customise its URL. The default one being
35 http://localhost:5280/metrics
36
37 Compatibility
38 =============
39
40 ------- -------------
41 trunk Works
42 0.10 Works
43 0.9 Does not work
44 ------- -------------