---
id: runbook-status-dashboard
title: Status Dashboard runbook
---

The [Status Dashboard](../status-dashboard.md) 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:

1. **Configuration Server** — Must be running to access cluster configuration.
2. **All monitored processes** — Should be running to collect metrics from them.
3. **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:

```bash
dh_monit status status_dashboard
```

Expected output should show status `Running`.

Access the Prometheus metrics endpoint:

```
https://<SERVER_HOSTNAME>:8112/
```

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:

```bash
cat /var/log/deephaven/status_dashboard/StatusDashboard.log.current
```

Tail the log to follow in real-time:

```bash
tail -f /var/log/deephaven/status_dashboard/StatusDashboard.log.current
```

List historical log files:

```bash
ls -ltr /var/log/deephaven/status_dashboard/status_dashboard.log.????-??-??
```

View process stdout/stderr logs:

```bash
cat /var/log/deephaven/status_dashboard/status_dashboard.log.$(date +%Y-%m-%d)
```

## Restart procedure

Restart the Status Dashboard:

```bash
dh_monit restart status_dashboard
```

**Impact:** Restarting the Status Dashboard briefly interrupts access to monitoring dashboards but does not affect operational systems.

Verify the restart was successful:

```bash
dh_monit status status_dashboard
```

Monitor the log during startup:

```bash
tail -f /var/log/deephaven/status_dashboard/StatusDashboard.log.current
```

## Configuring the Status Dashboard

Key configuration properties (in `iris-common.prop` or `status_dashboard.prop`). See [Status Dashboard overview](../status-dashboard.md) 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/`

## Related documentation

- [Status dashboard overview](../status-dashboard.md)
- [System processes overview](../architecture/architecture-overview.md)
- [Metrics and monitoring](../ops-guide/metrics-and-monitoring.md)
- [Production log monitoring](../../performance/best-practices/production-log-monitoring.md)