[DOCS-12756] add alerting to test suites #33387
Conversation
Preview links (active after the
|
|
|
||
| ## Alerting | ||
|
|
||
| Test suite alerting lets you organize related tests into meaningful collections by user journey, service, environment, or team. This allows you to receive a single, consolidated alert when a critical portion of the suite fails, giving you a unified view of impact and helps you respond more efficiently when important workflows break. |
There was a problem hiding this comment.
| Test suite alerting lets you organize related tests into meaningful collections by user journey, service, environment, or team. This allows you to receive a single, consolidated alert when a critical portion of the suite fails, giving you a unified view of impact and helps you respond more efficiently when important workflows break. | |
| Test suite alerting lets you organize related tests into meaningful collections by user journey, service, environment, or team. This allows you to receive a consolidated alert when a critical portion of the suite fails, giving you a unified view of impact and helps you respond more efficiently when important workflows break. |
|
|
||
| With test suite alerting, you can: | ||
|
|
||
| - Mark each test in the suite as **Critical** or **Ignored** (all tests are marked Critical by default). |
There was a problem hiding this comment.
| - Mark each test in the suite as **Critical** or **Ignored** (all tests are marked Critical by default). | |
| - Mark each test in the suite as **Critical** or **Ignored**. |
|
|
||
| **Note**: Test runs appear in the suite only from the date the test was added. To view earlier results, check the individual test page. If you rename a test, previous runs remain listed under the original name. A maximum of 300 tests can be added per suite. | ||
|
|
||
| {{< img src="synthetics/test_suites/test_suite_summary.png" alt="Synthetic Monitoring Test Suite summary page" style="width:100%;">}} |
There was a problem hiding this comment.
We also have to update the previous sections on test suite as it has changed a bit now that we have alerting
There was a problem hiding this comment.
I cannot comment the previous section but in the View and manage section we should explain that they are now 3 tabs when you view a test suite:
- The first tab is listing the test within the suite
- The second tab contains the global uptime and the related runs
- The last tab contains the attributes
You can have access to the feature in prod by enabling the flag synthetics_suite_monitors
There was a problem hiding this comment.
Regarding the key features section we should definitely add something about alerting:
- Impact-driven alerting: Receive a consolidated alert when a critical portion of the suite fails, helping you focus on meaningful issues instead of isolated test failures.
and it should be the first bullet point
There was a problem hiding this comment.
We should also update the overview section accordingly
|
|
||
| {{< img src="synthetics/test_suites/test_suite_summary.png" alt="Synthetic Monitoring Test Suite summary page" style="width:100%;">}} | ||
|
|
||
| ## Alerting |
There was a problem hiding this comment.
I think that this section should actually be included in the section named Test suite configuration that doesn't appear in this PR because it's immediately when creating a test suite that users will have to configure their test suite alert.
Also the screenshot in this Test suite configuration section should be updated
| - **Centralized visibility**: View all tests in a suite and their results in one place. | ||
| - **Simplified management**: Create and run test groups instead of managing individual tests separately. | ||
| - **Easier maintenance**: Identify which tests need updates when application changes are made. | ||
| - **Alerting**: Configure suite-level alerting to receive notifications when critical portions of your tests fail. |
There was a problem hiding this comment.
Alerting should be the first bullet point IMO
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes