Document Akkoma API #678
1 changed files with 13 additions and 1 deletions
|
@ -3,7 +3,7 @@
|
||||||
If you run akkoma, you may be inclined to collect metrics to ensure your instance is running smoothly,
|
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.
|
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
|
## Prometheus
|
||||||
|
|
||||||
|
@ -31,3 +31,15 @@ Once you have your token of the form `Bearer $ACCESS_TOKEN`, you can use that in
|
||||||
- targets:
|
- targets:
|
||||||
- example.com
|
- 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.
|
||||||
|
|
Loading…
Reference in a new issue