From ddf5b3267d98b12845733cf48d48f4e07f6962ce Mon Sep 17 00:00:00 2001
From: Tom Teichler <tom.teichler@teckids.org>
Date: Wed, 11 Nov 2020 21:42:24 +0100
Subject: [PATCH] Add admin docs about monitoring.

---
 docs/admin/04_monitoring.rst | 39 ++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 docs/admin/04_monitoring.rst

diff --git a/docs/admin/04_monitoring.rst b/docs/admin/04_monitoring.rst
new file mode 100644
index 000000000..1b80a43be
--- /dev/null
+++ b/docs/admin/04_monitoring.rst
@@ -0,0 +1,39 @@
+Monitoring
+##########
+
+Prometheus
+**********
+
+AlekSIS provides a metric endpoint at `/metrics`, so you can scrape metrics in
+your Prometheus instance.
+
+Available metrics
+=================
+
+The exporter provides metrics about responses and requests, e.g.  statistics
+about response codes, request latency and requests per view.  It also
+provides data about database operations.
+
+Prometheus config to get metrics
+================================
+
+To get metrics of your AlekSIS instance, just add the following to your
+`prometheus.yml`::
+
+  - job_name: aleksis
+    static_configs:
+      - targets: ['my.aleksis-instance.com']
+    metrics_path: /metrics
+
+
+Grafana
+*******
+
+Visualise metrics with Grafana
+==============================
+
+If you want to visualise your AlekSIS metrics with Grafana, you can use one
+of the public available Grafana dashboards, for example the following one,
+or just write your own.
+
+https://grafana.com/grafana/dashboards/9528
-- 
GitLab