Skip to content

docs: list the user gauges exported by OpenTelemetry metrics #1502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raphael-bynome wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: list the user gauges exported by OpenTelemetry metrics #1502

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/reference/monitoring/otel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,15 @@ WebUI exports the following metrics via OpenTelemetry:
|------------------------|-----------|------|--------------------------------------|
| `http.server.requests` | Counter | 1 | `http.method`, `http.route`, `http.status_code` |
| `http.server.duration` | Histogram | ms | (same as above) |
| `webui.users.total` | Gauge | users | (none) |
| `webui.users.active` | Gauge | users | (none) |
| `webui.users.active.today` | Gauge | users | (none) |

The three user gauges are read from the database at each export:

- `webui.users.total`: registered users.
- `webui.users.active`: users active in the last 3 minutes.
- `webui.users.active.today`: users active since midnight **UTC** today, not local midnight.

Metrics are sent via OTLP (default every 10 seconds, configurable via `OTEL_METRICS_EXPORT_INTERVAL_MILLIS`) and can be visualized in **Grafana** (via Prometheus/Mimir).

Expand Down