-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS-9465] adding Synthetics templates #26462
Merged
+300
−181
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
d02d928
adding Synthetics templates
aliciascott 8157148
removing mobile app testing
aliciascott 897f39c
Merge branch 'master' into aliciascott/DOCS-9465-E2E-tests
aliciascott 83fd639
updates to Synthetics templates
aliciascott 449c451
adding steps for api tests getting started
aliciascott a6148a7
formatting
aliciascott 787cad8
wording
aliciascott d269d7c
formatting
aliciascott 92ad046
restructuring layout
aliciascott eec9d25
dns/http/ssl/api
aliciascott 628ba33
resetting go files
aliciascott 291813c
uploading video and all API Tests configs
aliciascott ecf4045
finalizing API tests based on review
aliciascott b65d6e2
updating Browser tests
aliciascott 3fd5b53
adding mobile app tests
aliciascott b417bdd
updating Browser
aliciascott 96457f4
updates to Templates PR from editorial review and adding mobile app v…
aliciascott a1c6396
Apply suggestions from code review
aliciascott File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -24,44 +24,51 @@ further_reading: | |||||
|
||||||
## Overview | ||||||
|
||||||
[Browser tests][1] are scenarios that Datadog executes on your web applications. You can configure periodic intervals to run tests from multiple locations, devices, and browsers as well as execute them from your CI/CD pipelines. | ||||||
|
||||||
{{< img src="getting_started/synthetics/browser-test-overview.png" alt="Overview of a Synthetics Browser Test" style="width:100%;" >}} | ||||||
|
||||||
These tests verify that your users can perform **key business transactions** on your applications and that they are not negatively impacted by recent code changes. | ||||||
[Browser tests][1] are scenarios that Datadog executes on your web applications. You can configure periodic intervals to run tests from multiple locations, devices, and browsers as well as execute them from your CI/CD pipelines. These tests verify that your users can perform **key business transactions** on your applications and that they are not negatively impacted by recent code changes. | ||||||
|
||||||
## Create a browser test | ||||||
|
||||||
The example below demonstrates the creation of a browser test that maps a user's journey from adding an item to a cart to successfully checking out. | ||||||
|
||||||
{{< img src="getting_started/synthetics/browser-test-1.png" alt="Browser test mapping out a user journey" style="width:100%;" >}} | ||||||
### Configure your test details | ||||||
|
||||||
1. In the Datadog site, hover over **Digital Experience** in the left hand menu and select **[Tests][2]** (under **Synthetic Monitoring & Testing**). | ||||||
2. In the top right corner, click **New Test** > **[Browser Test][3]**. | ||||||
3. Define your browser test: | ||||||
|
||||||
- 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. | ||||||
- Select **Advanced Options** to set custom request options, certificates, authentication credentials, and more. | ||||||
In this example, no specific advanced option is needed. | ||||||
- 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. | ||||||
- Choose the browsers and devices you want to test with. | ||||||
You may create a test using one of the following options: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
For next time! |
||||||
|
||||||
- **Create a test from a template**: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
For next time! |
||||||
|
||||||
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" >}} | ||||||
aliciascott marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
- **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** to submit your Browser Test. | ||||||
|
||||||
### Select locations | ||||||
### Select locations | ||||||
|
||||||
Select one or more **Managed Locations** or **Private Locations** to run your test from. | ||||||
|
||||||
Managed locations allow you to test public-facing websites and endpoints. To test internal applications or simulate user behavior in discrete geographic regions, use [private locations][4] instead. | ||||||
|
||||||
The Shopist application is publicly available at `https://www.shopist.io/`, so you can pick any managed locations to execute your test from. | ||||||
|
||||||
### Specify test frequency | ||||||
### Specify test frequency | ||||||
|
||||||
Select the frequency at which you want your test to execute. You can leave the default frequency of 1 hour. | ||||||
|
||||||
In addition to running your Synthetic test on a schedule, you can trigger them manually or directly from your [CI/CD pipelines][5]. | ||||||
|
||||||
### Define alert conditions | ||||||
### Define alert conditions | ||||||
|
||||||
You can define alert conditions to ensure your test does not trigger for things like a sporadic network blip, so that you only get alerted in case of real issues with your application. | ||||||
|
||||||
|
@@ -77,7 +84,7 @@ You can also configure your test to only trigger a notification when your applic | |||||
An alert is triggered if your test fails for 3 minutes from any 2 of 13 locations | ||||||
``` | ||||||
|
||||||
### Configure the test monitor | ||||||
### Configure the test monitor | ||||||
|
||||||
Design your alert message and add an email address you want your test to send alerts to. | ||||||
|
||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a huge deal, but I would consider making these options their own H3 sections in the next iteration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah good callout! We went back and forth on this and landed with this layout for now, but I can improve on this down the road :)