Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit68ccdc3

Browse files
committed
Merge branch 'project-one' ofhttps://github.com/codefresh-io/cap-docs.codefresh.io into project-one
2 parentsef50206 +eec114e commit68ccdc3

File tree

4 files changed

+253
-7
lines changed

4 files changed

+253
-7
lines changed

‎_data/home-content.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,16 @@
113113
localurl:/docs/dashboards/dora-metrics/
114114

115115

116+
-title:Dashboards & insights
117+
icon:images/home-icons/guides.png
118+
url:''
119+
links:
120+
-title:Home dashboard
121+
localurl:/docs/dashboards/home-dashboard/
122+
-title:DORA metrics
123+
localurl:/docs/dashboards/dora-metrics/
124+
125+
116126

117127
-title:CI/CD guides
118128
icon:images/home-icons/guides.png

‎_data/nav.yml‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@
3030

3131

3232

33+
-title:Dashboards & Insights
34+
url:"/dashboards"
35+
pages:
36+
-title:Home dashboard
37+
url:"/home-dashboard"
38+
-title:DORA metrics
39+
url:"/dora-metrics"
40+
41+
3342
-title:Dashboards & Insights
3443
url:"/dashboards"
3544
pages:
@@ -608,10 +617,3 @@
608617

609618

610619

611-
612-
613-
614-
615-
616-
617-

‎_docs/dashboards/dora-metrics.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title:"DORA metrics"
3+
description:"Get insights into your deployments"
4+
group:dashboards
5+
toc:true
6+
---
7+
8+
DevOps is a collaboration paradigm that is sometimes mistaken for being too abstract or too generic. In an effort to quantify the benefits of adopting DevOps,[Dora Research](https://www.devops-research.com/research.html#capabilities){:target="\_blank"} (acquired by Google in 2018), has introduced four key metrics that define specific goals for improving the software lifecycle in companies interested in adopting DevOps.
9+
10+
DORA measures these metrics:
11+
12+
* Deployment Frequency: How often an organization successfully releases to production
13+
* Lead Time for Changes: The length of time for a commit to be deployed into production
14+
* Change Failure Rate: The percentage of deployments causing a failure in production
15+
* Time to Restore Service: The length of time for an organization to recover from a failure in production
16+
17+
[Read more on DORA](https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance){:target="\_blank"}.
18+
19+
##DORA metrics in Codefresh
20+
21+
Monitoring DORA metrics can help identify delivery issues in your organization by detecting bottlenecks among teams and optimize your workflows at technical or organizational levels.
22+
Codefresh offers support for DORA metrics out of the box.
23+
24+
* In the Codefresh UI, go to[DORA metrics](https://g.codefresh.io/2.0/dora-dashboard/dora){:target="\_blank"}.
25+
26+
{% include
27+
image.html
28+
lightbox="true"
29+
file="/images/reporting/dora-metrics.png"
30+
url="/images/reporting/dora-metrics.png"
31+
alt="DORA metrics report"
32+
caption="DORA metrics report"
33+
max-width="100%"
34+
%}
35+
36+
##Filters
37+
38+
Use filters to define the exact subset of applications you are interested in. All filters support auto-complete and multiselect.
39+
More than one option within the same filter type has an OR relationship. Multiple filter types when defined share an AND relationship.
40+
41+
* Runtimes: Show metrics for applications from selected runtimes
42+
* Clusters: Show metrics for applications deployed to selected clusters
43+
* Applications: Show metrics for selected applications.
44+
* Time: Show metrics from application for a specific time period
45+
46+
>When no filters are defined, all metrics are shown for the last 90 days.
47+
48+
##Metrics for favorite applications
49+
If you have[starred applications as favorites]({{site.baseurl}}/docs/deployment/applications-dashboard/#applications-dashboard-information) in the Applications dashboard, clicking {::nomarkdown}<imgsrc="../../../images/icons/icon-mark-favorite.png?display=inline-block">{:/} in DORA metrics, displays DORA metrics only for those applications.
50+
51+
52+
##Metric totals
53+
As the title indicates, the Totals bar shows the total numbers, based on the filters defined, or for the last 90 days, if there are no filters:
54+
55+
* Deployments
56+
* Rollbacks
57+
* Commits/Pull Requests
58+
* Failure Rate: The number of failed deployments divided by the total number of deployments
59+
60+
##Metric graphs
61+
The metric graphs are key to performance insights with DORA metrics. The metrics are again based on the filters defined, or for the last 90 days if there are no filters.
62+
63+
In addition, you can select the granularity for each graph:
64+
65+
* Daily
66+
* Weekly
67+
* Monthly
68+
69+
>Tip:
70+
Remember that the graphs for the DORA metrics reflect metrics of application deployments, not workflows.
71+
72+
**Deployment Frequency**
73+
The frequency at which applications are deployed to production, including both successful (Healthy) and failed (Degraded), deployments. A deployment is considered an Argo CD sync where there was a change in the application source code that resulted in a new deployment of the application to production.
74+
The X-axis charts the time based on the granularity selected, and the Y-axis charts the number of deployments. The number shown on the top right is the average deployment frequency based on granularity.
75+
76+
**Lead Time for Changes**
77+
The average number of days from the first commit for a PR (pull request) until the deployment date for the same PR. The key term here is_deployment_. Lead Time for Changes considers only those changes to workflows that result in a deployment. Making a change to a repo that does not result in a deployment is not included when calculating Lead Time for Changes.
78+
The X-axis charts the time based on the granularity selected, and the Y-axis charts the time in minutes until the deployment. The number shown on the top right is the average number of days for a commit to reach production.
79+
80+
**Change Failure Rate**
81+
The failure or rollback rate in percentage for applications whose health status changed to Degraded on deployment. The key term here is_on deployment_. For example, bumping an image tag with one that does not exist, results in the application being Degraded on deployment, and designated as failed.
82+
The Change Failure Rate is derived by dividing the number of Degraded (failed/rollback) deployments with the total number of deployments.
83+
The X-axis charts the time based on the granularity selected, and the Y-axis charts the failure rate. The number shown on the top right is the average failure rate based on granularity, and therefore may not be equal to the Total Failure Rate.
84+
85+
**Time to Restore Service**
86+
The average number of hours taken for the status of Degraded deployments to return to Healthy. Again, similar to the Change Failure Rate, Time to Restore Service includes only deployments that became Degraded. It is derived by dividing the total number of hours for all Degraded deployments to return to Healthy by the total number of Degraded deployments.
87+
The X-axis charts the time based on the granularity, and the Y-axis charts the time in hours. The number shown on the top right is the average number of hours between the previous deployment and rollback for the same application.
88+
89+
##Related articles
90+
[Global analytics dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard)
91+
[Monitoring applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/)
92+

‎_docs/dashboards/home-dashboard.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title:"Global analytics dashboard"
3+
description:""
4+
group:dashboards
5+
toc:true
6+
---
7+
8+
Get a global picture of runtimes, managed clusters, deployments, and pipelines in the Home dashboard. The Home dashboard is displayed when you log in to Codefresh, providing system-wide visualization in real-time.
9+
10+
Global filters allow you to narrow the scope of the data, and drill down into specific entities for more details.
11+
12+
{% include
13+
image.html
14+
lightbox="true"
15+
file="/images/reporting/home-dashboard.png"
16+
url="/images/reporting/home-dashboard.png"
17+
alt="Home dashboard: Global enterprise analytics"
18+
caption="Home dashboard: Global enterprise analytics"
19+
max-width="70%"
20+
%}
21+
22+
###Global filters
23+
Filter the view in the Home dashboard by runtimes and date range.
24+
25+
{% include
26+
image.html
27+
lightbox="true"
28+
file="/images/reporting/global-filters.png"
29+
url="/images/reporting/global-filters.png"
30+
alt="Home dashboard: Global filters"
31+
caption="Home dashboard: Global filters"
32+
max-width="60%"
33+
%}
34+
35+
###Runtimes and Managed Clusters
36+
37+
Identify the health of the runtimes and managed clusters in your enterprise.
38+
Health status is displayed for both hosted (if you have Hosted GitOps), and hybrid runtimes.
39+
40+
Managed clusters are external clusters registered to runtimes to which you deploy applications and GitOps-managed resources.
41+
42+
{% include
43+
image.html
44+
lightbox="true"
45+
file="/images/reporting/runtimes-clusters-widgets.png"
46+
url="/images/reporting/runtimes-clusters-widgets.png"
47+
alt="Runtimes and Managed Clusters in the Home dashboard"
48+
caption="Runtimes and Managed Clusters in the Home dashboard"
49+
max-width="80%"
50+
%}
51+
52+
{: .table .table-bordered .table-hover}
53+
| Item| Description|
54+
| ------------------------| ----------------|
55+
|**Runtimes**| Identify failed runtimes.|
56+
|**Managed Clusters**|{::nomarkdown} <ul><li><b>Status</b>: One of the following: <ul><li><b>Connected</b>: Argo CD is able to connect and successfully deploy resources to the cluster.</li><li><b>Failed</b>: Argo CD is unable to connect to the cluster because of authentication, networking, or other issues. </li> <li> <b>Unknown</b>: Argo CD has no information on the cluster as there are no resources deployed to the managed cluster.</li></ul><li><b>View</b>: Click to go to the Runtimes page. <br>To see the runtime's managed clusters, select the runtime.</li> </ul> {:/}|
57+
58+
59+
###Deployments
60+
61+
Identify trends for deployments.
62+
63+
{% include
64+
image.html
65+
lightbox="true"
66+
file="/images/reporting/deployments-widget.png"
67+
url="/images/reporting/deployments-widget.png"
68+
alt="Deployments in the Home dashboard"
69+
caption="Deployments in the Home dashboard"
70+
max-width="70%"
71+
%}
72+
73+
{: .table .table-bordered .table-hover}
74+
| Item| Description|
75+
| ------------------------| ----------------|
76+
|**Daily/Weekly/Monthly**| Granularity for deployment views that affects the average number of deployments and the comparison to the reference period.|
77+
|**Number and Comparison Average**| The number on the top right is the number of successful/failed/rollback deployments for the selected granularity. The percentage is the comparison to the reference period, also for the selected granularity.|
78+
|**Successful**| The number of successful deployments per day, week, or month according to the selected granularity.|
79+
|**Failed Deployments**| The number of successful deployments per day, week, or month according to the selected granularity.|
80+
|**Rollbacks**| The number of successful deployments per day, week, or month according to the selected granularity.|
81+
82+
83+
84+
###Applications
85+
86+
Displays up to five of the most active applications and their current deployment status.
87+
88+
{% include
89+
image.html
90+
lightbox="true"
91+
file="/images/reporting/applications-widget.png"
92+
url="/images/reporting/applications-widget.png"
93+
alt="Applications in the Home dashboard"
94+
caption="Applications in the Home dashboard"
95+
max-width="70%"
96+
%}
97+
98+
{: .table .table-bordered .table-hover}
99+
100+
| Item| Description|
101+
| ------------------------| ----------------|
102+
|**Filter**| Filter applications by the cluster on which they are deployed.|
103+
|**View**| Click to go to the Applications dashboard. See|
104+
|**Application Name**| The name of the application, and the names of the runtime and cluster on which it is deployed. Click the name to drill down into the application in the Applications dashboard.|
105+
|**Health status**| The health status of the application, and can be either:{::nomarkdown}<ul><li>Healthy (green): The application is running on the cluster.</li><li>Degraded (red): The application failed to run.</li> <li>Rollback (yellow): There was a rollback to the previously deployed version.</li></ul> To see the breakdown by health status, mouse over the chart. <br> The number at the end of the bar is the total number of deployments for the application, with the overall decrease or increase compared to the reference period. {:/}|
106+
107+
108+
109+
###Delivery Pipelines
110+
111+
>Delivery Pipline data is shown for hybrid enviroments.
112+
113+
Displays all active pipelines for the selected date range, providing insights into trends for pipelines. Active pipelines are those with at least one active or completed workflow.
114+
Analytics are derived by comparing the selected date range to the corresponding reference period. If your date range is the last seven days, the reference period is the seven days that precede the date range.
115+
116+
{% include
117+
image.html
118+
lightbox="true"
119+
file="/images/reporting/delivery-pipeline-widget.png"
120+
url="/images/reporting/delivery-pipeline-widget.png"
121+
alt="Delivery Pipelines in the Home dashboard"
122+
caption="Delivery Pipelines in the Home dashboard"
123+
max-width="80%"
124+
%}
125+
126+
{: .table .table-bordered .table-hover}
127+
128+
| Item| Description|
129+
| ------------------------| ----------------|
130+
|**Pipelines**| The number prefixed to the pipeline name indicates the change in position of the pipeline compared to the reference period. To drill down into a specific pipeline, click the pipeline.|
131+
|**Filter**| The filters available to focus on the pipelines of interest:{::nomarkdown}<ul><li><b>Status</b>:<ul><li>Succeeded: Pipelines with workflows completed successfully.</li><li>Failed: Pipelines with workflows that failed.</li><li>Error: Pipelines with workflows that resulted in errors.</li></ul><li><b>Repository</b>: The Git repository or repositories tracked, with the events that triggered or ran the pipelines.</li><li><b>Event Type</b>: The Git or Calendar event or events by which to view pipelines. If you select Git push, only those pipelines configured to be run on Git push are displayed.</li> <li><b>Initiator</b>: The user who made the commit that triggered the event and caused the pipeline to run.</li></ul>{:/}|
132+
|**View**| Click to go to the Delivery Pipelines dashboard.|
133+
|**KPI Averages**| KPI averages for: {::nomarkdown}<ul><li>Success Rate: The average number of successful executions, in percentage.</li><li>Average Duration: The average length of time to complete execution, in mm:ss.</li> <li>Executions: The average number of times the pipeline was triggered, in percentage.</li><li>Committers: The number of users whose commits on the repository or repositories triggered the pipelines. User count is aggregated per user, so multiple commits from the same user are counted as a single commit.</li></ul> To see detailed day-to-day values, select a line chart.{:/}|
134+
|**Most Active Delivery Pipelines**| Up to ten pipelines with the highest number of executions. The same KPIs are displayed, and compared to those in the reference period.|
135+
|**Longest Delivery Pipelines**| Up to ten pipelines with the longest duration. The same KPIs are displayed, and compared to those in the reference period.|
136+
137+
###Related articles
138+
[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/)
139+
[Monitoring applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/)
140+
[Images in Codefresh]({{site.baseurl}}/docs/deployments/gitops/images/)
141+
142+

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp