> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/resilience-testing/shared-capabilities/custom-dashboards.md).

# Dashboards

Use out-of-the-box dashboards and build your own custom dashboards in the Harness Resilience Testing module

The Resilience Testing (RT) module provides dashboards that visualize key metrics from your chaos testing operations. You access them under the **Dashboards** section of the **Insights** left navigation.

The module ships with out-of-the-box (OOTB) dashboards for a high-level view of chaos testing across an account, and you can also build your own custom dashboards from Harness Unified Data Platform (UDP) queries.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-cebd80f4bdfde056ac273d7658fbf186c667c596%2Frisk-insights-dashboards-nav.png?alt=media" alt="The Dashboards item under the Insights section of the Resilience Testing left navigation"><figcaption><p>Click to view full size</p></figcaption></figure>

*The Dashboards item under Insights in the Resilience Testing module.*

Selecting **Dashboards** opens the dashboards landing page.

***

## Out-of-the-box dashboards <a href="#out-of-the-box-dashboards" id="out-of-the-box-dashboards"></a>

The **Dashboards** page groups dashboards by category. Use the filters on the left to show **All** dashboards, your **Favourites**, or the dashboards in one of four categories: Risks, Chaos Experiments, Load Tests, or Disaster Recovery Tests.

The following dashboards ship out of the box:

| Dashboard                                         | Key widgets                                                                                                                                                                                                                                                                           |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Chaos Experiments by Target**                   | Total Chaos Experiment Runs, Experiment Runs by Status, Faults created per Infrastructure, Experiments created per Infrastructure, Chaos Experiment Runs (Daily/Weekly), Experiment Runs per Chaos Experiment, Average & Median Resilience score, Chaos Experiment Runs (Project/Org) |
| **Chaos Experiment Outcomes Summary**             | Total Chaos Experiment Runs, Chaos Experiment Outcome Distribution, Weekly Chaos Experiment Run Trend, Chaos Experiment Run Outcomes (Project/Org/Infrastructure)                                                                                                                     |
| **Resilience Score Trend (per Chaos Experiment)** | Chaos Experiment Run trend, Latest Run (Per Experiment), Chaos Experiment Pass Rate, Experiment Resilience score variance                                                                                                                                                             |
| **Top Repeat-Failing Experiments**                | Repeat-failing experiments, Repeat failing experiments (User)                                                                                                                                                                                                                         |
| **Chaos Experiment Creation Trend by User**       | Chaos Experiments created by users, Experiment creation per user (weekly), Chaos experiment creation (new users), Chaos Experiment Runs Creation (User)                                                                                                                               |
| **Top Contributors & Hub Authors**                | Top Actions Contributors, Top Probe contributors, Top Hub contributors, Top Probe creation by Probe type                                                                                                                                                                              |

The following is an example OOTB dashboard:

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-c9a43413a093819c0f973e2e958b5fb70f1a72db%2Fexample-dashboard.png?alt=media" alt="An example out-of-the-box dashboard showing chaos experiment metrics"><figcaption><p>Click to view full size</p></figcaption></figure>

***

## Create a custom dashboard <a href="#create-a-custom-dashboard" id="create-a-custom-dashboard"></a>

You create custom dashboards from the RT **Dashboards** page. A custom dashboard belongs to the project you create it in, so it appears on the **Dashboards** page of that project only. Out-of-the-box dashboards appear in every project in the account.

1. Go to **Insights** > **Dashboards** and select **Create dashboard**.
2. Enter a **Name** and, optionally, a **Description**.
3. Optionally, select a **Category**: **Risks**, **Chaos Experiments**, **Load Tests**, or **Disaster Recovery Tests**. The category decides which filter on the **Dashboards** page lists the dashboard. A dashboard with no category appears under **All** only.
4. Optionally, add **Tags**. Harness adds the `Chaos` tag for you, which is how the **Dashboards** page identifies RT dashboards.
5. Select **Create**. The new dashboard opens.
6. If the dashboard is not in edit mode, select **Edit**. Then select **New Widget** > **Data Widget**.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-4903af3a2ac6c21c91f951e57fec4078d3943806%2Fdata-widget.png?alt=media" alt="The Data Widget option"><figcaption><p>Click to view full size</p></figcaption></figure>

7. Enter a name for the widget, then define its data on the **Data** tab. Pick a **Datasource** and add **Selections**, or turn on **Code View** and write the query yourself. Go to [Dashboard query schema](#dashboard-query-schema) to review the available event and entity types.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-ac89cadcf25dc37705176c243066125ca06d26a4%2Fcode-view.png?alt=media" alt="The Code View toggle on the widget editor"><figcaption><p>Click to view full size</p></figcaption></figure>

8. In **Code View**, select **Run Query** to fetch data from Harness UDP. Changes to the query do not show in the preview until you run it.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-aa1efaae7592129b557e6ded3a06c9bc017325d7%2Frun-query.png?alt=media" alt="The Run Query result showing fetched data"><figcaption><p>Click to view full size</p></figcaption></figure>

9. Choose a visualization from the icons above the preview. The available visualizations are:

   * Table View
   * Metric Card
   * Donut Chart
   * Bar Chart
   * Column Chart
   * Line Chart
   * Area Chart
   * Scatter Chart

   This example uses a **Donut Chart**.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-7c7ddfd25d35d2ebf9d8ed913d061e5343071182%2Fdonut-chart.png?alt=media" alt="A Donut Chart visualization of the query results"><figcaption><p>Click to view full size</p></figcaption></figure>

10. Select **Add Widget** at the top right to add the widget to the dashboard.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-aa03c858b53243e3d75559e2f954f19269f1463d%2Fadd-widget-save.png?alt=media" alt="The Add Widget button at the top right of the widget editor"><figcaption><p>Click to view full size</p></figcaption></figure>

11. Add any remaining widgets, then select **Save** at the top right.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-4f2892bf4690d4c98a97fcf51aae6e74a2dd04db%2Fwidget-added.png?alt=media" alt="The dashboard showing the newly added widget with the Save button"><figcaption><p>Click to view full size</p></figcaption></figure>

Your custom dashboard now appears on the **Dashboards** page, under **All** and under the category you selected.

{% hint style="info" %}
**DASHBOARDS CREATED OUTSIDE RT**

The **Dashboards** page lists a custom dashboard only when it has the `Chaos` tag and is labeled with the current project. **Create dashboard** adds both for you. Create RT dashboards from this page rather than from the Harness platform **Dashboards** app.
{% endhint %}

***

## Availability on SMP <a href="#availability-on-smp" id="availability-on-smp"></a>

The **Dashboards** page and the custom dashboard flow on this page ship in the Resilience Testing web UI (Chaos Web) 1.95.0 and later. Harness Self-Managed Enterprise Edition (SMP) 0.47.0 ships Chaos Web 1.101.3 and Chaos Manager 1.101.6, so it includes them.

On SaaS and SMP alike, the **Dashboards** page is behind the `CHAOS_RISK_INSIGHTS_DASHBOARD_ENABLED` feature flag. Only the web UI reads this flag, so on SMP enable it with your other platform feature flags. Contact Harness Support to enable it on SaaS.

***

## RBAC considerations <a href="#rbac-considerations" id="rbac-considerations"></a>

Dashboards fall under the **Shared Resources** category, with **View** and **Manage** permissions:

* **View:** Required to see the RT module in-product dashboards.
* **Manage:** Required to create your own dashboards.

<figure><img src="https://3217710372-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRmV5EkLS9r45VPaoUnJZ%2Fuploads%2Fgit-blob-e4617939f99743e653b064bf0203bb19c4c7c143%2Frbac-permissions.png?alt=media" alt="The Shared Resources dashboard permissions, showing View and Manage"><figcaption><p>Click to view full size</p></figcaption></figure>

Go to [RBAC in Harness](https://developer.harness.io/harness-platform/use-harness-platform/platform-access-control) to configure roles and permissions.

***

## Dashboard query schema <a href="#dashboard-query-schema" id="dashboard-query-schema"></a>

Custom dashboard widgets query Harness UDP using event and entity types. The following reference lists the available types and example queries.

### Event types <a href="#event-types" id="event-types"></a>

**Chaos Experiment Runs (`chaos:experiment_run_event`)**

```sql
find event chaos:experiment_run_event | select { created_at, resiliency_score, db_id, unique_id, parent_unique_id, last_modified_at, phase, infrastructure_id, event_timestamp, org_identifier, updated_by, fk_experiment_id, cdc_operation_type, experiment_run_id, sequence, experiment_name, project_identifier, created_by, target_services, account_identifier, yaml, deleted } | filter event_timestamp > ago(1h) | limit 10
```

### Entity types <a href="#entity-types" id="entity-types"></a>

**Chaos Action (`chaos:action`)**

```sql
find entity chaos:action | select { created_at, description, tags, type, identifier, db_id, unique_id, parent_unique_id, last_modified_at, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, infrastructure_type, deleted } | limit 10
```

**Chaos Action Template (`chaos:action_template`)**

```sql
find entity chaos:action_template | select { created_at, description, tags, type, identifier, db_id, unique_id, hub_identifier, last_modified_at, parent_unique_id, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, infrastructure_type, deleted } | limit 10
```

**Chaos Execution Node (`chaos:execution_node`)**

```sql
find entity chaos:execution_node | select { experiment_id, db_id, finished_at, status, infrastructure_id, name, org_identifier, step_type, last_updated_at, experiment_run_id, spec, account_identifier, project_identifier, infrastructure_type, started_at, deleted } | limit 10
```

**Chaos Experiment (`chaos:experiment`)**

```sql
find entity chaos:experiment | select { created_at, description, tags, experiment_id, identifier, db_id, unique_id, parent_unique_id, last_modified_at, infrastructure_id, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, infrastructure_type, deleted } | limit 10
```

**Chaos Experiment Run (`chaos:experiment_run`)**

```sql
find entity chaos:experiment_run | select { created_at, resiliency_score, db_id, unique_id, parent_unique_id, last_modified_at, phase, infrastructure_id, org_identifier, updated_by, fk_experiment_id, experiment_run_id, sequence, experiment_name, project_identifier, created_by, target_services, account_identifier, yaml, deleted } | limit 10
```

**Chaos Experiment Template (`chaos:experiment_template`)**

```sql
find entity chaos:experiment_template | select { created_at, description, tags, identifier, db_id, unique_id, hub_identifier, last_modified_at, parent_unique_id, name, org_identifier, updated_by, is_default, account_identifier, project_identifier, created_by, revision, template_uid, yaml, infrastructure_type, deleted } | limit 10
```

**Chaos Fault (`chaos:fault`)**

```sql
find entity chaos:fault | select { created_at, description, tags, type, identifier, db_id, unique_id, parent_unique_id, last_modified_at, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, infrastructure_type, deleted } | limit 10
```

**Chaos Fault Template (`chaos:fault_template`)**

```sql
find entity chaos:fault_template | select { created_at, description, tags, type, identifier, db_id, unique_id, hub_identifier, last_modified_at, parent_unique_id, name, org_identifier, updated_by, is_default, account_identifier, project_identifier, created_by, revision, template_uid, yaml, infrastructure_type, deleted } | limit 10
```

**Chaos Hub (`chaos:hub`)**

```sql
find entity chaos:hub | select { created_at, description, tags, identifier, db_id, unique_id, parent_unique_id, last_modified_at, hub_id, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, deleted } | limit 10
```

**Chaos K8s Infrastructure V2 (`chaos:k8s_infrastructure_v2`)**

```sql
find entity chaos:k8s_infrastructure_v2 | select { created_at, description, tags, kind, identifier, db_id, unique_id, parent_unique_id, last_modified_at, environment_identifier, name, org_identifier, updated_by, api_version, account_identifier, project_identifier, created_by, deleted } | limit 10
```

**Chaos Linux Infrastructure (`chaos:linux_infrastructure`)**

```sql
find entity chaos:linux_infrastructure | select { created_at, start_time, tags, description, db_id, infra_id, is_active, parent_unique_id, last_modified_at, unique_id, environment_identifier, name, version, is_infra_confirmed, is_registered, updated_by, org_identifier, account_identifier, project_identifier, hostname, created_by, last_heartbeat, deleted } | limit 10
```

**Chaos Probe (`chaos:probe`)**

```sql
find entity chaos:probe | select { created_at, description, tags, type, identifier, db_id, unique_id, parent_unique_id, last_modified_at, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, infrastructure_type, deleted } | limit 10
```

**Chaos Probe Template (`chaos:probe_template`)**

```sql
find entity chaos:probe_template | select { created_at, description, tags, type, identifier, db_id, unique_id, hub_identifier, last_modified_at, parent_unique_id, name, org_identifier, updated_by, account_identifier, project_identifier, created_by, infrastructure_type, deleted } | limit 10
```

***

## Related concepts <a href="#related-concepts" id="related-concepts"></a>

* Go to [Harness Dashboards](https://developer.harness.io/harness-platform/use-harness-platform/harness-dashboards/dashboard-legacy/dashboard-best-practices) to review dashboard best practices.
* Go to [RBAC in Harness](https://developer.harness.io/harness-platform/use-harness-platform/platform-access-control) to manage dashboard permissions.

***

## Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

<details>

<summary>A custom dashboard does not appear in the Resilience Testing Dashboards section</summary>

The **Dashboards** page lists a custom dashboard only when it has the `Chaos` tag and is labeled with the current project. A dashboard created in another project appears only in that project, and a dashboard built outside the RT **Dashboards** page, such as in the Harness platform **Dashboards** app, may not carry the project label. Create the dashboard from **Create dashboard** on the RT **Dashboards** page, which adds both.

</details>

<details>

<summary>The dashboards do not load, or I cannot create a dashboard</summary>

Dashboards fall under **Shared Resources**. You must have the **View** permission to open the in-product dashboards and the **Manage** permission to create your own. Go to [RBAC considerations](#rbac-considerations) to review the permissions.

</details>

{% @harness-feedback/feedback %}
