CI Pipeline Visibility in Datadog
CI Visibility is not available in the selected site () at this time.
Overview
Pipeline Visibility provides a pipeline-first view into your CI health by displaying important metrics and results from your pipelines. It helps you troubleshoot pipeline failures, address performance bottlenecks, and track CI performance and reliability over time.
Setup
Select your CI provider to set up Pipeline Visibility in Datadog:
Terminology
While the concept of a CI pipeline may vary depending on your provider, see how those concepts correspond to the definition of a CI pipeline in Datadog Pipeline Visibility:
Datadog | GitHub Actions |
---|
Pipeline | Workflow |
Job | Job |
Step | Step |
Datadog | GitLab |
---|
Pipeline | Pipeline |
Stage | Stage |
Job | Job |
Not available in Datadog | Script |
Datadog | Jenkins |
---|
Pipeline | Pipeline |
Stage | Stage |
Job | Step |
Datadog | CircleCI |
---|
Pipeline | Workflow |
Job | Job |
Not available in Datadog | Step |
Datadog | Buildkite |
---|
Pipeline | Pipeline |
Job | Job |
Not available in Datadog | Step |
Datadog | TeamCity |
---|
Pipeline | Build Chain |
Job | Build |
Not available in Datadog | Step |
Datadog | Azure Pipelines |
---|
Pipeline | Pipeline |
Stage | Stage |
Job | Job |
Not available in Datadog | Step |
Datadog | AWS CodePipeline |
---|
Pipeline | Pipeline |
Stage | Stage |
Job | Action |
Datadog | Other CI Providers |
---|
Pipeline | Pipeline |
Stage | Stage |
Job | Job |
Step | Step |
If your CI provider is not supported, you can try setting up Pipeline Visibility through the public API endpoint.
Supported features
| Jenkins | GitLab | CircleCI | Buildkite | GitHub Actions | Azure Pipelines | Codefresh | TeamCity | AWS CodePipeline | Other CI Providers |
---|
Pipeline trace visualization
Visualization of pipeline executions with associated tracing. | | | | | | | | | | |
Running pipelines
Identification of pipelines executions that are running with associated tracing. | | | | | | | | | | |
Partial retries
Identification of partial retries (for example, when only a subset of jobs were retried). | | | | | | | | | | |
Step spans
Step level spans are available for more granular visibility. |
(But are presented as job spans) | | | | | | | | | |
Manual steps
Identification of when there is a job with a manual approval phase in the overall pipeline. | | | | | | | | | | |
Approval wait time
Time for which a pipeline or job has been waiting for a manual approval. | | | | | | | | | | |
Queue time
Time for which a pipeline or job was in the queue before execution. | | | | | | | | | | |
Execution time
Time for which a pipeline has been actively running jobs. | | | | | | | | | | |
Logs correlation
Retrieval of pipeline or job logs from the CI provider. Logs are displayed on the Logs tab in the Pipeline Execution view. | | | | | | | | | | |
Infrastructure metric correlation
Correlation of host-level information for the Datadog Agent, CI pipelines, or job runners to CI pipeline execution data. | | | | | | | | | | |
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 these events. | | | | | | | | | | |
Custom predefined tags
Support for setting static pipeline tags in the CI provider that do not change between executions. | | | | | | | | | | |
Custom tags and measures at runtime
Support for adding user-defined text and numerical tags to pipelines and jobs in CI Visibility. | | | | | | | | | | |
Parameters
Support for adding custom pipeline parameters that users set (for example, DYNAMICS_IS_CHILD:true ). You can then search using these parameters in the CI Visibility Explorer to find all events with a specific parameter. | | | | | | | | | | |
Pipeline failure reason
Identification of a specific reason behind a pipeline or job failure. | | | | | | | | | | |
Use CI pipelines data
When creating a dashboard or a notebook, you can use CI pipeline data in your search query, which updates the visualization widget options. For more information, see the Dashboards and Notebooks documentation.
Alert on pipeline data
You can export your search query to a CI Pipeline monitor on the Executions page or the Test Runs page by clicking the Export button.
Further reading
Additional helpful documentation, links, and articles: