Conversation
…nalysis Update the CI Pipeline Visibility docs for the new decoupled log storage / log analysis flow: rename "Logs collection" to "Log storage" to match the UI, merge each provider's log storage and CI jobs failure analysis instructions into a single "Manage job logs" section, and add the missing failure analysis setup for CircleCI and Buildkite.
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Restructure of the CI Visibility pages to introduce a new Manage job logs section that separates Log Analysis (LLM job failure analysis) from Log Storage. A few things to address before merging: the terminology Log storage / Log Storage is capitalized inconsistently across pages, the Buildkite and CircleCI compatibility tables do not reflect the newly-documented job failure analysis support, and a few minor style/formatting issues.
Reviewed 79475513de6c3118b7a02930a4824a5d019f379f — workflow run
| #### 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. |
There was a problem hiding this comment.
Style: The phrasing repeats "Log Storage" twice in one sentence, and the capitalization is inconsistent with search/_index.md and pipelines/_index.md, which both use lowercase "log storage". Unless "Log Storage" is the exact UI label, prefer lowercase to match the rest of the CI docs. The identical repetitive pattern ("To enable Log Storage, ..., and enable Log Storage ...") also appears in buildkite.md:72, circleci.md:118, github.md:108, and gitlab.md:437 — worth harmonizing them together.
| 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. | |
| To enable log storage, go to [CI/CD Repository settings][23] and toggle it on at the Datadog organization level or for individual repositories. |
| 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. |
There was a problem hiding this comment.
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:
| 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. | |
| CI jobs failure analysis is enabled by default. To manage its settings, go to [CI/CD Repository settings][23] and configure Log Analysis at the Datadog organization level or for individual repositories. |
|
|
||
| For a full explanation, see the guide on [using CI jobs failure analysis][28]. | ||
|
|
||
| This feature is enabled by default, but requires job logs to be enabled on the GitLab side. See [Store job logs](#store-job-logs) below. |
There was a problem hiding this comment.
Style: "on the GitLab side" is informal. Also the anchor link text should match the actual section heading casing.
| This feature is enabled by default, but requires job logs to be enabled on the GitLab side. See [Store job logs](#store-job-logs) below. | |
| This feature is enabled by default, but requires job logs to be enabled in GitLab. See [Store job logs](#store-job-logs) below. |
![datadog-datadog-us1-prod[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
There was a problem hiding this comment.
The linked guide still excludes Buildkite and CircleCI. It also says that failure analysis requires indexed logs, which conflicts with the new separate controls.
🤖 Datadog Autotest · Commit 7947551 · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest
|
/review |
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
A few clarity issues in the GitLab "Manage job logs" section — the wording conflates Datadog's Log Storage with GitLab's own log forwarding. Otherwise the terminology rename (Logs collection → Log Storage, plus the new "Manage job logs" grouping) looks consistent across the CI provider pages.
Reviewed e7992fc0fcc2df717466491f3216bb6de9f5315c — workflow run
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
/review |
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Straightforward rename from "job log collection" to "Log Storage" with restructured "Manage job logs" sections across the CI provider pages. One style nit on inline link usage.
Reviewed 9b1bb5de287e1f00f6a7a64829396794fb38fa2f — workflow run
|
|
||
| For a full explanation, see the guide on [using CI jobs failure analysis][28]. | ||
|
|
||
| This feature is enabled by default, but requires job log forwarding to be configured in GitLab. See [Store job logs](#store-job-logs). |
There was a problem hiding this comment.
Style: The style guide asks for reference-style Markdown links (with the definition at the bottom of the page). Reference [12] already points to /continuous_integration/pipelines/gitlab/#store-job-logs, so you can reuse it here.
| This feature is enabled by default, but requires job log forwarding to be configured in GitLab. See [Store job logs](#store-job-logs). | |
| This feature is enabled by default, but requires job log forwarding to be configured in GitLab. See [Store job logs][12]. |
2 participants
Update the CI Pipeline Visibility docs for the new decoupled log storage / log analysis flow: rename "Logs collection" to "Log storage" to match the UI, merge each provider's log storage and CI jobs failure analysis instructions into a single "Manage job logs" section, and add the missing failure analysis setup for CircleCI and Buildkite.
What does this PR do? What is the motivation?
Fixes SDCT-533
Renames "Logs collection" to "Log storage" in the supported features table to match the UI, and adds CircleCI and Buildkite to the CI jobs failure analysis row. For each provider page (Azure, CircleCI, Buildkite, GitHub, GitLab), merges the log storage and CI jobs failure analysis setup instructions into a single "Manage job logs" section, reflecting that these are now separate, independently configurable settings. Also adds the previously missing CI jobs failure analysis setup steps for CircleCI and Buildkite.
Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Gave Claude what I wanted exactly for each provider and Claude changed the name of the provider to introduce it into each provider's documentation.
Additional notes