Build custom alert message #3137

k-tomoyasu · 2018-11-28T15:03:23Z

Build custom alert messages with query results.

Alert feature is useful but we cannot see detail about query result.
This feature enable us write custom alert messages with query results (using template engine Jinja2).

WIP yet. I would appreciate if give me feedback.

alert destination

setting

slack alert

kocsmy · 2018-11-28T15:47:11Z

Nice feature @k-tomoyasu — regarding the color of the preview button: we don't use that color so using btn-default would make sense. I'll think about having a better layout for this in the meantime.

k-tomoyasu · 2018-12-01T12:38:35Z

Nice feature @k-tomoyasu — regarding the color of the preview button: we don't use that color so using btn-default would make sense. I'll think about having a better layout for this in the meantime.

@kocsmy Thanks for your advice!
Firstly, I changed button color (and some fixes) and update screenshots.

jupe · 2019-01-18T06:29:43Z

When we get this in ? Could rest of integrations be done in follow-up PR? I would like to get this first for emails and for slack..

k-tomoyasu · 2019-01-19T14:05:47Z

@jupe Thanks for your comment!

Could rest of integrations be done in follow-up PR?

That's a big help if it is OK.
I was not good progress of integration because rest destinations are not easy to debug in my environment.

jupe · 2019-01-19T19:30:26Z

For our case email&slack would be enough. Most probably we doesn’t need anything else, at least in near future. Currently slack alert is almost useless because it gives just title, not even link.. so this would be really welcome feature :)

client/app/pages/alert/index.js

redash/handlers/api.py

…rt-custom-message

client/app/services/alert-template.js

arikfr

Thank you for this pull request, @k-tomoyasu ! This is a great feature and apologies that I couldn't review it sooner.

I made a few comments inline in code, but I have two other things to discuss in general --

How about we use Mustache as the template language? It has two important benefits: ability to render preview in client side without having to call the server and more importantly: it's far more secure. While Jinja2 supposed to be secure, it still has quite a big attack surface.

For Email type notification it will be beneficial to be able to edit the subject too. How about we provide the user the option to customize "Alert short description" (will be used as subject for email, text for Slack and just first line for others) and "Alert description" (what you already have)?

There will be needed some UI work as well, but we can do this in a follow up once we work out the other details. And this is something we can help you with.

Thanks!

arikfr · 2019-02-25T16:11:06Z

migrations/versions/ed7bf6adbd4d_add_alert_template.py

+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('alerts', sa.Column('template', sa.Text(), nullable=True))


Let's put template in the options JSON object we already have in alerts.

okay, fix logic and remove migration file.

arikfr · 2019-02-25T16:13:48Z

redash/models/__init__.py

@@ -772,6 +773,10 @@ def evaluate(self):
    def subscribers(self):
        return User.query.join(AlertSubscription).filter(AlertSubscription.alert == self)

+    def render_template(self, showError=None):


showError seems to be unused? Also should be show_error.

thanks! I've removed.

…nto alert-custom-message

k-tomoyasu · 2019-04-16T01:20:16Z

@arikfr
I implemented on other destinations(except hipchat).
(except hipchat).

Thank you for updating this! Please see follow up comments.

Thank you for comments!
I've updated. it's ready to review.

arikfr · 2019-05-13T16:09:36Z

Apologies for letting this linger. I will try to get to it this week 🤞

karamov-git · 2019-06-14T09:22:47Z

Hello, I am also looking forward to this functionality. How soon does this appear in redash?
Thank.

arikfr · 2019-07-11T09:28:55Z

Apologies for letting this linger. I will try to get to it this week 🤞

"this week"... 2 months later here I am 😅

To avoid further review cycles, I did some changes myself:

Updated with latest master (there were some merge conflicts to fix).
Updated how the Webhook destination handles these new options (b078866).
Add log message when checking alert (60cb858, not really related to this PR, just happened to include it).
Added a feature flag (REDASH_FEATURE_EXTENDED_ALERT_OPTIONS, disabled by default) to control whether to show the new options.

The reason for the feature flag is that the UI still needs more work. I will work on the product and UX definition with @ranbena and we will do these changes ourselves (along with converting this page to React).

But you can already use this in your setup 👍

Thank you for your effort here, this great feature and patience during the process.

Once the build passes I will merge this.

arikfr · 2019-07-11T10:22:43Z

@k-tomoyasu it's not a big thing, but the email address you signed this commits with (k.tomoyasu@geniee.co.jp) is not associated with your GitHub account. This means that you won't show up in the contributors page on GitHub :-( You can fix this by verifying this email address in your account: https://help.github.com/en/articles/setting-your-commit-email-address.

arikfr · 2019-07-11T10:23:12Z

Merged 👍

k-tomoyasu · 2019-07-11T13:44:18Z

@arikfr
Thanks for fix and future plan:+1:
I'm looking forward to next release:smile:

You can fix this by verifying this email address in your account

Thank you for your kindness. But this email is invalid now...
I'm glad to be listed on the page at the next opportunity!

* build custom alert message * fit button color tone * pass existing test * fix typos * follow code style * add webhook alert description and avoid key error * refactor: create alert template module * follow code style * use es6 class, fix template display * use alerts.options, use mustache * fix email description * alert custom subject * add alert state to template context, sanitized preview * remove console.log 🙇 * chatwork custom_subject * add alert custom message. pagerduty, mattermost, hangoutschat * Pass custom subject in webhook destination * Add log message when checking alert. * Add feature flag for extra alert options.

Vaidas737 · 2019-10-29T18:53:46Z

Hi, how to enable this feature in version 8.0.0

ranbena · 2019-10-29T18:57:55Z

@Vaidas737 https://redash.io/help/user-guide/alerts/custom-alert-notifications

Vaidas737 · 2019-10-29T19:06:29Z

Thanks

arikfr · 2019-10-29T19:13:49Z

@ranbena the link you referenced is for v9...

@Vaidas737 in v8, you can enable it with an env var, but note that it won't be 100% compatible with the final implementation in v9.

Vaidas737 · 2019-10-29T20:13:18Z

@arikfr thanks a lot

* build custom alert message * fit button color tone * pass existing test * fix typos * follow code style * add webhook alert description and avoid key error * refactor: create alert template module * follow code style * use es6 class, fix template display * use alerts.options, use mustache * fix email description * alert custom subject * add alert state to template context, sanitized preview * remove console.log 🙇 * chatwork custom_subject * add alert custom message. pagerduty, mattermost, hangoutschat * Pass custom subject in webhook destination * Add log message when checking alert. * Add feature flag for extra alert options.

auziel · 2021-01-02T10:07:09Z

@Vaidas737 in v8, you can enable it with an env var, but note that it won't be 100% compatible with the final implementation in v9.

Hi @arikfr I know it is a year old feature and v9 is already there, but I'm still on v8.0.0. I didn't find a clear explanation how to enable it in v8.
I try to set FEATURE_EXTENDED_ALERT_OPTIONS=true which didn't enable the feature.
Is there a clear doc how to enable this feature for v8.0.0?
How can I customize the message body (I'm using Slack as the alert target)?

isdzulqor · 2021-09-01T10:57:42Z

@Vaidas737 in v8, you can enable it with an env var, but note that it won't be 100% compatible with the final implementation in v9.

Hi @arikfr I know it is a year old feature and v9 is already there, but I'm still on v8.0.0. I didn't find a clear explanation how to enable it in v8.
I try to set FEATURE_EXTENDED_ALERT_OPTIONS=true which didn't enable the feature.
Is there a clear doc how to enable this feature for v8.0.0?
How can I customize the message body (I'm using Slack as the alert target)?

try REDASH_FEATURE_EXTENDED_ALERT_OPTIONS not FEATURE_EXTENDED_ALERT_OPTIONS @auziel

moonsub-kim · 2022-03-06T04:39:32Z

Can I use this feature with the docker version redash/redash:10.1.0.b50633?
I enabled REDASH_FEATURE_EXTENDED_ALERT_OPTIONS=true but the alert preview gets no results.

query result

alert template

alert body

susodapop · 2022-04-27T17:16:55Z

Can I use this feature with the docker version redash/redash:10.1.0.b50633?

This feature was replaced in V9 and is now always enabled (the environment variable has no effect). You can read about how to use it here.

build custom alert message

efa10d8

Kota Tomoyasu added 4 commits December 1, 2018 18:25

fit button color tone

82b8cf7

pass existing test

fdd6937

fix typos

0908c0b

follow code style

a7f6076

yoavbls mentioned this pull request Dec 8, 2018

Refactor alert add/edit page #3172

Closed

Kota Tomoyasu added 2 commits January 19, 2019 18:01

resolve conflict

0d06612

add webhook alert description and avoid key error

2133e43

ghost added the in progress label Jan 19, 2019

k-tomoyasu changed the title ~~WIP Build custom alert message~~ Build custom alert message Jan 19, 2019

arikfr added PR: unreviewed and removed in progress labels Jan 23, 2019

arikfr self-assigned this Jan 23, 2019

resolve conflict

98e12f5

ghost added the in progress label Jan 31, 2019

codeclimate bot reviewed Jan 31, 2019

View reviewed changes

client/app/pages/alert/index.js Outdated Show resolved Hide resolved

redash/handlers/api.py Outdated Show resolved Hide resolved

Kota Tomoyasu added 4 commits February 5, 2019 23:16

refactor: create alert template module

a9e72e7

follow code style

663c4b4

use es6 class, fix template display

7bea6ae

Merge branch 'master' of https://github.com/getredash/redash into ale…

ce9c315

…rt-custom-message

rauchy reviewed Feb 6, 2019

View reviewed changes

client/app/services/alert-template.js Outdated Show resolved Hide resolved

rauchy requested a review from kravets-levko February 6, 2019 07:14

arikfr reviewed Feb 25, 2019

View reviewed changes

arikfr removed the PR: unreviewed label Mar 6, 2019

Kota Tomoyasu added 2 commits March 29, 2019 09:33

Merge branch 'alert-custom-message' of github.com:k-tomoyasu/redash i…

9623286

…nto alert-custom-message

add alert custom message. pagerduty, mattermost, hangoutschat

ba64403

weekly-digest bot mentioned this pull request May 20, 2019

Weekly Digest (13 May, 2019 - 20 May, 2019) #3814

Closed

weekly-digest bot mentioned this pull request Jun 17, 2019

Weekly Digest (10 June, 2019 - 17 June, 2019) #3906

Closed

arikfr added 4 commits July 8, 2019 10:10

Merge branch 'master' into alert-custom-message

13cc325

Pass custom subject in webhook destination

b078866

Add log message when checking alert.

60cb858

Add feature flag for extra alert options.

a96618f

arikfr merged commit a8ff250 into getredash:master Jul 11, 2019

arikfr mentioned this pull request Aug 11, 2019

Use unicode string for alert email subject. #2605

Closed

ranbena mentioned this pull request Sep 23, 2019

Alert redesign #4 - custom notification template #4170

Merged

2 tasks

mihiran-fc mentioned this pull request Oct 10, 2023

Redash mail setup with ses with helm on eks getredash/contrib-helm-chart#151

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build custom alert message #3137

Build custom alert message #3137

k-tomoyasu commented Nov 28, 2018 •

edited

Loading

kocsmy commented Nov 28, 2018

k-tomoyasu commented Dec 1, 2018

jupe commented Jan 18, 2019

k-tomoyasu commented Jan 19, 2019

jupe commented Jan 19, 2019

arikfr left a comment

arikfr Feb 25, 2019

k-tomoyasu Mar 25, 2019

arikfr Feb 25, 2019

k-tomoyasu Mar 25, 2019

k-tomoyasu commented Apr 16, 2019

arikfr commented May 13, 2019

karamov-git commented Jun 14, 2019

arikfr commented Jul 11, 2019

arikfr commented Jul 11, 2019

arikfr commented Jul 11, 2019

k-tomoyasu commented Jul 11, 2019 •

edited

Loading

Vaidas737 commented Oct 29, 2019

ranbena commented Oct 29, 2019

Vaidas737 commented Oct 29, 2019

arikfr commented Oct 29, 2019

Vaidas737 commented Oct 29, 2019

auziel commented Jan 2, 2021

isdzulqor commented Sep 1, 2021

moonsub-kim commented Mar 6, 2022 •

edited

Loading

susodapop commented Apr 27, 2022

Build custom alert message #3137

Build custom alert message #3137

Conversation

k-tomoyasu commented Nov 28, 2018 • edited Loading

kocsmy commented Nov 28, 2018

k-tomoyasu commented Dec 1, 2018

jupe commented Jan 18, 2019

k-tomoyasu commented Jan 19, 2019

jupe commented Jan 19, 2019

arikfr left a comment

Choose a reason for hiding this comment

arikfr Feb 25, 2019

Choose a reason for hiding this comment

k-tomoyasu Mar 25, 2019

Choose a reason for hiding this comment

arikfr Feb 25, 2019

Choose a reason for hiding this comment

k-tomoyasu Mar 25, 2019

Choose a reason for hiding this comment

k-tomoyasu commented Apr 16, 2019

arikfr commented May 13, 2019

karamov-git commented Jun 14, 2019

arikfr commented Jul 11, 2019

arikfr commented Jul 11, 2019

arikfr commented Jul 11, 2019

k-tomoyasu commented Jul 11, 2019 • edited Loading

Vaidas737 commented Oct 29, 2019

ranbena commented Oct 29, 2019

Vaidas737 commented Oct 29, 2019

arikfr commented Oct 29, 2019

Vaidas737 commented Oct 29, 2019

auziel commented Jan 2, 2021

isdzulqor commented Sep 1, 2021

moonsub-kim commented Mar 6, 2022 • edited Loading

susodapop commented Apr 27, 2022

k-tomoyasu commented Nov 28, 2018 •

edited

Loading

k-tomoyasu commented Jul 11, 2019 •

edited

Loading

moonsub-kim commented Mar 6, 2022 •

edited

Loading