hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-16 22:43:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs for metric prefix

Browse Source
This commit is contained in:
Min RK
2023-08-09 09:06:28 +02:00
parent 7ce8fb7153
commit 94687e5215
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/reference/monitoring.md
View File

@@ -18,3 +18,17 @@ tool like [Grafana](https://grafana.com).
/reference/metrics /reference/metrics
``` ```
## Customizing the metrics prefix
JupyterHub metrics all have a `jupyterhub_` prefix.
As of JupyterHub 5.0, this can be overridden with `$JUPYTERHUB_METRICS_PREFIX` environment variable
in the Hub's environment.
For example,
```bash
export JUPYTERHUB_METRICS_PREFIX=jupyterhub_prod
```
would result in the metric `jupyterhub_prod_active_users`, etc.

2
jupyterhub/metrics.py
View File

@@ -6,6 +6,8 @@ conventions for metrics & labels. We generally prefer naming them
`<noun>_<verb>_<type_suffix>`. So a histogram that's tracking `<noun>_<verb>_<type_suffix>`. So a histogram that's tracking
the duration (in seconds) of servers spawning would be called the duration (in seconds) of servers spawning would be called
server_spawn_duration_seconds. server_spawn_duration_seconds.
A namespace prefix is always added, so this metric is accessed as
`jupyterhub_server_spawn_duration_seconds` by default.
We also create an Enum for each 'status' type label in every metric We also create an Enum for each 'status' type label in every metric
we collect. This is to make sure that the metrics exist regardless we collect. This is to make sure that the metrics exist regardless