aboutsummaryrefslogtreecommitdiff
path: root/docs/API/prometheus.md
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 11:43:49 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 11:43:49 +0300
commit06b3bb54c5567fe82ad2a015673fffba667997ee (patch)
tree84bde8abcef86ef398eef0afdc9ae77e5f464bf1 /docs/API/prometheus.md
parent64095961fe490029886cae358683532ea65bf2c0 (diff)
parent9e34919dcdbeedf8eb623dc86b05f63ef44d8859 (diff)
downloadpleroma-06b3bb54c5567fe82ad2a015673fffba667997ee.tar.gz
Merge remote-tracking branch 'remotes/upstream/develop' into 1234-mastodon-2-4-3-oauth-scopes
# Conflicts: # CHANGELOG.md # lib/pleroma/web/mastodon_api/controllers/account_controller.ex # lib/pleroma/web/mastodon_api/controllers/mastodon_api_controller.ex # lib/pleroma/web/router.ex
Diffstat (limited to 'docs/API/prometheus.md')
-rw-r--r--docs/API/prometheus.md22
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']
+```