Software / code / prosody-modules
Changeset
3315:bbf20293bc43
mod_prometheus: Add more documentation.
| author | Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> |
|---|---|
| date | Wed, 12 Sep 2018 18:54:49 +0200 |
| parents | 3314:ab67f222d88b |
| children | 3316:9d8098f4b652 |
| files | mod_prometheus/README.markdown |
| diffstat | 1 files changed, 32 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_prometheus/README.markdown Mon Sep 10 15:08:09 2018 +0200 +++ b/mod_prometheus/README.markdown Wed Sep 12 18:54:49 2018 +0200 @@ -1,9 +1,11 @@ --- +labels: +- Statistics summary: Implementation of the Prometheus protocol ... -Summary -======= +Description +=========== This module implements the Prometheus reporting protocol, allowing you to collect statistics directly from Prosody into Prometheus. @@ -12,3 +14,31 @@ more information. [prometheusconf]: https://prometheus.io/docs/instrumenting/exposition_formats/ + +Configuration +============= + +mod\_prometheus itself doesn’t have any configuration option, but it +requires Prosody’s [internal statistics +provider](https://prosody.im/doc/statistics#built-in_providers) to be +enabled. You may also want to change the default collection interval +to the one your statistics consumer is using. + +```lua +statistics = "internal" +statistics_interval = 15 -- in seconds +``` + +See also the documentation of Prosody’s [HTTP +server](https://prosody.im/doc/http), since Prometheus is an HTTP +protocol that is how you can customise its URL. The default one being +http://localhost:5280/metrics + +Compatibility +============= + + ------- ------------- + trunk Works + 0.10 Works + 0.9 Does not work + ------- -------------
