Visualize JupyterHub Metrics

Pulse provides real-time visualization of JupyterHub metrics, enabling you to monitor usage, performance, and system health through interactive dashboards and charts.

Use these visualizations to quickly assess user activity, resource consumption, and operational performance.

Steps

  1. In the Pulse UI, navigate to JupyterHub > Dashboard.

  2. On the JupyterHub Dashboard page, open the Overview tab.

  3. View the Summary Panel, which displays high-level JupyterHub statistics.

  4. Set a time range and data refresh interval (for example, 10 seconds, 20 minutes, 2 hours, 4 days, or 1 week) to ensure the charts display timely and meaningful data.

Pulse then updates the Summary Panel and charts based on the selected time range.

Summary Panel

The Summary Panel provides a quick overview of key JupyterHub metrics.

MetricDescription
Total UsersTotal number of users configured in JupyterHub.
Active UsersNumber of users currently active within the selected time range.

These metrics provide a high-level snapshot of JupyterHub usage and activity.

Charts

The Charts section provides detailed visualizations of JupyterHub performance and behavior over time.

ChartDescription
Active UsersNumber of active users aggregated at daily (24h), weekly (7d), and monthly (30d) levels.
Virtual Memory SizeVirtual memory size (VMS) of the JupyterHub process, measured in bytes.
Resident Set SizeAmount of memory currently held in physical RAM by the JupyterHub process.
CPU Time per SecondCPU seconds consumed by the JupyterHub process per second.
Total Number of Running ServersTotal number of active user notebook servers.
Average HTTP Request DurationAverage duration of HTTP requests handled by JupyterHub, measured in seconds.
Average Startup DurationAverage time JupyterHub takes to start, measured in seconds.
Average Server Spawn DurationAverage duration of server spawn operations, measured in seconds. If no spawns occur in the selected time range, no data is shown.
Average Spawner Initialization DurationAverage time taken to initialize a JupyterHub spawner for a user server.
Average Server Stop DurationAverage time JupyterHub takes to stop user notebook servers. If no stop events occur in the selected time range, no data is shown.
Average Route Check DurationAverage time JupyterHub takes to check proxy routes. If no route checks occur in the selected time range, no data is shown.
Average Proxy Poll DurationAverage time JupyterHub takes to poll the proxy for routing and status information.
Average Proxy Add DurationAverage time JupyterHub takes to add a route to the proxy.
Average Proxy Delete DurationAverage time JupyterHub takes to delete a route from the proxy. If no deletions occur in the selected time range, no data is shown.

Key Features

Each chart includes the following actions:

  • Show Anomaly Prediction – Displays anomaly predictions based on historical data. Tip: Refer to the chart description for additional context.

  • Refresh – Updates the chart with the latest available data.

  • Maximize – Expands the chart to a full-page view.

  • Download – Exports chart data in .xlsx or .csv format.

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard