diff options
| author | Ivan Tashkinov <ivantashkinov@gmail.com> | 2019-10-06 09:30:49 +0300 |
|---|---|---|
| committer | Ivan Tashkinov <ivantashkinov@gmail.com> | 2019-10-06 09:30:49 +0300 |
| commit | f459aabdfafa990b33610438650f882ccac072d2 (patch) | |
| tree | e5bfcb4f8fc7c2dd06e08f90b3a841c4f9ad759a /docs/API/prometheus.md | |
| parent | 6ffa2b5f661c2db424334c6fb5de6f4d1bfeb745 (diff) | |
| parent | 9e34919dcdbeedf8eb623dc86b05f63ef44d8859 (diff) | |
| download | pleroma-f459aabdfafa990b33610438650f882ccac072d2.tar.gz | |
Merge remote-tracking branch 'remotes/upstream/develop' into 1260-rate-limited-auth-actions
# Conflicts:
# CHANGELOG.md
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'] +``` |