Configure CIO Dashboard¶
You can view DORA metrics in Choreo to use as KPIs to measure your organization's DevOps team's performance. Choreo enables this feature by default for all organizations. DORA includes the following four key metrics that are regarded as the most important metrics to indicate team performance:
- Deployment Frequency: How often an organization successfully releases to production
- Lead Time for Changes: The amount of time it takes a commit to get into production
- Change Failure Rate: The percentage of deployments causing a failure in production
- Time to Restore Service: How long it takes an organization to recover from a failure in production
Choreo enables two DORA metrics by default; deployment frequency and lead time for change.
Configure the CIO Dashboard with all metrics¶
To configure the CIO dashboard by enabling the other two metrics, follow the steps below:
- Sign in to Choreo using your Google, GitHub, or Microsoft account.
- On the left navigation menu, click Delivery Insights.
- Click on the DORA Metrics tab.
- Scroll to the bottom of the dashboard and click Configure.
- Select your incident management system. Currently, Choreo only supports GitHub.
Configuring GitHub as the incident management system¶
To configure GitHub as the incident management system, follow the steps below:
Step 1: Authorize¶
First, let's authorize Choreo to access the repositories used to record incidents.
On the Add Integration page, select GitHub and click Authorize with GitHub.
Once the authorization process is complete, you can start configuring the GitHub repository.
Step 2: Configure¶
By default, Choreo collects incident details(issues) from all repositories containing Choreo components. However, you can configure a GitHub account and a GitHub repository to allow Choreo to read issues from a specific repository, and then click Next.
Field | Description | Value |
---|---|---|
Data Plane | Choreo collects incident details by running a scheduled job which invokes the GitHub API periodically. This job runs on the user's data plane. This configuration allows users to specify a preferred data plane to run the job, especially when they have multiple data planes. | Select a preferred data plane from the Data Plane list. |
GitHub Account | The GitHub account you have your repositories in. | Select your GitHub account that includes the repository used for incident collection. |
GitHub Repository | By default, Choreo will collect incident details(issues) from all repositories that already have Choreo components. |
Step 3: Filter label¶
The filter label allows Choreo to scrape issues associated with that label.
-
Incident Label: The label Choreo uses to identify incidents. For example,
Type/Incident
. -
Invalid incident label(Optional): Choreo will not scrape issues with this label and will proceed to skip these issues. For example,
Resolution/Invalid
. You can use this label when you want to ignore issues. For example, closing an issue after identifying that it doesn't qualify as an incident issue as it was due to a user error.
Once you configure the labels, click Save.
Choreo will enable incident data publishing in the background once you save. Once completed, DORA metric charts will appear in the CIO dashboard for Mean Time To Recover and Change Failure Rate. If there are any issues in the configuration, the configure banner will reappear, and the user can proceed to reconfigure.
Step 4: Enrich incident tickets with deployment information¶
Choreo extracts deployment information from the relevant incident and generates DORA metrics that help you analyze the deployment statistics related to the incidents. Therefore, you must manually update the GitHub issue with the relevant deployment-related information. Follow the steps below to add the deployment information to the GitHub issue.
Get deployment details
- On the Choreo Console header, select the project and the component for which the incident was reported.
- On the left navigation menu, click Deploy.
- On the Production Environment card, click Deployment History.
-
On the right-hand side panel, select the relevant deployment, and click Release details to copy the deployment details to the clipboard.
Add deployment information to the GitHub issue
- Edit the GitHub issue to add the deployment information.
- Paste the deployment information you copied (in step 4 under the section
Get deployment details
) at the end of the issue body. - Click Save.
That's it! You have successfully configured your CIO dashboard to include the DORA metrics.
Note
The CIO Dashboard is expected to reflect the latest statistics within approximately 30 minutes.
Edit configurations¶
You can edit or override the configurations you made via the edit option in the dashboard.