Skip to content

Commit 69d36d3

Browse files
TovRudyyalai97
TovRudyy
and
alai97
authored
[CIVIS-8247] Add custom integration to the Pipeline Visibility setup table (#20971)
* add custom entry in pipeline visibility setup table * pr feedback * linting * fix table * move custom entry to the bottom of the setup section * rename 'Custom' with 'Other CI Providers' * Add Page Navigation --------- Co-authored-by: Austin Lai <[email protected]>
1 parent 2bfec0a commit 69d36d3

File tree

3 files changed

+86
-15
lines changed

3 files changed

+86
-15
lines changed

‎config/_default/menus/menus.en.yaml

+7-2
Original file line numberDiff line numberDiff line change
@@ -2460,16 +2460,21 @@ main:
24602460
parent: pipeline_visibility
24612461
identifier: ci_teamcity
24622462
weight: 209
2463+
- name: Custom Pipelines
2464+
url: continuous_integration/pipelines/custom/
2465+
parent: pipeline_visibility
2466+
identifier: ci_custom
2467+
weight: 210
24632468
- name: Custom Commands
24642469
url: continuous_integration/pipelines/custom_commands/
24652470
parent: pipeline_visibility
24662471
identifier: ci_custom_commands
2467-
weight: 210
2472+
weight: 211
24682473
- name: Custom Tags and Metrics
24692474
url: continuous_integration/pipelines/custom_tags_and_metrics/
24702475
parent: pipeline_visibility
24712476
identifier: ci_custom_tags_and_metrics
2472-
weight: 211
2477+
weight: 212
24732478
- name: Search and Manage
24742479
url: continuous_integration/search/
24752480
parent: ci

‎content/en/continuous_integration/pipelines/_index.md

+25-13
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ cascade:
3838
{{< nextlink href="continuous_integration/pipelines/gitlab" >}}GitLab{{< /nextlink >}}
3939
{{< nextlink href="continuous_integration/pipelines/jenkins" >}}Jenkins{{< /nextlink >}}
4040
{{< nextlink href="continuous_integration/pipelines/teamcity" >}}TeamCity{{< /nextlink >}}
41+
{{< nextlink href="continuous_integration/pipelines/custom" >}}Other CI Providers{{< /nextlink >}}
4142
{{< nextlink href="continuous_integration/pipelines/custom_commands" >}}Custom Commands{{< /nextlink >}}
4243
{{< nextlink href="continuous_integration/pipelines/custom_tags_and_metrics" >}}Custom Tags and Metrics{{< /nextlink >}}
4344
{{< /whatsnext >}}
@@ -127,26 +128,37 @@ While the concept of a CI pipeline may vary depending on your provider, see how
127128
| Job | Action |
128129
| Step | |
129130

131+
{{% /tab %}}
132+
133+
{{% tab "Other CI Providers" %}}
134+
135+
| Datadog | Other CI Providers |
136+
|---|---|
137+
| Pipeline | Pipeline |
138+
| Stage | Stage |
139+
| Job | Job |
140+
| Step | Step |
141+
130142
{{% /tab %}}
131143
{{< /tabs >}}
132144

133145
If your CI provider is not supported, you can try setting up Pipeline Visibility through the [public API endpoint][2].
134146

135147
### Supported features
136148

137-
| | Jenkins | GitLab | CircleCI | Buildkite | GitHub Actions | Azure Pipelines | Codefresh | TeamCity | AWS Code Pipeline |
138-
|---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
139-
| {{< ci-details title="Pipeline trace visualization" >}}Visualization of pipeline executions with associated tracing.{{< /ci-details >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} |
140-
| {{< ci-details title="Partial retries" >}}Identification of partial retries (for example, when only a subset of jobs were retried).{{< /ci-details >}} | | {{< X >}} | | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} |
141-
| {{< ci-details title="Manual steps" >}}Identification of when there is a job with a manual approval phase in the overall pipeline.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | {{< X >}} | | |
142-
| {{< ci-details title="Queue time" >}}Identification of the amount of time for which a pipeline or job was in the queue before execution.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | |
143-
| {{< ci-details title="Logs correlation" >}}Retrieval of pipeline or job logs from the CI provider. Logs are displayed on the <strong>Logs</strong> tab in the Pipeline Execution view.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | | {{< X >}} | | | | |
144-
| {{< ci-details title="Infrastructure metric correlation" >}}Correlation of host-level information for the Datadog Agent, CI pipelines, or job runners to CI pipeline execution data.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | | | |
145-
| {{< ci-details title="Custom spans for traced commands using datadog-ci" >}}Support for sending command-level events to CI Visibility to be incorporated into pipeline flame graph visualization. You can then query and analyze <a href="https://docs.datadoghq.com/continuous_integration/pipelines/custom_commands/">these events</a>. {{< /ci-details >}} | {{< X >}} | | {{< X >}} | | {{< X >}} | | | | |
146-
| {{< ci-details title="Custom predefined tags" >}}Support for setting static pipeline tags in the CI provider that do not change between executions.{{< /ci-details >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | | |
147-
| {{< ci-details title="Custom tags and metrics at runtime" >}}Support for adding <a href="https://docs.datadoghq.com/continuous_integration/pipelines/custom_tags_and_metrics/">user-defined text and numerical tags</a> to pipelines and jobs in CI Visibility.{{< /ci-details >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | |
148-
| {{< ci-details title="Parameters" >}}Support for adding custom pipeline parameters that users set (for example, <code>DYNAMICS_IS_CHILD:true</code>). You can then search using these parameters in the <a href="https://docs.datadoghq.com/continuous_integration/explorer/?tab=pipelineexecutions">CI Visibility Explorer</a> to find all events with a specific parameter.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | | | | {{< X >}} | | |
149-
| {{< ci-details title="Pipeline failure reason" >}}Identification of a specific reason behind a pipeline or job failure.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | | | | {{< X >}} | {{< X >}} | {{< X >}} |
149+
| | Jenkins | GitLab | CircleCI | Buildkite | GitHub Actions | Azure Pipelines | Codefresh | TeamCity | AWS Code Pipeline | Other CI Providers |
150+
|---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
151+
| {{< ci-details title="Pipeline trace visualization" >}}Visualization of pipeline executions with associated tracing.{{< /ci-details >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} |
152+
| {{< ci-details title="Partial retries" >}}Identification of partial retries (for example, when only a subset of jobs were retried).{{< /ci-details >}} | | {{< X >}} | | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} |
153+
| {{< ci-details title="Manual steps" >}}Identification of when there is a job with a manual approval phase in the overall pipeline.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | {{< X >}} | | | {{< X >}} |
154+
| {{< ci-details title="Queue time" >}}Identification of the amount of time for which a pipeline or job was in the queue before execution.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | {{< X >}} |
155+
| {{< ci-details title="Logs correlation" >}}Retrieval of pipeline or job logs from the CI provider. Logs are displayed on the <strong>Logs</strong> tab in the Pipeline Execution view.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | | {{< X >}} | | | | | |
156+
| {{< ci-details title="Infrastructure metric correlation" >}}Correlation of host-level information for the Datadog Agent, CI pipelines, or job runners to CI pipeline execution data.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | | | | |
157+
| {{< ci-details title="Custom spans for traced commands using datadog-ci" >}}Support for sending command-level events to CI Visibility to be incorporated into pipeline flame graph visualization. You can then query and analyze <a href="https://docs.datadoghq.com/continuous_integration/pipelines/custom_commands/">these events</a>. {{< /ci-details >}} | {{< X >}} | | {{< X >}} | | {{< X >}} | | | | | |
158+
| {{< ci-details title="Custom predefined tags" >}}Support for setting static pipeline tags in the CI provider that do not change between executions.{{< /ci-details >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | | | |
159+
| {{< ci-details title="Custom tags and metrics at runtime" >}}Support for adding <a href="https://docs.datadoghq.com/continuous_integration/pipelines/custom_tags_and_metrics/">user-defined text and numerical tags</a> to pipelines and jobs in CI Visibility.{{< /ci-details >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | | {{< X >}} |
160+
| {{< ci-details title="Parameters" >}}Support for adding custom pipeline parameters that users set (for example, <code>DYNAMICS_IS_CHILD:true</code>). You can then search using these parameters in the <a href="https://docs.datadoghq.com/continuous_integration/explorer/?tab=pipelineexecutions">CI Visibility Explorer</a> to find all events with a specific parameter.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | | | | {{< X >}} | | | {{< X >}} |
161+
| {{< ci-details title="Pipeline failure reason" >}}Identification of a specific reason behind a pipeline or job failure.{{< /ci-details >}} | {{< X >}} | {{< X >}} | | | | | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} |
150162

151163
## Use CI pipelines data
152164

‎content/en/continuous_integration/pipelines/custom.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Send custom pipelines to Datadog
3+
kind: documentation
4+
aliases:
5+
- /continuous_integration/setup_pipelines/custom
6+
further_reading:
7+
- link: "/continuous_integration/pipelines"
8+
tag: "Documentation"
9+
text: "Explore Pipeline Execution Results and Performance"
10+
- link: "/continuous_integration/guides/pipeline_data_model"
11+
tag: "Documentation"
12+
text: "Learn about the Pipeline Data Model and Execution Types"
13+
- link: "/continuous_integration/troubleshooting/"
14+
tag: "Documentation"
15+
text: "Troubleshooting CI"
16+
17+
---
18+
19+
{{< site-region region="gov" >}}
20+
<div class="alert alert-warning">CI Visibility is not available in the selected site ({{< region-param key="dd_site_name" >}}) at this time.</div>
21+
{{< /site-region >}}
22+
23+
## Compatibility
24+
25+
- **Custom tags and metrics**: Attach custom tags and metrics to pipeline executions
26+
27+
- **Manual steps**: View manually triggered pipelines
28+
29+
- **Parameters**: Set custom parameters to pipelines
30+
31+
- **Partial pipelines**: View partially retried pipelines
32+
33+
- **Pipeline failure reasons**: Identify pipeline failure reasons from error messages
34+
35+
- **Queue time**: View amount of time pipeline jobs sit in the queue before processing
36+
37+
## Send pipelines to Datadog
38+
39+
Send custom pipelines through HTTP using the [public API endpoint][1]. For details about how pipeline executions are modeled, see [Pipeline Data Model and Execution Types][2].
40+
41+
## Visualize pipeline data in Datadog
42+
43+
The [Pipelines][3] and [Pipeline Executions][4] pages populate with data after the pipelines are accepted for processing.
44+
45+
**Note**: The Pipelines page shows data for only the default branch of each repository.
46+
47+
## Further reading
48+
49+
{{< partial name="whats-next/whats-next.html" >}}
50+
51+
[1]: /api/latest/ci-visibility-pipelines/#send-pipeline-event
52+
[2]: /continuous_integration/guides/pipeline_data_model/
53+
[3]: https://app.datadoghq.com/ci/pipelines
54+
[4]: https://app.datadoghq.com/ci/pipeline-executions

0 commit comments

Comments
 (0)