ankane / blazer

Business intelligence made simple
MIT License
4.56k stars 474 forks source link

[Idea] Add string column for message to checks #429

Closed gabrieltaylor closed 1 year ago

gabrieltaylor commented 1 year ago

Hi, Blazer Team!

We use Blazer checks a lot and would like to be able to link to a run book in a failing check Slack message or email. This could make the failing check more easily actionable. I think a 255-character string field would be sufficient and provide users the flexibility to add a description, a link to a run-book, emojis, etc., to the slack or email message.

If you are open to incorporating this feature, I'd like to volunteer to create the PR.

cianmce commented 1 year ago

It's not the perfect solution, but for us we use "bad data" checks and have the start of the query like

SELECT
  "https://example.com/page?runbook" AS runbook_url,
  id, ...
gabrieltaylor commented 1 year ago

I didn't even consider that @cianmce. Nice tip.

ankane commented 1 year ago

Hey @gabrieltaylor, thanks for the suggestion. You can also use the query description field to add instructions, so don't think an additional field is needed.

gabrieltaylor commented 1 year ago

@ankane what are your thoughts on adding the query description to the slack message or email? Are you be interested in incorporating that feature?

ankane commented 1 year ago

I don't think it's really needed, since you'll typically want to open the check page (to re-run it) to get the current state of things (and it'll be there), but you can always fork and add it for your application.