diff options
author | Ivan Tashkinov <ivant.business@gmail.com> | 2019-04-08 12:20:26 +0300 |
---|---|---|
committer | Ivan Tashkinov <ivant.business@gmail.com> | 2019-04-08 12:20:26 +0300 |
commit | bffddf5e31c53d0603de387c61b6011f70785b97 (patch) | |
tree | 97f07fb95346b603307534a34d0ecee5c9b70af1 /docs/api/prometheus.md | |
parent | e3328bc1382315c9067c099995a29db70d9d0433 (diff) | |
parent | b177e1e7f330ff1531be190949db7f75e378a449 (diff) | |
download | pleroma-bffddf5e31c53d0603de387c61b6011f70785b97.tar.gz |
[#923] Merge remote-tracking branch 'remotes/upstream/develop' into twitter_oauth
# Conflicts:
# docs/config.md
# test/support/factory.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'] +``` |