Действие Watcher по электронной почте

Вы настраиваете действия электронной почты в массиве actions. Атрибуты, относящиеся к действиям, указываются с помощью ключевого слова email.

Например, следующее действие электронной почты использует шаблон для включения данных из полезной нагрузки наблюдения в текст сообщения электронной почты:

"actions" : {
  "send_email" : { 
    "email" : { 
      "to" : "username@example.org", 
      "subject" : "Watcher Notification", 
      "body" : "{{ctx.payload.hits.total}} error logs found" 
    }
  }
}

Вы можете прикрепить полезную нагрузку контекста выполнения или данные из любой службы HTTP к уведомлению по электронной почте. Нет ограничений на количество вложений, которые вы можете настроить.

Чтобы настроить вложения, укажите имя прикрепленного файла и тип вложения: data, http или reporting. Тип вложения data прикрепляет полезную нагрузку контекста выполнения к сообщению электронной почты. Тип вложения http позволяет отправлять HTTP-запрос и прикреплять ответ к сообщению электронной почты. При настройке типа вложения http необходимо указать URL-адрес запроса. Тип вложения reporting — это специальный тип для включения панелей мониторинга PDF, отображаемых из Kibana. Этот тип постоянно опрашивает приложение Kibana, если рендеринг панели мониторинга завершен, предотвращая длительные HTTP-подключения, которые могут быть прерваны брандмауэрами или балансировщиками нагрузки.

"actions" : {
  "email_admin" : {
    "email": {
      "to": "John Doe <john.doe@example.com>",
      "attachments" : {
        "my_image.png" : { 
          "http" : { 
            "content_type" : "image/png",
            "request" : {
              "url": "http://example.org/foo/my-image.png" 
            }
          }
        },
        "dashboard.pdf" : {
          "reporting" : {
            "url": "http://example.org:5601/api/reporting/generate/dashboard/Error-Monitoring"
          }
        },
        "data.yml" : {
          "data" : {
            "format" : "yaml" 
          }
        }
      }
    }
  }
}

Watcher может отправлять электронные письма с помощью любого SMTP-сервиса электронной почты. Электронные письма могут содержать базовые теги HTML. Вы можете контролировать, какие группы тегов разрешены, используя Настройка параметров очистки HTML.

Вы настраиваете учётные записи, которые Watcher может использовать для отправки электронных писем, в пространстве имён xpack.notification.email в elasticsearch.yml. Пароль указанного SMTP-пользователя хранится в защищённом виде в хранилище ключей Elasticsearch.

Если для вашей учётной записи электронной почты требуется двухэтапная проверка подлинности, вам необходимо сгенерировать и использовать уникальный пароль приложения для отправки писем от Watcher. Аутентификация завершится ошибкой, если вы используете свой основной пароль.

Watcher предоставляет три профиля электронной почты, которые управляют тем, как структурируются сообщения MIME: standard (по умолчанию), gmail и outlook. Эти профили учитывают различия в том, как различные почтовые системы интерпретируют стандарт MIME. Если вы используете Gmail или Outlook, мы рекомендуем использовать соответствующий профиль. Используйте профиль standard, если вы используете другую почтовую систему.

Для получения дополнительной информации о настройке Watcher для работы с различными почтовыми системами см.:

Если вы настраиваете несколько учётных записей электронной почты, вы должны либо настроить учётную запись по умолчанию, либо указать, с какой учётной записью должно отправляться письмо, в действии email.

xpack.notification.email:
  default_account: team1
  account:
    team1:
      ...
    team2:
      ...

Используйте следующие настройки учётной записи электронной почты для отправки писем с помощью SMTP-сервиса Gmail:

xpack.notification.email.account:
    gmail_account:
        profile: gmail
        smtp:
            auth: true
            starttls.enable: true
            host: smtp.gmail.com
            port: 587
            user: <username>

Для хранения пароля SMTP учётной записи используйте команду keystore (см. защищённые настройки)

bin/elasticsearch-keystore add xpack.notification.email.account.gmail_account.smtp.secure_password

Если при попытке отправки письма Watcher возникает ошибка аутентификации, указывающая на необходимость продолжения процесса входа с веб-браузера, вам необходимо настроить Gmail на разрешение менее безопасным приложениям доступ к вашей учётной записи.

Если для вашей учётной записи включена двухэтапная проверка, вы должны сгенерировать и использовать уникальный пароль приложения для отправки электронных писем от Watcher. Дополнительную информацию см. в разделе Вход с помощью паролей приложений.

Используйте следующие настройки учётной записи электронной почты для отправки писем с помощью SMTP-сервиса Outlook.com:

xpack.notification.email.account:
    outlook_account:
        profile: outlook
        smtp:
            auth: true
            starttls.enable: true
            host: smtp-mail.outlook.com
            port: 587
            user: <email.address>

Для хранения пароля SMTP учётной записи используйте команду keystore (см. защищённые настройки)

bin/elasticsearch-keystore add xpack.notification.email.account.outlook_account.smtp.secure_password

При отправке писем необходимо указать адрес отправителя, либо по умолчанию в настройках учётной записи, либо в рамках действия электронной почты в мониторинге.

Используйте следующие настройки учётной записи электронной почты для отправки писем с помощью SMTP-сервиса Amazon Simple Email Service (SES):

xpack.notification.email.account:
    ses_account:
        smtp:
            auth: true
            starttls.enable: true
            starttls.required: true
            host: email-smtp.us-east-1.amazonaws.com 
            port: 587
            user: <username>

Для хранения пароля SMTP учётной записи используйте команду keystore (см. защищённые настройки)

bin/elasticsearch-keystore add xpack.notification.email.account.ses_account.smtp.secure_password

Используйте следующие настройки учётной записи электронной почты для отправки писем из Microsoft Exchange:

xpack.notification.email.account:
    exchange_account:
        profile: outlook
        email_defaults:
            from: <email address of service account> 
        smtp:
            auth: true
            starttls.enable: true
            host: <your exchange server>
            port: 587
            user: <email address of service account> 

Для хранения пароля SMTP учётной записи используйте команду keystore (см. защищённые настройки)

bin/elasticsearch-keystore add xpack.notification.email.account.exchange_account.smtp.secure_password

Действие email поддерживает отправку сообщений с HTML-телом. Однако по соображениям безопасности Watcher очищает HTML.

Вы можете контролировать, какие функции HTML разрешены или запрещены, настроив параметры xpack.notification.email.html.sanitization.allow и xpack.notification.email.html.sanitization.disallow в elasticsearch.yml. Вы можете указать отдельные HTML-элементы и группы функций HTML. По умолчанию Watcher разрешает следующие функции: body, head, _tables, _links, _blocks, _formatting и img:embedded.

Например, следующие настройки позволяют HTML содержать таблицы и блочные элементы, но запрещают теги <h4>, <h5> и <h6>.

xpack.notification.email.html.sanitization:
    allow: _tables, _blocks
    disallow: h4, h5, h6

Чтобы полностью отключить очистку, добавьте следующую настройку в elasticsearch.yml:

xpack.notification.email.html.sanitization.enabled: false