mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 18:44:10 +00:00
60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
# Monitoring
|
|
|
|
This section covers details on monitoring the state of your JupyterHub installation.
|
|
|
|
JupyterHub expose the `/metrics` endpoint that returns text describing its current
|
|
operational state formatted in a way [Prometheus](https://prometheus.io) understands.
|
|
|
|
Prometheus is a separate open source tool that can be configured to repeatedly poll
|
|
JupyterHub's `/metrics` endpoint to parse and save its current state.
|
|
|
|
By doing so, Prometheus can describe JupyterHub's evolving state over time.
|
|
This evolving state can then be accessed through Prometheus that expose its underlying
|
|
storage to those allowed to access it, and be presented with dashboards by a
|
|
tool like [Grafana](https://grafana.com).
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
|
|
/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.
|
|
|
|
(monitoring_bucket_sizes)=
|
|
|
|
## Customizing bucket sizes
|
|
|
|
As of JupyterHub 5.3, the following environment variables in the Hub's environment can be overridden to support custom bucket sizes - below are the defaults:
|
|
|
|
| Variable | Default |
|
|
| -------------------------------------------------- | ------------------------------------------------------------------ |
|
|
| `JUPYTERHUB_SERVER_SPAWN_DURATION_SECONDS_BUCKETS` | `0.5,1,2.5,5,10,15,30,60,120,180,300,600,inf` |
|
|
| `JUPYTERHUB_SERVER_STOP_DURATION_SECONDS_BUCKETS` | `0.005,0.01,0.025,0.05,0.075,0.1,0.25,0.5,0.75,1,2.5,5,7.5,10,inf` |
|
|
|
|
For example,
|
|
|
|
```bash
|
|
export JUPYTERHUB_SERVER_SPAWN_DURATION_SECONDS_BUCKETS="1,2,4,6,12,30,60,120,inf"
|
|
```
|
|
|
|
## Configuring metrics
|
|
|
|
```{eval-rst}
|
|
.. currentmodule:: jupyterhub.metrics
|
|
|
|
.. autoconfigurable:: PeriodicMetricsCollector
|
|
```
|