Skip to content

Commit

Permalink
updates to Templates PR from editorial review and adding mobile app v…
Browse files Browse the repository at this point in the history
…ideo
  • Loading branch information
aliciascott committed Dec 23, 2024
1 parent b417bdd commit 96457f4
Show file tree
Hide file tree
Showing 13 changed files with 74 additions and 98 deletions.
30 changes: 13 additions & 17 deletions content/en/getting_started/synthetics/api_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ API tests **proactively monitor** that your **most important services** are avai

HTTP tests monitor your API endpoints and alert you when response latency is high or fail to meet any conditions you define, such as expected HTTP status code, response headers, or response body content.

The example below demonstrates how to create an [HTTP test][3], a subtype of [single API tests][1].
The examples below demonstrate how to create an [HTTP test][3], a subtype of [single API tests][1].

1. In the Datadog site, hover over **Digital Experience** and select **[Tests][4]** (under **Synthetic Monitoring & Testing**).

Expand All @@ -46,33 +46,29 @@ The example below demonstrates how to create an [HTTP test][3], a subtype of [si

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** to submit your API test.<br /><br>

{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** when you are ready to submit your API test.<br />
{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

- **Build a test from scratch**:

1. To build a test from scratch, click the **+ Start from scratch** template, then select the `HTTP` request type.
1. To build a test from scratch, click the **+ Start from scratch** template, then select the `HTTP` request type.

2. Add the URL of the endpoint you want to monitor. If you don't know what to start with, you can use `https://www.shopist.io/`, a test e-commerce web application. After entering the endpoint to test, the name of your test is automatically populated as `Test on shopist.io`.
2. Add the URL of the endpoint you want to monitor. If you don't know what to start with, you can use `https://www.shopist.io/`, a test e-commerce web application. If you use the test Shopist URL, the name of your test is automatically populated as `Test on shopist.io`.

3. Optionally, select **Advanced Options** to:
- Set custom request options.
- Add certificates and authentication credentials.
- Create secure [global variables][6] or [local variables][7] for dynamic inputs.
3. Optionally, select **Advanced Options** to set custom request options, add certificates and authentication credentials, and create secure [global variables][6] or [local variables][7] for dynamic inputs.

**Note**: Type `{{` in any relevant field to select a variable and inject its value into your test options.
**Note**: Type `{{` in any relevant field to select a variable and inject its value into your test options.

4. Optionally, set tags such as `env:prod` and `app:shopist` on your test. Tags allow you to keep your test suite organized and quickly find tests you're interested in on the homepage.
4. Optionally, set tags such as `env:prod` and `app:shopist` on your test. Tags allow you to keep your test suite organized and quickly find tests you're interested in on the homepage.

5. Click **Send** to trigger a sample test run.
5. Click **Send** to trigger a sample test run.

{{< img src="getting_started/synthetics/api-test-config-4.png" alt="API test configuration" style="width:90%;">}}
{{< img src="getting_started/synthetics/api-test-config-4.png" alt="API test configuration" style="width:90%;">}}

6. Click **Create Test** when you are ready to submit your API test.
6. Click **Create Test** to submit your API test.

### Define assertions

Expand Down
9 changes: 4 additions & 5 deletions content/en/getting_started/synthetics/browser_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,20 @@ You may create a test using one of the following options:

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Alert Conditions, Steps, and optionally Variables.<br /><br>
1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Alert Conditions, Steps, and optionally Variables.
2. Click **+Create Test** to open the configuration page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save & Quit** in the upper right hand corner to submit your Browser Test.<br /><br>

{{< img src="/synthetics/browser_tests/synthetics_templates_browser.mp4" alt="Video of Synthetics Browser Test landing page with templates" video="true" >}}

2. Click **+Create Test** to open the configuration page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save & Quit** in the upper right hand corner when you are ready to submit your Browser Test.<br /><br>

- **Build a test from scratch**:

1. Click the **+** template to start a new Browser Test from scratch.
1. Add the URL of the website you want to monitor. If you don't know what to start with, you can use `https://www.shopist.io`, a test e-commerce web application.
2. Select **Advanced Options** to set custom request options, certificates, authentication credentials, and more.
3. Name your test and set tags to it such as `env:prod` and `app:shopist`. Tags allow you to keep your test suite organized and quickly find tests you're interested in on the homepage.
4. Choose the browsers and devices you want to test with.
5. Click **Save & Edit Recording** when you are ready to submit your Browser Test.
5. Click **Save & Edit Recording** to submit your Browser Test.

### Select locations

Expand Down
11 changes: 5 additions & 6 deletions content/en/synthetics/api_tests/dns_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,12 @@ You may create a test using one of the following options:

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.<br /><br>
1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** to submit your API test.<br /><br>

{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** when you are ready to submit your API test.<br /><br>

- **Build a test from scratch**:

1. To build a test from scratch, click the **+ Start from scratch** template, then select the DNS request type.
Expand All @@ -54,12 +53,12 @@ You may create a test using one of the following options:
1. Specify your DNS Server **Port** (optional). If not specified, the DNS Server port defaults to 53.
1. Specify the amount of time in seconds before the test times out (optional).
1. **Name** your DNS test.
1. Add `env` **Tags** as well as any other tag to your DNS test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
1. Add Environment **Tags** as well as any other tag to your DNS test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
1. Click **Test Domain** to try out the request configuration. A response preview is displayed on the right side of your screen.<br /><br>

{{< img src="synthetics/api_tests/synthetics_dns_test_domain.png" alt="Define DNS query" style="width:90%;" >}}

9. Click **Create Test** when you are ready to submit your API test.
9. Click **Create Test** when to submit your API test.

### Snippets

Expand Down
14 changes: 6 additions & 8 deletions content/en/synthetics/api_tests/grpc_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,10 @@ You may create a test using one of the following options:

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.<br /><br>

{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** when you are ready to submit your API test.<br /><br>
3. Click **Save Details** to submit your API test.<br /><br>
{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

- **Build a test from scratch**:

Expand Down Expand Up @@ -81,7 +79,7 @@ For a health check, enter the name of the service. Leave this field blank if you
{{< tabs >}}
{{% tab "Request Options" %}}

- **Timeout**: Specify the amount of time in seconds before the test times out.
- **Time out**: Specify the amount of time in seconds before the test times out.
- **Ignore server certificate error**: Select to have your gRPC test go on with connection even if there are errors when validating the SSL certificate.
- **gRPC metadata**: Add and define metadata to your gRPC request to pass metadata between services.

Expand All @@ -104,11 +102,11 @@ You can use the `openssl` library to convert your certificates. For example, con

5. **Name** your gRPC test.

6. Add `env` **Tags** as well as any other tags to your gRPC test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][4].
6. Add Environment **Tags** as well as any other tags to your gRPC test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][4].

7. Click **Invoke** to try out the request configuration. A response preview is displayed on the right side of your screen.

8. Click **Create Test** when you are ready to submit your API test.
8. Click **Create Test** to submit your API test.

### Snippets

Expand Down
11 changes: 5 additions & 6 deletions content/en/synthetics/api_tests/http_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,12 @@ You may create a test using one of the following options:

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings. <br /><br>
1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** to submit your API test. <br /><br>

{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** when you are ready to submit your API test. <br /><br>

- **Build a test from scratch**:

1. To build a test from scratch, click the **+ Start from scratch** template, then select the `HTTP` request type and specify the **URL** to query.
Expand All @@ -58,13 +57,13 @@ You may create a test using one of the following options:

2. **Name** your HTTP test.

3. Add `env` **Tags** as well as any other tag to your HTTP test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
3. Add Environment **Tags** as well as any other tag to your HTTP test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].

4. Click **Send** to try out the request configuration. A response preview is displayed on the right side of your screen.<br /><br>

{{< img src="getting_started/synthetics/api-test-config-4.png" alt="Define HTTP request" style="width:90%;" >}}

5. Click **Create Test** when you are ready to submit your API test.
5. Click **Create Test** to submit your API test.

### Snippets

Expand Down
12 changes: 5 additions & 7 deletions content/en/synthetics/api_tests/icmp_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,10 @@ You may create a test using one of the following options:

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.<br /><br>

{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** when you are ready to submit your API test.<br /><br>
3. Click **Save Details** to submit your API test.<br /><br>
{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

- **Build a test from scratch**:

Expand All @@ -50,11 +48,11 @@ You may create a test using one of the following options:
1. Select or deselect **Track number of network hops (TTL)**. When selected, this option turns on a "traceroute" probe to discover all gateways along the path to the host destination.
1. Select the **Number of Pings** to trigger per test session. By default, the number of pings is set to four. You can choose to decrease this number or increase it up to ten.
1. **Name** your ICMP test.
1. Add `env` **Tags** as well as any other tags to your ICMP test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
1. Add Environment **Tags** as well as any other tags to your ICMP test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
1. Click **Test Host** to try out the request configuration. A response preview is displayed on the right side of your screen.<br /><br>

{{< img src="synthetics/api_tests/icmp_test_config_2.png" alt="Define ICMP request" style="width:90%;" >}}
8. Click **Create Test** when you are ready to submit your API test.
8. Click **Create Test** to submit your API test.


Expand Down
12 changes: 5 additions & 7 deletions content/en/synthetics/api_tests/ssl_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,10 @@ You may create a test using one of the following options:

- **Create a test from a template**:

1. Hover over one of the following pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.<br /><br>

{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

1. Hover over one of the pre-populated templates and click **View Template**. This opens a side panel displaying pre-populated configuration information, including: Test Details, Request Details, Assertions, Alert Conditions, and Monitor Settings.
2. Click **+Create Test** to open the **Define Request** page, where you can review and edit the pre-populated configuration options. The fields presented are identical to those available when creating a test from scratch.
3. Click **Save Details** when you are ready to submit your API test.<br /><br>
3. Click **Save Details** to submit your API test.<br /><br>
{{< img src="getting_started/synthetics/synthetics_templates_api_video.mp4" alt="Video of Synthetics API test landing page with templates" video="true" >}}

- **Build a test from scratch**:

Expand All @@ -63,12 +61,12 @@ You may create a test using one of the following options:
1. **Name** your SSL test.
1. Add `env` **Tags** as well as any other tag to your SSL test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
1. Add Environment **Tags** as well as any other tag to your SSL test. You can then use these tags to filter through your Synthetic tests on the [Synthetic Monitoring & Continuous Testing page][3].
1. Click **Test Certificate** to try out the request configuration. A response preview is displayed on the right side of your screen.<br /><br>
{{< img src="synthetics/api_tests/synthetics_ssl_test_cert.png" alt="Define SSL request" style="width:90%;" >}}
1. Click **Create Test** when you are ready to submit your API test.
1. Click **Create Test** to submit your API test.
Expand Down
Loading

0 comments on commit 96457f4

Please sign in to comment.