diff options
| author | Sadposter <hannah+pleroma@coffee-and-dreams.uk> | 2019-04-10 10:44:54 +0100 |
|---|---|---|
| committer | Sadposter <hannah+pleroma@coffee-and-dreams.uk> | 2019-04-10 10:44:54 +0100 |
| commit | be8350baa2f8c9cf9be3f53ee4a0041dada1386f (patch) | |
| tree | 8414fc2108941ccadd9b9fd4dd37c9d3cf731399 /docs/api/prometheus.md | |
| parent | 589629cf3e1bee9a4f6e92b8456d8614eff73c89 (diff) | |
| parent | c8440b5e0c97c5d5c03e4b99e30a61df6ab95319 (diff) | |
| download | pleroma-be8350baa2f8c9cf9be3f53ee4a0041dada1386f.tar.gz | |
Merge branch 'develop' into feature/user-status-subscriptions
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'] +``` |