public-roadmap icon indicating copy to clipboard operation
public-roadmap copied to clipboard

Allow alert messages to be customized

Open theothertomelliott opened this issue 3 years ago • 1 comments

Is your feature request related to a problem? Please describe.

We have configured our Checkly checks to alert to PagerDuty and all pages are sent in the form:

Summary: Your check '<checkname>' is failing! Body:

CUSTOM DETAILS
--
location        Tokyo          response time        1861ms | location | Tokyo | response time | 1861ms
location | Tokyo
response time | 1861ms

LINKS
--
View your failing check in the Checkly dashboard
CLIENT
View in Checkly

Our OnCall team often don't have full knowledge of the inner workings of the systems involved in each alert, so we have created Playbooks for our check groups, but these can be difficult to find with the information provided in the alert.

Describe the solution you'd like

We would like to be able to customize the alert summary and message content for our alerts. Our Checks are organized into Groups, so the Check name and URL would also need to be included via some form of templating.

Describe alternatives you've considered

Possible alternatives:

  • Add a "Documentation" property to Checks allowing a link to be included with more information
  • Allow arbitrary key/value pairs to be added to alert messages along with location and response time as above

theothertomelliott avatar Jan 11 '22 17:01 theothertomelliott

@theothertomelliott this is an interesting option I would like to explore. I think a dedicated, structured "docs" or "runbook" or "reference" item on checks and groups will make more sense than a custom name per alert.

In the mean time, maybe using our webhooks would help you more. It allows full customization of pretty much all aspects of the alert. https://www.checklyhq.com/docs/alerting/webhooks/#using-handlebars-helpers

tnolet avatar Jan 25 '22 19:01 tnolet