Mercurial > prosody-modules

view mod_prometheus/README.markdown @ 3673:11ebf1da416b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_webchat_url: Don't save templated value This prevents changing of other settings without touching the webchat URL from saving the template value. Otherwise the URL will still be advertised when configuring members-only or hidden.
author Kim Alvefur <zash@zash.se>
date Tue, 17 Sep 2019 17:22:35 +0200
parents 39ec478a752e
children 313e293f44b3
line wrap: on
line source

---
labels:
- Statistics
summary: Implementation of the Prometheus protocol
...

Description
===========

This module implements the Prometheus reporting protocol, allowing you
to collect statistics directly from Prosody into Prometheus.

See the [Prometheus documentation][prometheusconf] on the format for
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.11    Works
  0.10    Works
  0.9     Does not work
  ------- -------------