Skip to content

Commit 434d449

Browse files
authored
Merge pull request DataDog#10404 from DataDog/margot.lepizzera/new_features
Update multistep.md
2 parents a9010ff + 9864056 commit 434d449

File tree

3 files changed

+31
-13
lines changed

3 files changed

+31
-13
lines changed

content/en/synthetics/multistep.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,14 @@ You can create up to 10 assertions per step by clicking on **New Assertion** or
111111

112112
{{< img src="synthetics/api_tests/assertions.png" alt="Define assertions for your Multistep API test" style="width:90%;" >}}
113113

114+
##### Failure behavior
115+
116+
The `Continue with test if this step fails` setting allows Multistep API tests to move on with subsequent steps even in case of step failure. This is particularly useful to ensure your tests are able to clean up after themselves. For instance, a test might first create a resource, perform a number of actions on that resource, and end with the deletion of that resource. In case one of the intermediary steps fails, you still want the resource to be deleted at the end of the test to avoid generating false positives. This can be done using the `Continue with test if this step fails` on every intermediary step.
117+
118+
You should also activate the `Consider entire test as failed if this step fails` setting on your intermediary steps to ensure your overall test still generates an alert in case one of the endpoints does not answer as expected.
119+
120+
Similarly, if your Multistep API test runs on a variety of endpoints, the two failure behavior settings can help ensure your test performs all requests even in case of issue with one or several of the API endpoints.
121+
114122
#### Extract variables from the response
115123

116124
You can also optionally extract variables from the response of your HTTP request by parsing its response headers or body. The value of the variable is updated each time the HTTP request step is being run.

content/en/synthetics/troubleshooting/_index.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ If you experience issues setting up or configuring Datadog Synthetic Monitoring,
2424

2525
After downloading the [Datadog extension][2], you are unable to see your website in the iframe on the right side of your Browser test's recorder and the iframe displays `Your website does not support being loaded through an iframe.`. This could mean that your application has some settings preventing it from being opened in an iframe. If that is the case, try opening your website in a pop up by clicking **Open in Popup** to record your journey.
2626

27+
#### I'm seeing a "We've detected HTTP requests that are not supported inside the iframe, you may need to record in a popup" banner at the top of the iframe
28+
29+
This most likely means you are trying to record steps on an `http` page. Only `https` is supported in the recorder iframe. You should open your page as a pop up or change your URL to an `https` one to start recording on the page.
30+
31+
{{< img src="synthetics/http_iframe.png" alt="HTTP in iframe" style="width:100%;" >}}
32+
2733
#### My website is not loading in the iframe and I cannot record any steps, even when opening my website in a pop up
2834

2935
After downloading the [Datadog extension][2], you are unable to see your website in the iframe on the right side of your Browser test's recorder. Additionally, you cannot record any steps, regardless of whether you open your website in the iframe or in a pop up:
@@ -34,6 +40,9 @@ If that happens, ensure the [Datadog extension][3] has the permissions to read a
3440

3541
{{< img src="synthetics/extension.mp4" alt="Allowing extension to read data on all sites" video="true" width="100%" >}}
3642

43+
#### I'm unable to record steps on my application
44+
45+
Your Chrome browser might have some policies preventing the extension from performing the recording as expected. To find out, go to `chrome://policy` and look for any extension-related settings such as [`ExtensionSettings`][4].
3746

3847
#### I don't see the login page in the recorder. What is happening?
3948

@@ -81,23 +90,23 @@ To fix it, go edit your recording, open the advanced options of the step that is
8190
If one of your Synthetic tests is throwing a 401, it most likely means that it is unable to authenticate on the endpoint. You should use the method that you use to authenticate on that endpoint (outside of Datadog) and replicate it when configuring your Synthetic test.
8291

8392
* Is your endpoint using **header-based authentication**?
84-
* **Basic Authentication**: specify the associated credentials in the **Advanced options** of your [HTTP][4] or [Browser test][5].
85-
* **Token based authentication**: extract your token with a first [HTTP test][4], create a [global variable][6] by parsing the response of that first test, and re-inject that variable in a second [HTTP][4] or [Browser test][8] requiring the authentication token.
86-
* **Session based authentication**: add the required headers or cookies in the **Advanced options** of your [HTTP][4] or [Browser test][5].
93+
* **Basic Authentication**: specify the associated credentials in the **Advanced options** of your [HTTP][5] or [Browser test][6].
94+
* **Token based authentication**: extract your token with a first [HTTP test][5], create a [global variable][7] by parsing the response of that first test, and re-inject that variable in a second [HTTP][5] or [Browser test][9] requiring the authentication token.
95+
* **Session based authentication**: add the required headers or cookies in the **Advanced options** of your [HTTP][5] or [Browser test][6].
8796

8897
* Is this endpoint using **query parameters for authentication** (e.g. do you need to add a specific API key in your URL parameters?)
8998

90-
* Is this endpoint using **IP-based authentication**? If so, you might need to allow part or all of the [IPs from which Synthetic tests originate][9].
99+
* Is this endpoint using **IP-based authentication**? If so, you might need to allow part or all of the [IPs from which Synthetic tests originate][10].
91100

92101
### Forbidden errors
93102

94103
If you observe `403 Forbidden` errors returned by Synthetic tests, it may be the result of your web server blocking or filtering requests that include the `Sec-Datadog` header. This header is added to each Synthetic request Datadog initiates to identify the source of the traffic and assist Datadog support in identifying the specific test execution.
95104

96-
Additionally, you might also have to ensure [Datadog Synthetic Monitoring IP ranges][9] are allowed as traffic sources by your firewalls.
105+
Additionally, you might also have to ensure [Datadog Synthetic Monitoring IP ranges][10] are allowed as traffic sources by your firewalls.
97106

98107
### Missing notifications
99108

100-
Synthetic tests by default do not [renotify][10]. This means that if you add your notification handle (email address, Slack handle, etc.) after a transition got generated (e.g., test going into alert or recovering from a previous alert), no notification is sent for that very transition. A notification will be sent for the next transition.
109+
Synthetic tests by default do not [renotify][11]. This means that if you add your notification handle (email address, Slack handle, etc.) after a transition got generated (e.g., test going into alert or recovering from a previous alert), no notification is sent for that very transition. A notification will be sent for the next transition.
101110

102111
## Further Reading
103112

@@ -106,10 +115,11 @@ Synthetic tests by default do not [renotify][10]. This means that if you add you
106115
[1]: /help/
107116
[2]: https://chrome.google.com/webstore/detail/datadog-test-recorder/kkbncfpddhdmkfmalecgnphegacgejoa
108117
[3]: chrome://extensions/?id=kkbncfpddhdmkfmalecgnphegacgejoa
109-
[4]: /synthetics/api_tests/?tab=httptest#make-a-request
110-
[5]: /synthetics/browser_tests/#test-details
111-
[6]: /synthetics/settings/?tab=createfromhttptest#global-variables
112-
[7]: /synthetics/api_tests/?tab=httptest#use-global-variables
113-
[8]: /synthetics/browser_tests/#use-global-variables
114-
[9]: https://ip-ranges.datadoghq.com/synthetics.json
115-
[10]: /synthetics/api_tests/?tab=httptest#notify-your-team
118+
[4]: https://chromeenterprise.google/policies/#ExtensionSettings
119+
[5]: /synthetics/api_tests/?tab=httptest#make-a-request
120+
[6]: /synthetics/browser_tests/#test-details
121+
[7]: /synthetics/settings/?tab=createfromhttptest#global-variables
122+
[8]: /synthetics/api_tests/?tab=httptest#use-global-variables
123+
[9]: /synthetics/browser_tests/#use-global-variables
124+
[10]: https://ip-ranges.datadoghq.com/synthetics.json
125+
[11]: /synthetics/api_tests/?tab=httptest#notify-your-team
6.47 KB
Loading

0 commit comments

Comments
 (0)