hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 15:33:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

simpler custom spawn bucket sizes

Browse Source 
for prometheus
This commit is contained in:
kireetb
2025-02-03 22:50:58 -05:00
parent e65b7c3c15
commit ee4a8e593d
2 changed files with 17 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -33,6 +33,16 @@ export JUPYTERHUB_METRICS_PREFIX=jupyterhub_prod
would result in the metric `jupyterhub_prod_active_users`, etc. would result in the metric `jupyterhub_prod_active_users`, etc.
## Customizing spawn bucket sizes
As of JupyterHub >= 5.2.1, override `JUPYTERHUB_SERVER_SPAWN_DURATION_SECONDS_BUCKETS` env variable in Hub's environment to allow custom bucket sizes. Otherwise default to, [0.5, 1, 2.5, 5, 10, 15, 30, 60, 120, 180, 300, 600, float("inf")]
For example,
```bash
export JUPYTERHUB_SERVER_SPAWN_DURATION_SECONDS_BUCKETS="1,2,4,6,12,30,60,120"
```
## Configuring metrics ## Configuring metrics
```{eval-rst} ```{eval-rst}

32
jupyterhub/metrics.py
View File

@@ -36,31 +36,13 @@ from traitlets.config import LoggingConfigurable
from . import orm from . import orm
from .utils import utcnow from .utils import utcnow
metrics_prefix = os.getenv('JUPYTERHUB_METRICS_PREFIX', 'jupyterhub')
_env_buckets = os.environ.get('JUPYTERHUB_SERVER_SPAWN_DURATION_SECONDS_BUCKETS', "").strip()
class CustomEnvVars(HasTraits): if _env_buckets:
bucket_sizes = List().tag(config=True) spawn_duration_buckets = [float(_s) for _s in _env_buckets.split(",")]
metrics_prefix = os.getenv('JUPYTERHUB_METRICS_PREFIX', 'jupyterhub') else:
spawn_duration_buckets = [0.5, 1, 2.5, 5, 10, 15, 30, 60, 120, 180, 300, 600, float("inf")]
def load_from_env(self):
env_var_bucket_sizes = os.getenv(
'JUPYTERHUB_SERVER_SPAWN_DURATION_SECONDS_BUCKET_SIZES',
'[0.5, 1, 2.5, 5, 10, 15, 30, 60, 120, 180, 300, 600]',
)
try:
# Manually convert the string to a list
# Here we assume the string is in the format '[1, 2, 3]'
cleaned = env_var_bucket_sizes.strip('[]').replace(' ', '')
self.bucket_sizes = [str(i) for i in cleaned.split(',')]
except (ValueError, AttributeError):
# Handle if conversion fails
raise TraitError("Failed to convert environment variable to list.")
custom_env = CustomEnvVars()
custom_env.load_from_env()
metrics_prefix = custom_env.metrics_prefix
bucket_sizes = custom_env.bucket_sizes
REQUEST_DURATION_SECONDS = Histogram( REQUEST_DURATION_SECONDS = Histogram(
'request_duration_seconds', 'request_duration_seconds',
@@ -75,7 +57,7 @@ SERVER_SPAWN_DURATION_SECONDS = Histogram(
['status'], ['status'],
# Use custom bucket sizes, since the default bucket ranges # Use custom bucket sizes, since the default bucket ranges
# are meant for quick running processes. Spawns can take a while! # are meant for quick running processes. Spawns can take a while!
buckets=bucket_sizes, buckets=spawn_duration_buckets,
namespace=metrics_prefix, namespace=metrics_prefix,
) )