-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[SDCT-533] Differentiate log storage from CI jobs failure analysis #40056
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 4 commits
7947551
de4bfb9
29301b4
e7992fc
588fe85
b68e0f9
9b1bb5d
8839124
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -29,7 +29,7 @@ Set up CI Visibility for Azure Pipelines to gain real time insights into your CI | |||||
| | Pipeline Visibility | Platform | Definition | | ||||||
| |-------------------------------------------------|-------------------------------------|-----------------------------------------------------------| | ||||||
| | [CI jobs failure analysis][21] | CI jobs failure analysis | Use LLM models on relevant logs to analyze the root cause of failed CI jobs. | | ||||||
| | Logs correlation | Logs correlation | Correlate pipeline and job spans to logs. Requires [job log collection](#collect-job-logs). | | ||||||
| | Logs correlation | Logs correlation | Correlate pipeline and job spans to logs. Requires [job log storage](#store-job-logs). | | ||||||
| | [Custom tags][10] [and measures at runtime][11] | Custom tags and measures at runtime | Configure [custom tags and measures][6] at runtime. | | ||||||
| | [Custom spans][15] | Custom spans | Configure custom spans for your pipelines. | | ||||||
| | [Filter CI Jobs on the critical path][19] | Filter CI Jobs on the critical path | Filter by jobs on the critical path. | | ||||||
|
|
@@ -158,25 +158,21 @@ Example for enabling the hooks in specified projects: | |||||
|
|
||||||
| You can set custom tags for all pipeline and job spans from your Azure projects to improve traceability. For more information, see [Custom Tags and Measures][6]. | ||||||
|
|
||||||
| ### Collect job logs | ||||||
| ### Manage job logs | ||||||
|
|
||||||
| To enable log collection for Azure DevOps pipelines: | ||||||
| CI jobs failure analysis uses LLM models to compute the analysis for failed CI jobs based on relevant logs coming from Azure Pipelines. | ||||||
|
|
||||||
| You can also add job failure analysis to a PR comment. See the guide on [using PR comments][22]. | ||||||
|
|
||||||
| 1. Set up the Datadog Azure DevOps integration by following the steps in the [Azure integration tile][14]. | ||||||
|
|
||||||
| 2. In Datadog, open [**CI/CD Optimization** > **Settings** > **Azure DevOps**][23]. | ||||||
| 3. Enable log pulling for Azure DevOps. | ||||||
|
|
||||||
| Logs are billed separately from CI Visibility. Log retention, exclusion, and indexes are configured in [Log Management][18]. Logs for Azure jobs can be identified by the `datadog.product:cipipeline` and `source:azurepipelines` tags. | ||||||
| For a full explanation, see the guide on [using CI jobs failure analysis][21]. | ||||||
|
|
||||||
| ### CI jobs failure analysis | ||||||
| This feature is enabled by default. To manage Log Analysis settings, go to [CI/CD Repository settings][23], and configure Log Analysis at the Datadog organization level or for the desired repositories. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion: Same repetition here — "Log Analysis" appears twice in the sentence. Also the referent of "This feature" is a bit distant (the section heading is "Manage job logs" but the feature described is CI jobs failure analysis). Consider naming it explicitly:
Suggested change
|
||||||
|
|
||||||
| If job logs collection is enabled, CI Visibility uses LLM models to compute the analysis for failed CI jobs based on relevant logs coming from Azure Pipelines. | ||||||
| #### Store job logs | ||||||
|
|
||||||
| You can also add job failure analysis to a PR comment. See the guide on [using PR comments][22]. | ||||||
| To enable Log Storage, go to [CI/CD Repository settings][23], and enable Log Storage at the Datadog organization level or for the desired repositories. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Style: The phrasing repeats "Log Storage" twice in one sentence, and the capitalization is inconsistent with
Suggested change
|
||||||
|
|
||||||
| For a full explanation, see the guide on [using CI jobs failure analysis][21]. | ||||||
| Log Storage is billed separately from CI Visibility. Log retention, exclusion, and indexes are configured in [Log Management][18]. Logs for Azure jobs can be identified by the `datadog.product:cipipeline` and `source:azurepipelines` tags. | ||||||
|
|
||||||
| ## Visualize pipeline data in Datadog | ||||||
|
|
||||||
|
|
@@ -195,12 +191,11 @@ The {{< ui >}}CI Pipeline List{{< /ui >}} page shows data for only the default b | |||||
| [9]: https://learn.microsoft.com/en-us/azure/devops/pipelines/process/approvals?view=azure-devops&tabs=check-pass#approvals | ||||||
| [10]: /glossary/#custom-tag | ||||||
| [11]: /glossary/#custom-measure | ||||||
| [14]: https://app.datadoghq.com/integrations/azure | ||||||
| [15]: /glossary/#custom-span | ||||||
| [17]: /continuous_integration/search/#search-for-pipelines | ||||||
| [18]: /logs/guide/best-practices-for-log-management/ | ||||||
| [19]: /continuous_integration/guides/identify_highest_impact_jobs_with_critical_path/ | ||||||
| [20]: /glossary/#pipeline-execution-time | ||||||
| [21]: /continuous_integration/guides/use_ci_jobs_failure_analysis/ | ||||||
| [22]: /continuous_integration/guides/use_ci_jobs_failure_analysis/#using-pr-comments | ||||||
| [23]: https://app.datadoghq.com/ci/settings/ci-cd/azure-devops | ||||||
| [23]: https://app.datadoghq.com/ci/settings/ci-cd/repositories?tab=repository | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,14 +25,15 @@ Set up CI Visibility for Buildkite to optimize your resource usage, reduce overh | |
| | Pipeline Visibility | Platform | Definition | | ||
| |---|---|---| | ||
| | [Partial retries][9] | Partial pipelines | View partially retried pipeline executions. | | ||
| | [CI jobs failure analysis][22] | CI jobs failure analysis | Uses LLM models on relevant logs to analyze the root cause of failed CI jobs. | | ||
| | Infrastructure metric correlation | Infrastructure metric correlation | Correlate jobs to [infrastructure host metrics][6] for Buildkite agents. | | ||
| | [Manual steps][12] | Manual steps | View manually triggered pipelines. | | ||
| | [Queue time][13] | Queue time | View the amount of time pipeline jobs sit in the queue before processing. | | ||
| | [Custom tags][10] [and measures at runtime][11] | Custom tags and measures at runtime | Configure [custom tags and measures][6] at runtime. | | ||
| | [Custom spans][14] | Custom spans | Configure custom spans for your pipelines. | | ||
| | [Filter CI Jobs on the critical path][17] | Filter CI Jobs on the critical path | Filter by jobs on the critical path. | | ||
| | [Execution time][18] | Execution time | View the amount of time pipelines have been running jobs. | | ||
| | Logs correlation | Logs correlation | Correlate pipeline and job spans to logs and enable [job log collection][20]. | | ||
| | Logs correlation | Logs correlation | Correlate pipeline and job spans to logs and enable [job log storage][20]. | | ||
|
|
||
|
|
||
| ### Terminology | ||
|
|
@@ -57,11 +58,21 @@ To set up the Datadog integration for [Buildkite][1]: | |
| * {{< ui >}}Branch filtering{{< /ui >}}: Leave empty to trace all branches or select the subset of branches you want to trace. | ||
| 3. Click {{< ui >}}Add Datadog Pipeline Visibility Notification{{< /ui >}} to save the integration. | ||
|
|
||
| ### Collect job logs | ||
| ### Manage job logs | ||
|
|
||
| CI jobs failure analysis uses LLM models to compute the analysis for failed CI jobs based on relevant logs coming from Buildkite. | ||
|
gbrandrea marked this conversation as resolved.
gbrandrea marked this conversation as resolved.
|
||
|
|
||
| For a full explanation, see the guide on [using CI jobs failure analysis][22]. | ||
|
|
||
| Log Analysis is enabled by default in Datadog. To receive Buildkite job logs for analysis, add your API token in the [Buildkite integration tile][19]. To manage Log Analysis settings, go to [CI/CD Repository settings][23], and configure Log Analysis at the Datadog organization level or for the desired repositories. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Should we mention this here instead of sending them to the Buildkite integration tile, I guess the documentation contains more elaborate steps, including the integration tile? |
||
|
|
||
| #### Store job logs | ||
|
|
||
| The Datadog Buildkite integration collects logs from your finished Buildkite jobs and forwards them to Datadog. To install and configure this integration, see the [Buildkite integration documentation][19]. | ||
|
|
||
| Datadog bills logs separately from CI Visibility. Configure log retention, exclusion filters, and indexes in [Log Management][21]. To scope these rules to Buildkite logs, filter on the `datadog.product:cipipeline` and `source:buildkite` tags. | ||
| To enable Log Storage, go to [CI/CD Repository settings][23], and enable Log Storage at the Datadog organization level or for the desired repositories. | ||
|
|
||
| Log Storage is billed separately from CI Visibility. Configure log retention, exclusion filters, and indexes in [Log Management][21]. To scope these rules to Buildkite logs, filter on the `datadog.product:cipipeline` and `source:buildkite` tags. | ||
|
|
||
| ## Advanced configuration | ||
|
|
||
|
|
@@ -163,5 +174,7 @@ The {{< ui >}}CI Pipeline List{{< /ui >}} page shows data for only the default b | |
| [17]: /continuous_integration/guides/identify_highest_impact_jobs_with_critical_path/ | ||
| [18]: /glossary/#pipeline-execution-time | ||
| [19]: /integrations/buildkite/ | ||
| [20]: /continuous_integration/pipelines/buildkite/#collect-job-logs | ||
| [20]: /continuous_integration/pipelines/buildkite/#store-job-logs | ||
| [21]: /logs/ | ||
| [22]: /continuous_integration/guides/use_ci_jobs_failure_analysis/ | ||
| [23]: https://app.datadoghq.com/ci/settings/ci-cd/repositories?tab=repository | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,7 +28,8 @@ Set up CI Visibility for CircleCI to optimize the performance of your pipelines, | |
| | Pipeline Visibility | Platform | Definition | | ||
| |---|---|---| | ||
| | [Partial retries][12] | Partial pipelines | View partially retried pipeline executions. | | ||
| | Logs correlation | Logs correlation | Correlate pipeline and job spans to logs and enable [job log collection][10]. | | ||
| | [CI jobs failure analysis][20] | CI jobs failure analysis | Uses LLM models on relevant logs to analyze the root cause of failed CI jobs. | | ||
| | Logs correlation | Logs correlation | Correlate pipeline and job spans to logs and enable [job log storage][10]. | | ||
| | [Custom spans][13] | Custom spans | Configure custom spans for your pipelines. | | ||
| | Custom pre-defined tags | Custom pre-defined tags | Set [custom tags][6] to all generated pipeline and job spans. | | ||
| | [Custom tags][14] [and measures at runtime][15] | Custom tags and measures at runtime | Configure [custom tags and measures][7] at runtime. | | ||
|
|
@@ -103,11 +104,21 @@ If a `key:value` pair contains any commas, surround it with quotes. For example, | |
|
|
||
| To display and filter the teams associated with your pipelines, add `team:<your-team>` as a custom tag. The custom tag name must match your [Datadog Teams][8] team handle exactly. | ||
|
|
||
| ### Collect job logs | ||
| ### Manage job logs | ||
|
gbrandrea marked this conversation as resolved.
|
||
|
|
||
| CI jobs failure analysis uses LLM models to compute the analysis for failed CI jobs based on relevant logs coming from CircleCI. | ||
|
|
||
| For a full explanation, see the guide on [using CI jobs failure analysis][20]. | ||
|
|
||
| Log Analysis is enabled by default in Datadog. To receive CircleCI job logs for analysis, add your API token in the [CircleCI integration tile][11]. To manage Log Analysis settings, go to [CI/CD Repository settings][22], and configure Log Analysis at the Datadog organization level or for the desired repositories. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Should we mention this here instead of sending them to the CircleCI integration tile, I guess the documentation contains more elaborate steps, including the integration tile? |
||
|
|
||
| #### Store job logs | ||
|
|
||
| The Datadog CircleCI integration collects logs from your finished CircleCI jobs and forwards them to Datadog. To install and configure this integration, see the [CircleCI integration documentation][11]. | ||
|
|
||
| Logs are billed separately from CI Visibility. Log retention, exclusion, and indexes are configured in [Log Management][16]. Logs for CircleCI jobs can be identified by the `datadog.product:cipipeline` and `source:circleci` tags. | ||
| To enable Log Storage, go to [CI/CD Repository settings][22], and enable Log Storage at the Datadog organization level or for the desired repositories. | ||
|
|
||
| Log Storage is billed separately from CI Visibility. Log retention, exclusion, and indexes are configured in [Log Management][16]. Logs for CircleCI jobs can be identified by the `datadog.product:cipipeline` and `source:circleci` tags. | ||
|
|
||
| ## Visualize pipeline data in Datadog | ||
|
|
||
|
|
@@ -128,7 +139,7 @@ The {{< ui >}}CI Pipeline List{{< /ui >}} page shows data for only the default b | |
| [7]: /continuous_integration/pipelines/custom_tags_and_measures/?tab=linux | ||
| [8]: /account_management/teams/ | ||
| [9]: https://raw.githubusercontent.com/DataDog/ci-visibility-circle-ci/main/service_hooks.py | ||
| [10]: /continuous_integration/pipelines/circleci/#enable-log-collection | ||
| [10]: /continuous_integration/pipelines/circleci/#store-job-logs | ||
| [11]: /integrations/circleci/#setup | ||
| [12]: /glossary/#partial-retry | ||
| [13]: /glossary/#custom-span | ||
|
|
@@ -137,4 +148,6 @@ The {{< ui >}}CI Pipeline List{{< /ui >}} page shows data for only the default b | |
| [16]: /logs/guide/best-practices-for-log-management/ | ||
| [17]: /continuous_integration/search/#search-for-pipelines | ||
| [18]: /continuous_integration/guides/identify_highest_impact_jobs_with_critical_path/ | ||
| [19]: /glossary/#pipeline-execution-time | ||
| [19]: /glossary/#pipeline-execution-time | ||
| [20]: /continuous_integration/guides/use_ci_jobs_failure_analysis/ | ||
| [22]: https://app.datadoghq.com/ci/settings/ci-cd/repositories?tab=repository | ||
Uh oh!
There was an error while loading. Please reload this page.