Skip to main content

Create a new chaos dashboard

This section will guide you through creating a new chaos dashboard, and creating custom visualizations for various entities of a chaos experiment.

Before you begin​

Refer to overview of chaos dashboards to understand what a chaos dashboard is, and how you can view a predefined chaos dashboard.

Create a new visualization​

To create a new visualization in a dashboard, follow the steps mentioned below.

Step 1: Click Dashboard​

To create a new dashboard, click Dashboard. click-dashboard

Step 2: Specify parameters​

Add values for Folder, Name, and Tags (compulsory). specify-params

Click Continue. This creates an empty dashboard. You can add visualizations (also known as panels) by editing this dashboard. specify-params

Step 3: Edit previously created dashboard​

Click Edit Dashboard to edit the dashboard that you created in the previous step. edit-dashboard

tip

Don't forget to add the Tag values because this is the field based on which the dashboards are filtered by modules.

Step 6: Add a visualization dashboard​

Click Add and select Visualization.

edit-dashboard

Step 5: Select a table​

Select a table whose fields you wish to visualize. HCE currently supports Chaos experiment runs, Chaos experiments, Chaos hub, and Chaos infrastructures. In this example, select Chaos experiments.

edit-dashboard

Step 6: Select fields​

Select the 2 or more fields which you wish to visualize. In this example, select Experiment Type and Total experiment runs.

edit-dashboard

Step 7: Click Run to view the graph​

When you click Run, chaos dashboard displays the graph of Total experiment runs (x-axis) versus Experiment Type (y-axis).

edit-dashboard

Step 8: Click Save (Optional)​

If you wish to save your visualization, click Save. Otherwise, you can Cancel and add visualizations again. edit-dashboard

note

You can find the definitions for many of the fields here.

Description of fields used​

Described below are descriptions of various fields used to plot and analyze data in Chaosguard.

  1. Chaos experiment runs

    • Experiment Run ID: Unique ID associated with every experiment execution (or run) that is created when you create and execute a chaos experiment.

    • Faults awaited: The number of chaos faults that had to wait to complete their execution.

    • Faults failed: The number of chaos faults that did not successfully complete its execution due to variety of reasons like probe failure, infrastructure version issues, and so on.

    • Faults passed: The number of chaos faults that met the conditions and completed its execution.

    • Faults stopped: The number of chaos faults that stopped execution.

    • Resilience score: Value that determines the resilience of your application by considering the number of probes that passed and the number of conditions that were met when a chaos experiment was executed.

    • Total_faults: The total number of faults that executed during a chaos experiment.

  2. Chaos experiments

    • Cron syntax: The syntax associated with the recurrence of the chaos experiment which is designed to execute the chaos experiment at period time intervals.

    • Experiment type: Whether the chaos experiment is run only once (that is, non-cron) or runs at periodic intervals (that is, cron).

    • Infra type: The type of infrastructure (which can be Kubernetes or Linux), on which the chaos experiment would be executed.

    • Total experiment runs: The total number of times a chaos experiment has run.

    • Name: Unique name of the chaos experiment.

    • Experiment ID: Unique ID associated with a chaos experiment when it is created and saved.

  3. Chaos infrastructure

    • Infra namespace: The namespace where the chaos infrastructure is installed.

    • Installation type: Whether to enable execution of chaos experiments on an existing infrastructures or on new infrastructures.

    • Last heartbeat time: Latest time of the infrastructure heartbeat to determine if the infrastructure is active or no.

    • Is Active (Yes / No): Whether the chaos infrastructure is active or no.

    • name: The unique name of the chaos infrastructure where you execute the chaos experiment.

    • Service Account: An identity for the chaos experiment that tells about the account in the chaos infrastructure where the experiment is run.

    • Version: The chaos infrastructure version used to execute the chaos experiments.

    • Environment Id: The environment where you create/use existing chaos infrastructure for chaos experiment execution.

    • InfraID: Unique ID associated with a chaos infrastructure when you create a new one.

  4. Chaos hubs

    • hubId: Unique chaos hub ID associated with a chaos hub

    • hubName: Chaos hub name that you can use to add multiple chaos experiments.

    • Repo branch: The branch of the repository that is associated with the chaos hub.

    • Repo name: The name of the branch in the repository that is associated with the chaos hub.

    • Auth type: The type of authentication used, that is HTTP or SSH.

    • Connector scope: Scope of the chaoshub connector, which can be project, organization or Account** scope.

    • Is Default (Yes / No): Whether the chaos hub used is a default hub or a custom hub.

tip

The fields accountId, orgId, and projectId are common to all descriptors. As the name suggests, the fields mentioned earlier provide a unique identifier for account, organisation, and project, respectively.

Next steps​