diff options
| author | rinpatch <rinpatch@sdf.org> | 2019-10-03 15:43:03 +0000 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2019-10-03 15:43:03 +0000 |
| commit | 4fe2af3b2d6b0701de2ae88f9932e4b6039ced11 (patch) | |
| tree | 95dfb9f82ee8a3259f0f8d1d6ce27cc562819fb6 /docs/API/prometheus.md | |
| parent | c5e937b156ea1f8f96ade7d9104fc2c5fd1dd9cd (diff) | |
| parent | b2f2012a4f34cfe8151e62d045f0eab3d165791a (diff) | |
| download | pleroma-4fe2af3b2d6b0701de2ae88f9932e4b6039ced11.tar.gz | |
Merge branch 'mkdocs-migration-prep' into 'develop'
MkDocs migration preparation
See merge request pleroma/pleroma!1774
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'] +``` |