diff options
| author | Egor Kislitsyn <egor@kislitsyn.com> | 2019-04-11 15:51:52 +0700 |
|---|---|---|
| committer | Egor Kislitsyn <egor@kislitsyn.com> | 2019-04-11 15:51:52 +0700 |
| commit | 0f2f7d2cec8297b1b5645643d7584cde561ce628 (patch) | |
| tree | aa618de9dc399de2e3abf37ad9ecf66d8cb9761f /docs/api/prometheus.md | |
| parent | 22ac2288be498bd6a5a6fefe2dc6d2e260a8dc39 (diff) | |
| parent | e5d553aa45ffa218b0695d7976f012bfc1dcbafe (diff) | |
| download | pleroma-0f2f7d2cec8297b1b5645643d7584cde561ce628.tar.gz | |
Merge remote-tracking branch 'pleroma/develop' into feature/disable-account
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'] +``` |