Skip to content

Commit

Permalink
Merge branch 'alai97/synthetics-cicd-testing-doc-updates'
Browse files Browse the repository at this point in the history
  • Loading branch information
alai97 committed Nov 17, 2021
2 parents ed58283 + 6305af5 commit 2e127d5
Show file tree
Hide file tree
Showing 25 changed files with 74 additions and 56 deletions.
44 changes: 30 additions & 14 deletions config/_default/menus/menus.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2551,51 +2551,67 @@ main:
parent: synthetics_private_location
identifier: synthetics_private_location_monitoring
weight: 403
- name: CI/CD Testing
url: /synthetics/cicd_testing
- name: CI/CD Integrations
url: /synthetics/cicd_integrations
parent: synthetics
identifier: synthetics_cicd_testing
identifier: synthetics_cicd_integrations
weight: 5
- name: CI Results Explorer
url: /synthetics/cicd_testing/ci_results_explorer
parent: synthetics_cicd_testing
- name: GitHub Actions
url: /synthetics/cicd_integrations/github_actions
parent: synthetics_cicd_integrations
identifier: synthetics_integrations_github_actions
weight: 501
- name: Jenkins
url: /synthetics/cicd_integrations/jenkins
parent: synthetics_cicd_integrations
identifier: synthetics_cicd_integrations_jenkins
weight: 502
- name: Configuration
url: /synthetics/cicd_integrations/configuration
parent: synthetics_cicd_integrations
identifier: synthetics_cicd_integrations_configuration
weight: 503
- name: CI Results Explorer
url: /synthetics/ci_results_explorer
parent: synthetics
identifier: synthetics_ci_results_explorer
weight: 7
- name: Testing Tunnel
url: /synthetics/testing_tunnel
parent: synthetics
identifier: synthetics_testing_tunnel
weight: 6
weight: 8
- name: APM Integration
url: synthetics/apm/
parent: synthetics
identifier: synthetics_apm
weight: 7
weight: 9
- name: Settings
url: synthetics/settings/
parent: synthetics
weight: 8
weight: 10
- name: Search and Manage
url: synthetics/search/
parent: synthetics
weight: 9
weight: 11
- name: Metrics
url: synthetics/metrics/
parent: synthetics
weight: 10
weight: 12
- name: Guides
url: synthetics/guide/
parent: synthetics
identifier: synthetics_guides
weight: 12
weight: 13
- name: Troubleshooting
url: synthetics/troubleshooting/
parent: synthetics
identifier: synthetics_troubleshooting
weight: 13
weight: 14
- name: Security
url: security/synthetics/
parent: synthetics
weight: 14
weight: 15
- name: RUM & Session Replay
url: real_user_monitoring/
pre: rum
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ Find below a summary of Datadog data collection, resolution, and retention:

[1]: /tracing/guide/trace_sampling_and_storage/?tab=java#trace-storage
[2]: /integrations/faq/cloud-metric-delay/#faster-metrics
[3]: /synthetics/cicd_testing/?tab=apitest#trigger-tests-endpoint
[4]: /synthetics/cicd_testing/?tab=apitest#cli-usage
[3]: /synthetics/cicd_integrations/?tab=apitest#trigger-tests-endpoint
[4]: /synthetics/cicd_integrations/?tab=apitest#cli-usage
2 changes: 1 addition & 1 deletion content/en/getting_started/synthetics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ If you haven't already, create a [Datadog account][6].
[2]: /synthetics/multistep
[3]: /synthetics/browser_tests/
[4]: /synthetics/private_locations
[5]: /synthetics/cicd_testing/
[5]: /synthetics/cicd_integrations
[6]: https://www.datadoghq.com/
[7]: /getting_started/synthetics/api_test/
[8]: /getting_started/synthetics/api_test/#create-a-multistep-api-test
Expand Down
2 changes: 1 addition & 1 deletion content/en/getting_started/synthetics/api_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ further_reading:
- link: '/getting_started/synthetics/private_location'
tag: 'Documentation'
text: 'Learn about private locations'
- link: '/synthetics/cicd_testing/'
- link: '/synthetics/cicd_integrations/'
tag: 'Documentation'
text: 'Learn how to trigger Synthetic tests from your CI/CD pipeline'
- link: '/synthetics/identify_synthetics_bots'
Expand Down
4 changes: 2 additions & 2 deletions content/en/getting_started/synthetics/browser_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ further_reading:
- link: '/getting_started/synthetics/private_location'
tag: 'Documentation'
text: 'Learn about private locations'
- link: '/synthetics/cicd_testing'
- link: '/synthetics/cicd_integrations'
tag: 'Documentation'
text: 'Learn how to trigger Synthetic tests from your CI/CD pipeline'
- link: '/synthetics/identify_synthetics_bots'
Expand Down Expand Up @@ -128,7 +128,7 @@ Use Datadog's [APM integration with Synthetic Monitoring][13] to view traces gen
[2]: https://app.datadoghq.com/synthetics/list
[3]: https://app.datadoghq.com/synthetics/browser/create
[4]: /getting_started/synthetics/private_location
[5]: /synthetics/cicd_testing
[5]: /synthetics/cicd_integrations
[6]: /integrations/#cat-notification
[7]: https://app.datadoghq.com/account/settings
[8]: https://chrome.google.com/webstore/detail/datadog-test-recorder/kkbncfpddhdmkfmalecgnphegacgejoa
Expand Down
2 changes: 1 addition & 1 deletion content/en/getting_started/synthetics/private_location.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ You can use your new private location just like a managed location to run Synthe

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

[1]: /synthetics/cicd_testing
[1]: /synthetics/cicd_integrations
[2]: https://console.cloud.google.com/gcr/images/datadoghq/GLOBAL/synthetics-private-location-worker?pli=1
[3]: /getting_started/synthetics/
[4]: https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce
Expand Down
2 changes: 1 addition & 1 deletion content/en/synthetics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ See [Getting Started with Synthetic Monitoring][14] for instructions on creating
[9]: /synthetics/api_tests/websocket_tests
[10]: /synthetics/browser_tests
[11]: /synthetics/private_locations
[12]: /synthetics/cicd_testing
[12]: /synthetics/cicd_integrations
[13]: /synthetics/apm/
[14]: /getting_started/synthetics
[15]: /getting_started/synthetics/private_location
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ API tests run from Datadog [managed locations][3] or [private locations][4], all
{{< partial name="whats-next/whats-next.html" >}}

[1]: /synthetics/api_tests/http_tests?tab=requestoptions#notify-your-team
[2]: /synthetics/cicd_testing
[2]: /synthetics/cicd_integrations
[3]: /api/v1/synthetics/#get-all-locations-public-and-private
[4]: /synthetics/private_locations
[5]: /synthetics/multistep/
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/dns_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ If you have access to the [custom role feature][11], add your user to any custom

[1]: /api/v1/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[6]: /monitors/notify/#notify-your-team
Expand Down
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/http_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ If you have access to the [custom role feature][14], add your user to any custom
[1]: /api/v1/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: https://restfulapi.net/json-jsonpath/
[6]: https://www.w3schools.com/xml/xpath_syntax.asp
Expand Down
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/icmp_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ If you have access to the [custom role feature][10], add your user to any custom

[1]: /api/v1/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: /monitors/notify/#notify-your-team
[6]: https://www.markdownguide.org/basic-syntax/
Expand Down
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/ssl_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ If you have access to the [custom role feature][12], add your user to any custom

[1]: /api/v1/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[6]: /monitors/notify/#notify-your-team
Expand Down
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/tcp_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ If you have access to the [custom role feature][10], add your user to any custom

[1]: /api/v1/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: /monitors/notify/#notify-your-team
[6]: https://www.markdownguide.org/basic-syntax/
Expand Down
27 changes: 13 additions & 14 deletions content/en/synthetics/api_tests/udp_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Select the **Locations** to run your UDP test from. UDP tests can run from both
UDP tests can run:

- **On a schedule** to ensure your most important services are always accessible to your users. Select the frequency at which you want Datadog to run your UDP test.
- [**Within your CI/CD pipelines**][6].
- [**Within your CI/CD pipelines**][3].
- **On-demand** to run your tests whenever makes the most sense for your team.

### Define alert conditions
Expand All @@ -78,9 +78,9 @@ When you set the alert conditions to `An alert is triggered if your test fails f

A notification is sent by your test based on the [alerting conditions](#define-alert-conditions) previously defined. Use this section to define how and what to message to send to your teams.

1. [Similar to how you configure monitors][7], select **users and/or services** that should receive notifications either by adding an `@notification`to the message or by searching for team members and connected integrations with the drop-down box.
1. [Similar to how you configure monitors][6], select **users and/or services** that should receive notifications either by adding an `@notification`to the message or by searching for team members and connected integrations with the drop-down box.

2. Enter the notification **message** for your test. This field allows standard [Markdown formatting][8] and supports the following [conditional variables][9]:
2. Enter the notification **message** for your test. This field allows standard [Markdown formatting][7] and supports the following [conditional variables][8]:

| Conditional Variable | Description |
|----------------------------|---------------------------------------------------------------------|
Expand Down Expand Up @@ -118,7 +118,7 @@ When you have entered a name and a value, click **Add Variable**. (standardize t

### Use variables

You can use the [global variables defined in `Settings`][10] and [locally defined variables](#create-local-variables) in the URL and assertions of your UDP tests.
You can use the [global variables defined in `Settings`][9] and [locally defined variables](#create-local-variables) in the URL and assertions of your UDP tests.

To display your list of variables, type `{{` in your desired field:

Expand Down Expand Up @@ -146,23 +146,22 @@ These reasons include the following:

## Permissions

By default, only users with the Datadog Admin and Datadog Standard roles can create, edit, and delete Synthetic UDP tests. To get create, edit, and delete access to Synthetic UDP tests, upgrade your user to one of those two [default roles][11].
By default, only users with the Datadog Admin and Datadog Standard roles can create, edit, and delete Synthetic UDP tests. To get create, edit, and delete access to Synthetic UDP tests, upgrade your user to one of those two [default roles][10].

If you have access to the [custom role feature][12], add your user to any custom role that includes `synthetics_read` and `synthetics_write` permissions.
If you have access to the [custom role feature][11], add your user to any custom role that includes `synthetics_read` and `synthetics_write` permissions.

## Further Reading

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

[1]: /api/latest/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations/
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[6]: /synthetics/cicd_testing/
[7]: /monitors/notify/#notify-your-team
[8]: https://www.markdownguide.org/basic-syntax/
[9]: /monitors/notify/variables/?tab=is_alert#conditional-variables
[10]: /synthetics/settings/#global-variables
[11]: /account_management/rbac/
[12]: /account_management/rbac#custom-roles
[6]: /monitors/notify/#notify-your-team
[7]: https://www.markdownguide.org/basic-syntax/
[8]: /monitors/notify/variables/?tab=is_alert#conditional-variables
[9]: /synthetics/settings/#global-variables
[10]: /account_management/rbac/
[11]: /account_management/rbac#custom-roles
2 changes: 1 addition & 1 deletion content/en/synthetics/api_tests/websocket_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ If you have access to the [custom role feature][11], add your user to any custom

[1]: /api/latest/synthetics/#get-all-locations-public-and-private
[2]: /synthetics/private_locations
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /synthetics/search/#search
[5]: /synthetics/settings/#global-variables
[6]: /monitors/notify/#notify-your-team
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: CI Results Explorer
kind: documentation
description: Drill down into CI jobs executing Synthetic tests.
aliases:
- /synthetics/cicd_testing/ci_results_explorer
further_reading:
- link: "https://www.datadoghq.com/blog/datadog-synthetic-ci-cd-testing/"
tag: "Blog"
Expand Down Expand Up @@ -80,5 +82,5 @@ To query the CI Results Explorer data, use the [same query syntax][2] as on the

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

[1]: /synthetics/cicd_testing
[1]: /synthetics/cicd_integrations
[2]: /synthetics/search/
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Synthetic CI/CD Testing
title: Synthetics and CI/CD
kind: documentation
description: Run Synthetic tests on-demand in your CI/CD pipelines.
aliases:
- /synthetics/ci
- /synthetics/cicd_testing
further_reading:
- link: "https://www.datadoghq.com/blog/datadog-synthetic-ci-cd-testing/"
tag: "Blog"
Expand All @@ -23,13 +24,13 @@ further_reading:

---

In addition to running tests at predefined intervals, you can also run Datadog Synthetic tests on-demand using API endpoints. You can run Datadog Synthetic tests in your continuous integration (CI) pipelines, letting you block the deployment of branches that would break your product.
In addition to running tests at predefined intervals, you can run Datadog Synthetic tests on-demand using API endpoints. Run Datadog Synthetic tests in your continuous integration (CI) pipelines to block branches from being deployed and breaking your application in production.

Synthetic CI/CD testing can also be used to **run tests as part of your CD process**, evaluating the state of your production application immediately after a deployment finishes. This lets you detect potential regressions that could impact your usersand automatically trigger a rollback whenever a critical test fails.
Use Synthetic CI/CD testing to also run tests as part of your continuous delivery (CD) process and evaluate the state of your applications and services in production immediately after a deployment finishes. You can detect potential regressions that may impact your users and automatically trigger a rollback when a critical test fails.

This function allows you to avoid spending time fixing issues on production, and to catch bugs and regressions earlier in the process.
This functionality reduces time spent fixing issues in production by proactively catching bugs and regressions earlier in the process, allowing your engineering teams to focus on non-urgent work instead.

On top of these API endpoints, Datadog provides and maintains a command line interface (CLI), allowing you to easily integrate Datadog Synthetic tests with your CI tooling. Synthetic CI/CD testing is open-source, and its source code is available on GitHub at [DataDog/datadog-ci][1].
To get started, see Integrations and use the API or the [open-source CLI package][1].

## CLI usage

Expand Down Expand Up @@ -715,4 +716,4 @@ curl -G \
[3]: https://github.com/TooTallNate/node-proxy-agent
[4]: /api/v1/synthetics/#get-test
[5]: /synthetics/testing_tunnel/
[6]: /synthetics/cicd_testing/ci_results_explorer
[6]: /synthetics/ci_results_explorer
Empty file.
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion content/en/synthetics/multistep.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ If you have access to the [custom role feature][17], add your user to any custom

[1]: /synthetics/api_tests/http_tests
[2]: /synthetics/api_tests/http_tests?tab=requestoptions#notify-your-team
[3]: /synthetics/cicd_testing
[3]: /synthetics/cicd_integrations
[4]: /api/v1/synthetics/#get-all-locations-public-and-private
[5]: /synthetics/private_locations
[6]: /synthetics/api_tests/
Expand Down
2 changes: 1 addition & 1 deletion content/en/synthetics/private_locations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ For more information, see [Private Location Monitoring][19].

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

[1]: /synthetics/cicd_testing
[1]: /synthetics/cicd_integrations
[2]: /synthetics/
[3]: https://console.cloud.google.com/gcr/images/datadoghq/GLOBAL/synthetics-private-location-worker?pli=1
[4]: https://docs.docker.com/engine/install/
Expand Down
4 changes: 2 additions & 2 deletions content/en/synthetics/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ further_reading:
- link: "https://www.datadoghq.com/blog/test-maintenance-best-practices/"
tag: "Blog"
text: "Best practices for maintaining end-to-end tests"
- link: "/synthetics/cicd_testing/ci_results_explorer"
- link: "/synthetics/ci_results_explorer"
tag: "Documentation"
text: CI Results Explorer
---
Expand Down Expand Up @@ -86,5 +86,5 @@ Find all Synthetic Monitoring related changes by searching the event stream for

[1]: https://app.datadoghq.com/synthetics/list
[2]: https://app.datadoghq.com/synthetics/explorer/ci
[3]: /synthetics/cicd_testing/ci_results_explorer
[3]: /synthetics/ci_results_explorer
[4]: /events/
2 changes: 1 addition & 1 deletion content/en/synthetics/testing_tunnel.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ datadog-ci synthetics run-tests --config <GLOBAL_CONFIG_FILE>.json --tunnel
[1]: /synthetics/private_locations
[2]: https://www.npmjs.com/package/@datadog/datadog-ci
[3]: https://github.com/DataDog/datadog-ci/releases/tag/v0.11.0
[4]: /synthetics/cicd_testing/#cli-usage
[4]: /synthetics/cicd_integrations/#cli-usage
2 changes: 1 addition & 1 deletion content/en/synthetics/troubleshooting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ Check whether you are using API endpoints to trigger your CI/CD test runs. To ha
[12]: /synthetics/api_tests/?tab=httptest#notify-your-team
[13]: /synthetics/private_locations#private-location-total-hardware-requirements
[14]: https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only
[15]: /synthetics/cicd_testing/?tab=apitest#cli-usage
[15]: /synthetics/cicd_integrations?tab=apitest#cli-usage

0 comments on commit 2e127d5

Please sign in to comment.