Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alert Notification doc #292

Merged
merged 5 commits into from
Oct 7, 2019
Merged

Alert Notification doc #292

merged 5 commits into from
Oct 7, 2019

Conversation

ranbena
Copy link
Contributor

@ranbena ranbena commented Sep 24, 2019

Documentation for v9 feature getredash/redash#4170.

@ranbena ranbena self-assigned this Sep 24, 2019
Copy link
Member

@arikfr arikfr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth adding a note on how different destinations might use the values slightly differently and that the preview is just for showing how the template variables will render.

And maybe this should be a section in the alert setup page?

@ranbena
Copy link
Contributor Author

ranbena commented Sep 24, 2019

Worth adding a note on how different destinations might use the values slightly differently and that the preview is just for showing how the template variables will render.

Done:

Screen Shot 2019-09-24 at 14 31 26

And maybe this should be a section in the alert setup page?

  1. I think it's quite the huge page already.
  2. The alert setup page requires an update as well but I'd rather keep it as is till v9.

Wdyt?

@susodapop
Copy link
Contributor

1. I think it's quite the huge page already.

True.

Any static content is valid, and you can also incorporate some built-in template variables:

ALERT_STATUS - The evaluated alert status (string)
ALERT_CONDITION - The alert condition operator (string).
ALERT_THRESHOLD - The alert threshold (string or number).
ALERT_NAME - The alert name (string).
ALERT_URL - The alert page url (string).
QUERY_NAME - The correlated query name (string).
QUERY_URL - The correlated query page url (string).
QUERY_RESULT_VALUE - The query result value (string or number)
QUERY_RESULT_ROWS - The query result rows (value array)
QUERY_RESULT_COLS - The query result columns (string array),

But these variable names make the most sense in context of the "Setting Up An Alert" page. Specifically the ALERT_STATUS and ALERT_CONDITION variables. If nothing else, could we enumerate the possible values for both variables?

@ranbena
Copy link
Contributor Author

ranbena commented Sep 26, 2019

How about adding an exact link to the relevant sections in the setup-alert page from the variable descriptions?

@ranbena
Copy link
Contributor Author

ranbena commented Oct 2, 2019

Added inline links to config setting explanations.

Screen Shot 2019-10-02 at 9 26 58

@ranbena
Copy link
Contributor Author

ranbena commented Oct 7, 2019

Gonna land this. Any change requests will be handled in new PR.

@ranbena ranbena merged commit 80a375c into master Oct 7, 2019
@ranbena ranbena deleted the alert-notification-doc branch October 7, 2019 16:16
arikfr added a commit that referenced this pull request Oct 7, 2019
arikfr added a commit that referenced this pull request Oct 7, 2019
@arikfr arikfr restored the alert-notification-doc branch October 7, 2019 18:37
@arikfr
Copy link
Member

arikfr commented Oct 7, 2019

I restored the branch so we can push this again.

@arikfr arikfr deleted the alert-notification-doc branch June 22, 2020 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants