diff options
| author | lain <lain@soykaf.club> | 2019-05-04 15:00:45 +0200 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2019-05-04 15:00:45 +0200 |
| commit | 6ad8ddfd290f0239956874ccc9dc181167e84647 (patch) | |
| tree | 83c5b59d055d3b98c1ebbba66351b7cbdb49bd99 /docs/api/prometheus.md | |
| parent | 629ad1766ce5da434bf095f6baa81a460334e1b2 (diff) | |
| parent | d089ff24600455fefc17e91807c61ddc61ba107a (diff) | |
| download | pleroma-6ad8ddfd290f0239956874ccc9dc181167e84647.tar.gz | |
Merge remote-tracking branch 'origin/develop' into feature/bbs
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'] +``` |