Оповещения Readsh
Настройка оповещения
Оповещения Redash уведомляют вас о том, что поле, возвращаемое запланированным запросом, соответствует пороговому значению. Используйте их для мониторинга бизнеса. Или интегрируйте их с такими инструментами, как Zapier или IFTTT, для запуска рабочих процессов, например, регистрации пользователей или отправки заявок в службу поддержки. Оповещения дополняют запланированные запросы, но их критерии проверяются после каждого выполнения.
Чтобы просмотреть список текущих оповещений, нажмите кнопку Alerts на панели навигации. По умолчанию они отсортированы в обратном хронологическом порядке по колонке Created At. Вы можете изменить порядок списка, щелкнув по заголовкам столбцов.
- Name показывает строковое имя каждого оповещения. Вы можете изменить его в любое время.
- Created By показывает пользователя, создавшего данное оповещение.
- State показывает, в каком состоянии находится оповещение: UNKNOWN, TRIGGERED или OK.
Использование
Нажмите кнопку Create на панели навигации, а затем выберите New Alert.
Выполните поиск целевого запроса. Если вы не видите нужного запроса, убедитесь, что он опубликован и не использует параметры.
Используйте панель настроек для конфигурирования оповещения.
Раскрывающийся столбец Value управляет тем, какое поле результата запроса будет оцениваться.
Раскрывающийся список Condition определяет логическую операцию, которая будет применена.
Введенный текст Threshold будет сравниваться со столбцом Value с использованием заданного условия.
Далее настройте количество уведомлений, которые будут приходить во время срабатывания оповещения. Существует три варианта:
- Just Once означает, что уведомление будет приходить каждый раз, когда состояние оповещения изменится с OK на TRIGGERED.
- Each time alert is evaluated означает, что уведомление будет приходить всякий раз, когда состояние оповещения будет TRIGGERED, независимо от его состояния на момент предыдущей оценки.
- At most every позволяет установить минимальный интервал между оповещениями. Он разделяет разницу между " Just Once " и "Each time alert is evaluated". Этот выбор позволяет избежать спама уведомлений для оповещений, которые срабатывают часто.
Независимо от выбранной здесь настройки уведомления будут приходить каждый раз, когда статус переходит из состояния OK в состояние TRIGGERED или из состояния TRIGGERED в состояние OK. Приведенные выше настройки расписания влияют только на количество уведомлений, которые будут приходить, если статус остается TRIGGERED от одного выполнения к другому.
Наконец, выберите шаблон. По умолчанию шаблон представляет собой сообщение со ссылками на экран настройки оповещения и экран запроса. Многие пользователи захотят включить более конкретную информацию об оповещении. Для этого можно настроить шаблон оповещения.
После завершения работы нажмите кнопку Create Alert, а затем выберите Alert Destination. Если вы пропустите этот шаг, то не получите уведомления о срабатывании оповещения.
Отключение звуковых сигналов оповещения
Можно временно отключить уведомления, не удаляя оповещение полностью. Для этого достаточно щелкнуть на вертикальное многоточие (⋮) и выбрать пункт Mute Notifications.
Чтобы возобновить прием уведомлений, щелкните на вертикальном многоточии и выберите пункт Unmute Notifications..
Состояния оповещения
- TRIGGERED означает, что при последнем выполнении столбец Value в целевом запросе удовлетворял заданным условиям (Condition) и порогу срабатывания (Threshold).
- OK означает, что при последнем выполнении запроса столбец Value не удовлетворял настроенным условиям (Condition) и порогу (Threshold).
- UNKNOWN означает, что Redash не имеет достаточно данных для оценки критериев оповещения. Этот статус будет отображаться сразу после создания предупреждения до тех пор, пока не будет выполнен запрос. Вы также увидите это состояние, если в результате запроса не было данных или если последний результат запроса не включает настроенный вами столбец Value.
Периодичность оповещения
Redash отправляет уведомления на выбранные вами пункты назначения оповещений каждый раз, когда обнаруживает, что статус оповещения изменился с OK на TRIGGERED или наоборот. Рассмотрим пример, в котором оповещение настроено на запрос, который планируется выполнять один раз в день. Ежедневное состояние оповещения представлено в таблице ниже. До понедельника статус оповещения был OK.
|
Day |
Alert Status |
|
Monday |
OK |
|
Tuesday |
OK |
|
Wednesday |
TRIGGERED |
|
Thursday |
TRIGGERED |
|
Friday |
TRIGGERED |
|
Saturday |
TRIGGERED |
|
Sunday |
OK |
Если частота оповещений установлена в значение Just Once, то Redash отправит уведомление в среду, когда статус изменится с OK на TRIGGERED, и снова в воскресенье, когда он изменится обратно. Он не будет посылать оповещения в четверг, пятницу или субботу, если вы специально не настроите его на это, поскольку статус Alert не менялся между выполнениями в эти дни.
Добавление новых пунктов назначения оповещений
При срабатывании оповещения оно отправляет сгусток связанных данных (так называемый шаблон оповещения) назначенным Alert Destinations (адресатам оповещения). Пункты назначения могут использовать эти данные для отправки электронных писем, сообщений Slack или пользовательских веб-крючков. Настроить новые пункты назначения оповещений можно на экране настроек. Добавлять новые пункты назначения оповещений могут только администраторы. После настройки направления доступны всем пользователям.
Добавить новое направление оповещения
На выбор предлагается несколько типов направлений: Электронная почта, Slack, PagerDuty, Mattermost, Чат Google Hangouts, HipChat, ChatWork, Generic WebHook.
Для настройки одного из них выберите его в диалоге Create a New Alert Destination и следуйте его указаниям.
Настройка уведомлений для оповещений
Оповещения Redash могут уведомлять вас о том, что ваши запросы соответствуют некоторым произвольным критериям. Если вы хотите изменить текст уведомления, нажмите кнопку “Edit" в верхней части страницы оповещения.
Рядом с параметром "Template" щелкните на выпадающем списке и выберите "Custom template". Появится окно, состоящее из полей ввода темы и тела сообщения.
Можно использовать любое статическое содержимое, а также встроенные переменные шаблона:
- ALERT_STATUS - Оцененный статус оповещения (строка).
- ALERT_CONDITION - Оператор условия оповещения (строка).
- ALERT_THRESHOLD - Порог оповещения (строка или число).
- ALERT_NAME - Имя оповещения (строка).
- ALERT_URL - URL-адрес страницы оповещения (строка).
- QUERY_NAME - Имя коррелированного запроса (строка).
- QUERY_URL - URL-адрес связанной страницы запроса (строка).
- QUERY_RESULT_VALUE - Значение результата запроса (строка или число).
- QUERY_RESULT_ROWS - Строки результатов запроса (массив значений).
- QUERY_RESULT_COLS - Столбцы результатов запроса (массив строк).
- QUERY_RESULT_TABLE - Результаты запроса отформатированы как двумерный массив значений.
Пример уведомления может быть таким: Оповещение "{{ALERT_NAME}}" изменило статус на {{ALERT_STATUS}}.
Нажмите кнопку "Preview" для предварительного просмотра отрисованного результата и сохраните изменения, нажав кнопку "Save".
Оповещение по нескольким столбцам
Существует косвенный способ установки оповещения на основе нескольких столбцов запроса:
Ваш запрос может реализовать логику оповещения и возвращать булево значение, по которому будет срабатывать оповещение. Пример:
SELECT CASE WHEN drafts_count > 10000 AND archived_count > 5000 THEN 1 ELSE 0 END FROM ( SELECT sum (CASE WHEN is_archived THEN 1 ELSE 0 END) AS archived_count, sum(CASE WHEN is_draft THEN 1 ELSE0 END) AS drafts_count FORM quieries) data
Этот запрос вернет значение 1, если drafts_count > 10000 и archived_count > 5000. Затем можно настроить оповещение так, чтобы оно срабатывало, когда значение равно 1.
