You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jekyll/_cci2/insights-snapshot-badge.adoc
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,11 @@ contentTags:
14
14
[#overview]
15
15
== Overview
16
16
17
-
The Insights snapshot badge, similar to a <<status-badges#,status badge>> that is commonly embedded in project READMEs, provides a quick view of your project's health and usage metrics.
17
+
The Insights snapshot badge, similar to a xref:status-badges#[status badge] that is commonly embedded in project READMEs, provides a quick view of your project's health and usage metrics.
18
18
19
19
image::insights-snapshot-badge-example.png[Insights snapshot badge embedded on README]
20
20
21
-
The most common use case for the Insights snapshot badge is to display <<insights#,Insights>> metrics for the deployment workflow on the project’s main branch in the README. With that said, the badge can be configured to display Insights metrics for any workflow on any branch within a project. This enables you to create additional badges for your scheduled workflows, workflows with different build targets, or workflows specifically used for testing, to name a few examples.
21
+
The most common use case for the Insights snapshot badge is to display xref:insights#[Insights] metrics for the deployment workflow on the project’s main branch in the README. With that said, the badge can be configured to display Insights metrics for any workflow on any branch within a project. This enables you to create additional badges for your scheduled workflows, workflows with different build targets, or workflows specifically used for testing, to name a few examples.
22
22
23
23
While commonly placed in a project README, Insights snapshot badges can be embedded in any web document. The badge currently displays the following three metrics from the Insights dashboard:
24
24
@@ -30,7 +30,7 @@ While commonly placed in a project README, Insights snapshot badges can be embed
30
30
[#generating-an-insights-snapshot-badge]
31
31
== Generating an Insights snapshot badge
32
32
33
-
To generate an insights snapshot badge code snippet for a public repository, go to the https://app.circleci.com/[CircleCI web app], and select a specific project. Then, open *Project Settings* and navigate to the *Insights Snapshot Badge* page.
33
+
To generate an insights snapshot badge code snippet for a public repository, go to the link:https://app.circleci.com/[CircleCI web app], and select a specific project. Then, open *Project Settings* and navigate to the *Insights Snapshot Badge* page.
34
34
35
35
On the Insights Snapshot Badge page, you can select the branch, workflow, and time window for which you want to display project metrics for, as well as the desired format for the code snippet.
36
36
@@ -59,8 +59,8 @@ You can add an API token directly from the Insights Snapshot Badge page by click
Copy file name to clipboardExpand all lines: jekyll/_cci2/insights.md
+28-33Lines changed: 28 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -15,79 +15,74 @@ contentTags:
15
15
## Overview
16
16
{: #overview }
17
17
18
-
19
18
The CircleCI Insights dashboard provides an overview of the health and usage of
20
-
your repository build processes, allowing users to make better engineering
21
-
decisions. _Insights_ provides time-series data overviews of credit usage,
22
-
success rates, pipeline duration, and other pertinent information.
19
+
your projects' build processes, including time-series and aggreggated data on credit usage,
20
+
success rates, and pipeline duration.
23
21
24
-
This document describes how to access and use the Insights dashboard on CircleCI Cloud and Server.
22
+
This document describes how to access and use the Insights dashboard on CircleCI cloud and server.
25
23
26
24
## Usage
27
25
{: #usage }
28
26
29
27
Insights across your organization can be accessed from the sidebar of the
30
28
CircleCI web application.
31
29
32
-
To access a specific project's insights, view a pipeline's workflow and click
30
+
To access a specific project's Insights, view a pipeline's workflow and click
33
31
the **Insights** button. Alternatively, you may access the Insights page by
34
-
clicking on the**actions**button while viewing the _pipelines dashboard_.
32
+
opening a pipeline's**Actions**menu while viewing the pipelines dashboard.
35
33
36
34
{:.tab.insight-access.Access_by_sidebar}
37
35
38
36
39
-
{:.tab.insight-access.Access_by_pipeline}
40
-
41
-
42
37
{:.tab.insight-access.Access_by_workflow}
43
38
44
39
40
+
{:.tab.insight-access.Access_by_pipeline}
41
+
45
42
46
43
### Workflow overview
47
44
{: #workflow-overview }
48
45
49
-
The Insights dashboard provides workflow details plotted over time.
50
-
**Please note that the data is not real time and there may be up to a 24 hour
51
-
delay**. You may also filter by different workflows at the top of the page. The
52
-
following data is charted under the workflow overview:
46
+
The Insights workflow overview provides metrics plotted over time for all branches, or a select branch, of a particular project workflow. The following data is charted under the workflow overview:
53
47
54
-
-All workflow runs
48
+
-Status (success versus failed) of up to 100 most recent workflow runs
55
49
- Workflow success rate
56
-
- Workflow duration
57
-
- Workflow credit usage*
50
+
- Workflow duration (50th versus 95th percentile)
51
+
- Workflow credit usage
52
+
53
+
Data is not real-time and there may be up to a 24 hour delay.
54
+
{: class="alert alert-info"}
55
+
56
+
The Insights dashboard is not a real time financial reporting tool and should
57
+
not be used for credit reporting. The most up-to-date credit information can be
58
+
found in your organization's Plan Overview.
59
+
{: class="alert alert-info"}
58
60
59
61
### Job overview
60
62
{: #job-overview }
61
63
62
-
Switch to the **Job** tab to view cumulative time-series data on a per-job basis:
64
+
Click the **Jobs** tab next to **Overview** to view the following cumulative data on a per-job basis:
63
65
64
-
- Total credits used*
65
-
- Duration (the 95th percentile)
66
+
- Total credits used
67
+
- Duration (95th percentile)
66
68
- Total runs
67
69
- Success rate
68
-
69
-
70
-
<small>
71
-
<i> * The Insights dashboard is not a real time financial reporting tool and should
72
-
not be used for credit reporting. The most up to date credit information can be
73
-
found in your organization's Plan Overview.</i>
74
-
</small>
70
+
- Compute usage (average and max for CPU and RAM)
75
71
76
72
---
77
73
78
74
## CircleCI Server v2.19.x Insights
79
75
{: #circleci-server-v219x-insights }
80
76
81
-
⚠️ **Heads up!**
82
77
The following section refers to using the Insights page on installations of CircleCI Server v2.19.x.
83
78
{: class="alert alert-warning"}
84
79
85
80
### Overview
86
81
{: #overview }
87
82
88
-
Click the Insights menu item in the CircleCI app to view a dashboard showing the health of all repositories you are following. Median build time, median queue time, last build time, success rate, and parallelism appear for your default branch. **Note:** If you have configured Workflows, graphs display all of the jobs that are being executed for your default branch.
83
+
Click the Insights menu item in the CircleCI app to view a dashboard showing the health of all repositories you are following. Median build time, median queue time, last build time, success rate, and parallelism appear for your default branch. Note that if you have configured Workflows, graphs display all of the jobs that are being executed for your default branch.
-**Build Status:** The Insights dashboard shows the last 50 builds for your default branch. Click a branch in the top right corner to access over 100 build/job statuses for the selected branch.
110
105
@@ -114,8 +109,8 @@ The per-project insights page gives you access to the build status and build per
114
109
## See also
115
110
{: #see-also }
116
111
117
-
Refer to the [Collecting Test Metadata]({{ site.baseurl }}/collect-test-data/) document for instructions to configure insights into your most failed tests.
112
+
Refer to the [Collect Test Data](/docs/collect-test-data/) document for guidance on configuring Insights into your most failed tests.
118
113
119
114
## Learn More
120
115
{: #learn-more }
121
-
Take the [insights course](https://academy.circleci.com/insights-course?access_code=public-2021) with CircleCI Academy to learn more.
116
+
Take the [Insights course](https://academy.circleci.com/insights-course?access_code=public-2021) with CircleCI Academy to learn more.
0 commit comments