Skip to content

Commit

Permalink
Merge pull request DataDog#12360 from DataDog/alai97/synthetics-cicd-…
Browse files Browse the repository at this point in the history
…integrations-content-update

DOCS-2403, DOCS-2624, and DOCS-2622 Synthetics CI/CD Integrations Content Updates
  • Loading branch information
alai97 authored Jan 5, 2022
2 parents 71ea288 + 18f3e5d commit 2a5088d
Show file tree
Hide file tree
Showing 11 changed files with 623 additions and 696 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ content/en/real_user_monitoring/ios/crash_reporting.md
content/en/real_user_monitoring/ios/*
content/en/real_user_monitoring/reactnative.md

# Synthetics
content/en/synthetics/cicd_integrations/github_actions.md

# serverless
content/en/serverless/libraries_integrations/forwarder.md
content/en/serverless/libraries_integrations/plugin.md
Expand Down
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ clean-auto-doc: ##Remove all doc automatically created
rm -f content/en/serverless/libraries_integrations/macro.md ;fi
@if [ content/en/serverless/libraries_integrations/cli.md ]; then \
rm -f content/en/serverless/libraries_integrations/cli.md ;fi
@if [ content/en/synthetics/cicd_integrations/github_actions.md ]; then \
rm -f content/en/synthetics/cicd_integrations/github_actions.md ;fi
@if [ content/en/real_user_monitoring/android/_index.md ]; then \
rm -f content/en/real_user_monitoring/android/_index.md ;fi
@if [ content/en/real_user_monitoring/android/data_collected.md ]; then \
Expand Down
43 changes: 27 additions & 16 deletions content/en/synthetics/ci_results_explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ further_reading:
- link: "https://www.datadoghq.com/blog/datadog-synthetic-ci-cd-testing/"
tag: "Blog"
text: "Incorporate Datadog Synthetic tests into your CI/CD pipeline"
- link: "https://learn.datadoghq.com/course/view.php?id=37"
- link: "https://learn.datadoghq.com/enrol/index.php?id=37"
tag: "Learning Center"
text: "Learn how to run Synthetic tests in CI/CD pipelines"
- link: "/synthetics/search/"
Expand All @@ -19,7 +19,9 @@ further_reading:

## Overview

The CI Results Explorer gives you visibility into your CI jobs that are executing Synthetic tests.
The CI Results Explorer provides visibility into the CI jobs executing your Synthetic tests.

{{< img src="synthetics/ci_results_explorer/ci_results_explorer.png" alt="CI Results Explorer" style="width:100%;">}}

You can:

Expand All @@ -28,59 +30,68 @@ You can:
* Keep track of the progress of your tests in CI pipelines.
* Identify flaky tests to fix.

{{< img src="synthetics/ci_results_explorer/ci_results_explorer.png" alt="CI Results Explorer" style="width:100%;">}}

## Exploring batches
## Explore test batches

The CI Results Explorer displays batches of tests that were run through [Synthetics and CI/CD][1]. Every batch corresponds to a call to the Datadog API (through the NPM package or directly through the API endpoint) to trigger one or several test executions.
The CI Results Explorer displays batches of tests run by [Synthetics and your CI/CD provider][1]. Every batch corresponds with a call to the Datadog API (through one of your [CI/CD Integrations][1], the [datadog-ci][2] NPM package, or directly through the API endpoint) and triggers one or several test executions.

Click on a batch to open a side panel containing batch CI metadata and batch test results. Explore the test executions performed as part of the batch and pinpoint test failures. Click on a failing test result to see the detailed **Test Result** page and investigate the root cause of the issue.
1. Click on a batch to open a side panel containing batch CI metadata and batch test results.
2. Explore the test executions performed as part of the batch and pinpoint test failures.
3. Click on a failing test result to see the detailed **Test Result** page and investigate the root cause of the issue.

## Search

### Facets and tags

The panel on the left side of the page lists several facets you can use to search through your batches:
The panel on the left side of the page lists several facets you can use to search through your batches.

**Batch** facets allow you to filter on attributes of your batches:
**Batch** facets allow you to filter on attributes of your batches.

| Facet | Description |
|------------------|-------------------------------------------------------------|
| `Summary Status` | The status of the batch: `Passed`, `Failed`, `In Progress`. |
| `Summary Status` | The status of the batch: `Passed`, `Failed`, and `In Progress`. |
| `Duration` | The overall duration of the batch. |
| `ID` | The batch ID. |

**Git** facets allow you to filter on Git-related attributes of your batches:
**Git** facets allow you to filter on Git-related attributes of your batches.

| Facet | Description |
|-------------|-------------------------------------------|
| `Branch` | The branch associated with the batch. |
| `Commit SHA`| The commit SHA associated with the batch. |
| `Repository URL`| The URL of the Git repository associated with the batch. |
| `Tag` | The Git tag associated with the batch. |

**CI** facets allow you to filter on CI-related attributes of your batches:
**CI** facets allow you to filter on CI-related attributes of your batches.

| Facet | Description |
|----------------|---------------------------------------------|
| `CI Provider` | The CI provider associated with the batch. |
| `Job Name` | The job name associated with the batch. |
| `Job URL` | The job URL associated with the batch. |
| `Pipeline ID` | The pipeline ID associated with the batch. |
| `Pipeline Name` | The pipeline or repository name associated with the batch. |
| `Pipeline Number` | The pipeline or build number associated with the batch. |
| `Pipeline URL` | The pipeline URL associated with the batch. |
| `Stage Name` | The stage name associated with the batch. |

**Test result** facets allow you to filter on attributes of the test results executed as part of your batches:
**Test result** facets allow you to filter on attributes of the test results executed as part of your batches.

| Facet | Description |
|------------------|---------------------------------------------------------------------------------------------------------|
| `Execution Rule` | The execution rule associated with the test result of the batch: `Blocking`, `Non Blocking`, `Skipped`. |
| `Execution Rule` | The execution rule associated with the test result of the batch: `Blocking`, `Non Blocking`, and `Skipped`. |
| `Fast Retries` | The number of fast retries associated with the test result of the batch. |
| `Location` | The location associated with the test result of the batch. |
| `Test ID` | The test ID associated with the test result of the batch. |
| `Test Name` | The test name associated with the test result of the batch. |

### Create your query

To query the CI Results Explorer data, use the [same query syntax][2] as on the **Tests** page.
To query the CI Results Explorer data, use the [same query syntax][3] as you do on the **Tests** page.

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: /synthetics/cicd_integrations
[2]: /synthetics/search/
[2]: https://www.npmjs.com/package/@datadog/datadog-ci
[3]: /synthetics/search/
Loading

0 comments on commit 2a5088d

Please sign in to comment.