Install Dashboards

Yorker ships 8 pre-built dashboards that provision directly into your observability platform via its Dashboard API. No manual chart creation required. Both self-hosted HyperDX and ClickStack Cloud (ClickHouse-managed HyperDX) are supported. All carry the yorker-synthetics tag so the platform groups them together.

Dashboards included

Prerequisites: data sources

The dashboards read from up to three sources in your observability platform (Traces, Logs, and Metrics), and the installer wires each tile to the matching one. Yorker emits all three signals for every check run, so a complete setup has all three sources defined:

Several dashboards read from more than one source: Overview and Monitor Deep Dive each combine Traces and Logs, Performance Forensics is mostly Metrics with one Traces tile, and TLS Health mixes Traces and Metrics. A tile fails for whichever source it needs that is missing, so a multi-source dashboard can install partially.

If a source is missing, only the tiles that use it fail; the rest of that dashboard installs. Worked example: with Logs and Metrics sources but no Traces source, the two logs-only dashboards (SLO & Error Budget, Anomaly & AI Insights) install fully, the trace-only dashboards (Run Explorer, Third-Party) fail entirely, and the mixed dashboards (Overview, Monitor Deep Dive, Performance Forensics, TLS Health) install their non-trace tiles while their trace tiles are rejected.

To add a missing source: in your HyperDX or ClickStack Cloud console, open the data Sources settings and add a source of the missing type (Trace / Log / Metric), pointing it at the matching OpenTelemetry table (otel_traces, otel_logs, or otel_metrics in the default ClickHouse OTel schema). Then re-run the install. It is safe to re-run, as existing dashboards are skipped.

The installer checks your sources before it does anything, so if one is missing you get a message naming it (and the dashboards that need it) rather than a partial install.

Install via the web UI

1. Go to Settings > Telemetry (OTLP)
2. Under Dashboard Provisioning, select your deployment type (Self-hosted or ClickStack Cloud)
3. For ClickStack Cloud: enter your Organization ID, Service ID, and Cloud API key credentials
4. Click Save Changes, then click Install Dashboards

Self-hosted mode uses the same HyperDX API key already configured for telemetry. ClickStack Cloud uses ClickHouse Cloud API credentials (found in your ClickHouse Cloud console under API Keys).

Install via the CLI

Self-hosted HyperDX

--hyperdx-url is required for self-hosted: it is the HyperDX External API base, which serves on a different host/port from OTLP ingest (for example ClickStack uses OTLP :4318, API :8000) and is not derived from anything else.

yorker dashboards install \
  --hyperdx-api-key <your-key> \
  --hyperdx-url https://hyperdx.example.com

ClickStack Cloud

yorker dashboards install --mode clickstack_cloud \
  --clickstack-org-id <org-uuid> \
  --clickstack-service-id <service-uuid> \
  --clickstack-api-key-id <key-id> \
  --clickstack-api-secret <key-secret>

All ClickStack options support environment variables (CLICKSTACK_ORG_ID, CLICKSTACK_SERVICE_ID, CLICKSTACK_API_KEY_ID, CLICKSTACK_API_SECRET).

Options

Examples

# Self-hosted: install all dashboards
yorker dashboards install --hyperdx-api-key hdx_abc123 --hyperdx-url https://hyperdx.example.com

# Self-hosted: install only the overview dashboard
yorker dashboards install --hyperdx-api-key hdx_abc123 --hyperdx-url https://hyperdx.example.com --packs overview

# ClickStack Cloud: install all dashboards via env vars
export CLICKSTACK_ORG_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLICKSTACK_SERVICE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLICKSTACK_API_KEY_ID=your-key-id
export CLICKSTACK_API_SECRET=your-key-secret
yorker dashboards install --mode clickstack_cloud

Idempotency

Dashboards are named with a [Yorker] prefix. The install command checks for existing dashboards by name and skips duplicates automatically. Use --force to skip this check (note: this may create additional copies rather than replacing existing ones).

Screenshots in dashboards

The Deep Dive, Run Explorer, Performance Forensics, and Anomaly & AI Insights dashboards include search panels that surface synthetics.screenshot.url and other run metadata. When a browser check captures screenshots, the URL appears as a clickable link directly in the dashboard.