diff options
| author | lain <lain@soykaf.club> | 2019-10-05 10:42:29 +0200 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2019-10-05 10:42:29 +0200 |
| commit | d9aaea44ff02d6a07d3be0f0675830eb51ac85ef (patch) | |
| tree | ce715c85f98875dd0ddf133f95a071fd40b91335 /docs/API/prometheus.md | |
| parent | 8e83c8423fa846e82103b20798f0cbde676354ff (diff) | |
| parent | 9c47d8571c6c46503d9bb836aea933eda6e9e0a5 (diff) | |
| download | pleroma-d9aaea44ff02d6a07d3be0f0675830eb51ac85ef.tar.gz | |
Merge remote-tracking branch 'origin/develop' into reactions
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'] +``` |