diff options
| author | feld <feld@feld.me> | 2019-04-06 14:51:46 +0000 |
|---|---|---|
| committer | feld <feld@feld.me> | 2019-04-06 14:51:46 +0000 |
| commit | 9aeac7dccac802073977c8149b2dda1f0ce07226 (patch) | |
| tree | fd7aa3985f2f30397ed187ef5d6d7e1625d5e0a5 /docs/api/prometheus.md | |
| parent | 3c5daa0235aaf47eeeda557fd677e3604cb7d701 (diff) | |
| parent | b395aebf2489f44bdb1a9c4905a51f0f26bf5fab (diff) | |
| download | pleroma-9aeac7dccac802073977c8149b2dda1f0ce07226.tar.gz pleroma-9aeac7dccac802073977c8149b2dda1f0ce07226.zip | |
Merge branch 'feature/prometheus' into 'develop'
Upstream: Metrics and debugging
See merge request pleroma/pleroma!1020
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'] +``` |