diff options
| author | Maxim Filippov <colixer@gmail.com> | 2019-10-07 15:41:41 +0300 |
|---|---|---|
| committer | Maxim Filippov <colixer@gmail.com> | 2019-10-07 15:41:41 +0300 |
| commit | 35068baf65f1be9ac4e5ae8d08222244ae823fcc (patch) | |
| tree | 0ed0b88fd100fb3df83400c147ab9a6a88d53c73 /docs/API/prometheus.md | |
| parent | 7aceaa517be7b109a9acc15fb4914535b536b66c (diff) | |
| parent | 0a99f1e8c5551dcf170722e5087a0401b2d907af (diff) | |
| download | pleroma-35068baf65f1be9ac4e5ae8d08222244ae823fcc.tar.gz | |
Merge branch 'develop' into feature/reports-groups-and-multiple-state-update
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'] +``` |