diff options
| author | Mark Felder <feld@FreeBSD.org> | 2019-04-04 12:19:31 -0500 |
|---|---|---|
| committer | Mark Felder <feld@FreeBSD.org> | 2019-04-04 12:19:31 -0500 |
| commit | 5564cd421dfc706208df0b7447b0d692dffe052e (patch) | |
| tree | 57be4d2604521ab7e17bab98a23817be03f11e58 | |
| parent | 0b5c818cb78b8c23fb2ba7ef372d0688ea9f36b7 (diff) | |
| download | pleroma-5564cd421dfc706208df0b7447b0d692dffe052e.tar.gz | |
Document Prometheus
| -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'] +``` |