Trigger test alert from the GitLab interface
Problem to solve
(I think) Improves onboarding for GitLab users who are going to use alerting functionality.
During one of Monitoring weekly meetings, Amelia mentioned that (I don't remember exact saying) the generic alert configuration page not very clear to users. That's not that obvious that steps do users need to do next etc.
That's when this idea was born in my head.
What if we add a small portion of functionality, which will allow testing the configuration of the alert endpoint.
We can start from the "Test" button and an "Example payload" text area. We can prefix the text area with some dummy data, for example, with the list of fields we expect.
By clicking on the "Test" button, we will trigger the whole Alert workflow. We create an alert and an attached to that alert GitLab issue. Of course, we will prefix the alert's title with "[TEST]" or something like that. We can add "next steps" in the description etc.
There is similar functionality in different applications. Database clients use it to test the configured connection. Grafana allows to "Save & Test" when adding a new data source.
We, as the grouphealth Monitor team, can also benefit from that. We can give a quick test when we roll out new changes.
|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.