diff options
| author | rinpatch <rinpatch@sdf.org> | 2020-03-08 10:38:35 +0000 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2020-03-08 10:38:35 +0000 |
| commit | e8493431bfc16977e43715bf8bdb09ac46580028 (patch) | |
| tree | 2e1a0068583ca62870a15590c4ccba237999f51a /docs/API/prometheus.md | |
| parent | 42f76306e7fe69fc51be00285a4fef8569f54989 (diff) | |
| parent | e7c49d51d724680c1f19888ea409687733753c7b (diff) | |
| download | pleroma-e8493431bfc16977e43715bf8bdb09ac46580028.tar.gz | |
Merge branch 'release/2.0.0' into 'stable'v2.0.0
Release/2.0.0
See merge request pleroma/pleroma!2273
Diffstat (limited to 'docs/API/prometheus.md')
| -rw-r--r-- | docs/API/prometheus.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/API/prometheus.md b/docs/API/prometheus.md new file mode 100644 index 000000000..19c564e3c --- /dev/null +++ b/docs/API/prometheus.md @@ -0,0 +1,22 @@ +# Prometheus Metrics + +Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library. + +## `/api/pleroma/app_metrics` +### Exports Prometheus application metrics +* Method: `GET` +* Authentication: not required +* Params: none +* Response: JSON + +## Grafana +### Config example +The following is a config example to use with [Grafana](https://grafana.com) + +``` + - job_name: 'beam' + metrics_path: /api/pleroma/app_metrics + scheme: https + static_configs: + - targets: ['pleroma.soykaf.com'] +``` |