diff options
| author | lain <lain@soykaf.club> | 2020-11-04 16:18:11 +0100 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2020-11-04 16:18:11 +0100 |
| commit | bae48c98e32af6c43fa668771c6253f299d4bf8a (patch) | |
| tree | 0ceb2b31a2c65af23039e4074c51c495dd7dd8f8 /docs/API/prometheus.md | |
| parent | 04b7505c75afbaa1f785b2adaf0313e9b0935fab (diff) | |
| parent | 4800ee656bbcd8fe21fe56531123d3a18eccc911 (diff) | |
| download | pleroma-bae48c98e32af6c43fa668771c6253f299d4bf8a.tar.gz pleroma-bae48c98e32af6c43fa668771c6253f299d4bf8a.zip | |
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into alexgleason/pleroma-block-behavior
Diffstat (limited to 'docs/API/prometheus.md')
| -rw-r--r-- | docs/API/prometheus.md | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/docs/API/prometheus.md b/docs/API/prometheus.md index 19c564e3c..a5158d905 100644 --- a/docs/API/prometheus.md +++ b/docs/API/prometheus.md @@ -2,15 +2,37 @@ Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library. +Config example: + +``` +config :prometheus, Pleroma.Web.Endpoint.MetricsExporter, + enabled: true, + auth: {:basic, "myusername", "mypassword"}, + ip_whitelist: ["127.0.0.1"], + path: "/api/pleroma/app_metrics", + format: :text +``` + +* `enabled` (Pleroma extension) enables the endpoint +* `ip_whitelist` (Pleroma extension) could be used to restrict access only to specified IPs +* `auth` sets the authentication (`false` for no auth; configurable to HTTP Basic Auth, see [prometheus-plugs](https://github.com/deadtrickster/prometheus-plugs#exporting) documentation) +* `format` sets the output format (`:text` or `:protobuf`) +* `path` sets the path to app metrics page + + ## `/api/pleroma/app_metrics` + ### Exports Prometheus application metrics + * Method: `GET` -* Authentication: not required +* Authentication: not required by default (see configuration options above) * Params: none -* Response: JSON +* Response: text ## Grafana + ### Config example + The following is a config example to use with [Grafana](https://grafana.com) ``` |