diff options
| author | Alex S <alex.strizhakov@gmail.com> | 2019-05-01 12:29:33 +0700 |
|---|---|---|
| committer | Alex S <alex.strizhakov@gmail.com> | 2019-05-01 12:29:33 +0700 |
| commit | bdfa3a6fa87f95e93aa853ec4961645215f31221 (patch) | |
| tree | 467b9dd762c9878541e34f2b38a1c58e387c8f2c /docs/api/prometheus.md | |
| parent | 97b35e00b049c8f908484163b5ffdbcb55db7867 (diff) | |
| parent | 77690b9d03facf74483e3379f72b5b51c9f1bd4e (diff) | |
| download | pleroma-bdfa3a6fa87f95e93aa853ec4961645215f31221.tar.gz | |
Merging with develop
Conflicts:
lib/pleroma/web/activity_pub/transmogrifier.ex
lib/pleroma/user.ex
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'] +``` |