Trigger test alert from GitLab
Problem to solve
Once a user has configured the alert endpoint, they will want to test the set-up to confirm it is will receive alerts and function as expected. This is common when setting up integrations so that the user has peace of mind that critical alerts are not going to get dropped. This will improve the onboarding experience for new users and therefore increase adoption.
Moreover, this will be really helpful for the Monitor:Health team to test new features.
Intended users
Further details
This work drives the direction of the Alert Management category.
Proposal
Add functionality to the Alert management configuration page where users can send an example payload to the endpoint to confirm that it was set-up correctly. The user will see an example payload input pre-populated with some example data. They can modify this if they wish. Clicking the test button triggers the alert workflow.
Design
| Updated default page | Endpoint activated | Test failed | Auth key reset |
|---|---|---|---|
 |
 |
 |
 |
In scope for this issue:
- Text updates in body copy
- Adding a field where the test alert will show
- Adding a test and save changes button
- Success and failure alert messages
Out of scope for this issue:
- Adding the monitoring tool dropdown
- Up for discussion: the auth key reset success message. It doesn't necessarily need to be part of this issue. It's just a nice add given the other changes we're discussing on this page. We can make adding this a separate issue, if need be.
Note: the alerts endpoint section will be moved to Settings > Operations as part of #219142 (closed). So, the location of the alerts endpoint config page will depend on the status of that issue.
Permissions and Security
Documentation
Documentation required, please add it here.