Page MenuHomePhorge
Files F85629808

No OneTemporary
Actions

Size
1 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/docs/docs/administration/monitoring.md b/docs/docs/administration/monitoring.md
index 9233fbe34..b7a748731 100644
--- a/docs/docs/administration/monitoring.md
+++ b/docs/docs/administration/monitoring.md
@@ -1,33 +1,45 @@
# Monitoring Akkoma
If you run akkoma, you may be inclined to collect metrics to ensure your instance is running smoothly,
and that there's nothing quietly failing in the background.
-To facilitate this, akkoma exposes prometheus metrics to be scraped.
+To facilitate this, akkoma exposes a dashboard and prometheus metrics to be scraped.
## Prometheus
See: [export\_prometheus\_metrics](../../configuration/cheatsheet#instance)
To scrape prometheus metrics, we need an oauth2 token with the `admin:metrics` scope.
consider using [constanze](https://akkoma.dev/AkkomaGang/constanze) to make this easier -
```bash
constanze token --client-app --scopes "admin:metrics" --client-name "Prometheus"
```
or see `scripts/create_metrics_app.sh` in the source tree for the process to get this token.
Once you have your token of the form `Bearer $ACCESS_TOKEN`, you can use that in your prometheus config:
```yaml
- job_name: akkoma
scheme: https
authorization:
credentials: $ACCESS_TOKEN # this should have the bearer prefix removed
metrics_path: /api/v1/akkoma/metrics
static_configs:
- targets:
- example.com
```
+
+## Dashboard
+
+Administrators can access a live dashboard under `/phoenix/live_dashboard`
+giving an overview of uptime, software versions, database stats and more.
+
+The dashboard also includes a variation of the prometheus metrics, however
+they do not exactly match due to respective limitations of the dashboard
+and the prometheus exporter.
+Even more important, the dashboard collects metrics locally in the browser
+only while the page is open and cannot give a view on their past history.
+For proper monitoring it is recommended to set up prometheus.

File Metadata

Mime Type
text/x-diff
Expires
Sun, Aug 9, 5:37 AM (1 d, 13 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1724254
Default Alt Text
(1 KB)

Event Timeline