gatus icon indicating copy to clipboard operation
gatus copied to clipboard

additional placeholders for alerting

Open Darkvater opened this issue 2 years ago • 4 comments

Describe the feature request

Alerting currently only has the below placeholders.

  • ALERT_DESCRIPTION
  • ENDPOINT_NAME
  • ALERT_TRIGGERED_OR_RESOLVED

This is quite rudimentary to implement into custom alerting endpoints (like rocket.chat webhooks for example). While some of the built-in alerts can show how often the health-point failed, or show which condition failed, this is not possible for custom alerts. I think the following placeholders should be added:

  • CONDITION_FAILURE_COUNT
  • CONDITIONS_FAILED (array)
  • ENDPOINT_URL

I am not sure what the final architectural design is for alerting but it should be made easy to add any alerting types. For this we could think about the ability to execute external scripts (passing placeholders to it) and offload maintenance and development of it to the community

Why do you personally want this feature to be implemented?

Powerful alerting capabilities are a must for any monitoring tool. Nobody is going to be looking at a web page all day long to see if, and when something fails. Potentially off-loading alerting development/maintenance to the community encourages wider adoption and more focus on project's main aims.

How long have you been using this project?

1 week

Additional information

Love the project by the way! Was a breeze to setup, a well-thought out, easily understandable UI, and minimal resource requirements make it perfect for use outside of a kubernetes/managed cloud environment.

Darkvater avatar May 03 '22 19:05 Darkvater

f899f41d161e675039168b196aa28304f648f0af has added [ENDPOINT_URL] and [ENDPOINT_GROUP], but as for the other suggestions you had, I'm not sure how to tackle them.

Honestly, I would rather have a specific provider implementation for more complex use cases, but if you have a solution, feel free to suggest it.

TwiN avatar Jun 07 '22 23:06 TwiN

The aforementioned [ENDPOINT_URL] and [ENDPOINT_GROUP] have been released in v4.0.0.

TwiN avatar Jun 21 '22 01:06 TwiN