Status Dashboard runbook
The Status Dashboard is an optional Deephaven infrastructure service that exposes a Prometheus-compatible metrics endpoint for external monitoring systems such as Prometheus and Grafana.
Impact of Status Dashboard failure
| Level | Impact |
|---|---|
| Sev 2 - Moderate | Status dashboard data will not be available. Cluster monitoring and metrics visualization will be unavailable, but operational systems continue functioning normally. |
Note
The Status Dashboard is purely observational. Its failure does not affect Deephaven's ability to process queries or serve data, only the ability to monitor the system.
Status Dashboard dependencies
The Status Dashboard requires:
- Configuration Server — Must be running to access cluster configuration.
- All monitored processes — Should be running to collect metrics from them.
- etcd cluster — Must be accessible (via Configuration Server).
The Status Dashboard collects metrics from all Deephaven processes via their metrics endpoints.
Checking Status Dashboard status
Check process is running with monit:
Expected output should show status Running.
Access the Prometheus metrics endpoint:
Authentication requires a valid Deephaven user who is a superuser or a member of the group specified by StatusDashboard.allowedGroups (default: dashboard).
Viewing Status Dashboard logs
View application log:
Tail the log to follow in real-time:
List historical log files:
View process stdout/stderr logs:
Restart procedure
Restart the Status Dashboard:
Impact: Restarting the Status Dashboard briefly interrupts access to monitoring dashboards but does not affect operational systems.
Verify the restart was successful:
Monitor the log during startup:
Configuring the Status Dashboard
Key configuration properties (in iris-common.prop or status_dashboard.prop). See Status Dashboard overview for full configuration details.
| Property Name | Purpose | Default Value |
|---|---|---|
StatusDashboard.prometheus.port | Port on which Prometheus data is exposed | 8112 |
StatusDashboard.prometheus.namespace | Prometheus namespace for the data | Deephaven |
StatusDashboard.useSsl | Use HTTPS for the Prometheus interface | true |
StatusDashboard.useAuthentication | Require authentication to access endpoint | true |
StatusDashboard.allowedGroups | Groups allowed to access the endpoint | dashboard |
Configuration files and locations
monit configuration: /etc/sysconfig/illumon.d/monit/status_dashboard.conf
Property files:
/etc/sysconfig/illumon.d/resources/iris-common.prop/etc/sysconfig/illumon.d/resources/status_dashboard.prop
Log directory: /var/log/deephaven/status_dashboard/