Skip to content

Conversation

AdrianLC
Copy link
Contributor

@AdrianLC AdrianLC commented Apr 12, 2022

What does this PR do?

Document a new feature when uploading test report in XML to CI Visibility. A new CLI flag and environment variable enables this additional feature where the logs will be forwarded to the logs product and connected to the tests in CI Visibility.

This was added in DataDog/datadog-ci#510

Preview

https://docs-staging.datadoghq.com/adrian.lopezcalvo%2Fci-visibility-junitxml-logs-support


Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@AdrianLC AdrianLC self-assigned this Apr 12, 2022
@AdrianLC AdrianLC force-pushed the adrian.lopezcalvo/ci-visibility-junitxml-logs-support branch 3 times, most recently from 1796c2d to 2762174 Compare April 12, 2022 16:39
@AdrianLC AdrianLC force-pushed the adrian.lopezcalvo/ci-visibility-junitxml-logs-support branch from 2762174 to 034719b Compare April 12, 2022 17:23
@@ -118,6 +116,11 @@ This is the full list of options available when using the `datadog-ci junit uplo
**Example**: `team:backend`<br/>
**Note**: Tags specified using `--tags` and with the `DD_TAGS` environment variable are merged. If the same key appears in both `--tags` and `DD_TAGS`, the value in the environment variable `DD_TAGS` takes precedence.

`--logs` **(beta)**
: Enable forwarding content from the XML reports as [Logs][7]. The content inside `<system-out>`, `<system-err>`, `<failure>` will be loaded. Logs from elements inside a `<testcase>` are automatically connected to test.<br/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
: Enable forwarding content from the XML reports as [Logs][7]. The content inside `<system-out>`, `<system-err>`, `<failure>` will be loaded. Logs from elements inside a `<testcase>` are automatically connected to test.<br/>
: Enable forwarding content from the XML reports as [Logs][7]. The content inside `<system-out>`, `<system-err>`, `<failure>` will be sent to the Logs system. Logs from elements inside a `<testcase>` are automatically linked to the test.<br/>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used the word connected because of https://docs.datadoghq.com/tracing/connect_logs_and_traces/ but good suggestions for the others I'll make the changes

@AdrianLC AdrianLC changed the title [CIAPP] Document support for logs in CI Visibility junit XM upload [CIAPP] Document support for logs in CI Visibility junit XML upload Apr 13, 2022
`--logs` **(beta)**
: Enable forwarding content from the XML reports as [Logs][7]. The content inside `<system-out>`, `<system-err>`, `<failure>` is collected as logs. Logs from elements inside a `<testcase>` are automatically connected to the test.<br/>
**Default**: `false`<br/>
**Note**: Logs are billed separately from CI Visibility.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AdrianLC AdrianLC marked this pull request as ready for review April 19, 2022 11:55
@AdrianLC AdrianLC requested a review from a team as a code owner April 19, 2022 11:55
Co-authored-by: Fernando Mayo <fernando@datadog.com>
@AdrianLC AdrianLC force-pushed the adrian.lopezcalvo/ci-visibility-junitxml-logs-support branch from d29f2a1 to 5a6b463 Compare April 19, 2022 11:56
@jtappa jtappa self-assigned this Apr 19, 2022
@jtappa jtappa added the Do Not Merge Just do not merge this PR :) label Apr 19, 2022
@jtappa
Copy link
Contributor

jtappa commented Apr 19, 2022

When this is ready for merge, please remove the github label and ping us in the documentation channel in slack! :) Thanks!

@AdrianLC AdrianLC removed the Do Not Merge Just do not merge this PR :) label Apr 20, 2022
@maycmlee maycmlee merged commit 15010e7 into master Apr 20, 2022
@maycmlee maycmlee deleted the adrian.lopezcalvo/ci-visibility-junitxml-logs-support branch April 20, 2022 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants