diff options
| author | feld <feld@feld.me> | 2019-10-04 14:16:28 +0000 |
|---|---|---|
| committer | feld <feld@feld.me> | 2019-10-04 14:16:28 +0000 |
| commit | 31e57cd1b34798afb07a8de4c0c95ef3c15e22ed (patch) | |
| tree | 461d3d50b855d080eb17f0946213168a87ac7625 /docs/API/prometheus.md | |
| parent | b8b98ac40f042a8c3d2562edc095f0e1a309760f (diff) | |
| parent | 27110793a7d8e3aa6434bde63a1f687424ae779c (diff) | |
| download | pleroma-31e57cd1b34798afb07a8de4c0c95ef3c15e22ed.tar.gz | |
Merge branch 'develop' into 'fix/extended-nickname-format-default-config'
# 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'] +``` |