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

Documentation for Alerting Email Action Could Use Updating #88333

Closed
mark54g opened this issue Jan 14, 2021 · 2 comments · Fixed by #90020
Closed

Documentation for Alerting Email Action Could Use Updating #88333

mark54g opened this issue Jan 14, 2021 · 2 comments · Fixed by #90020
Assignees
Labels
bug Fixes for quality problems that affect the customer experience docs Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@mark54g
Copy link

mark54g commented Jan 14, 2021

Kibana version:
7.10.1

Elasticsearch version:

Server OS version:

Browser version:

Browser OS version:

Original install method (e.g. download page, yum, from source, etc.):

Describe the bug:
Every example listed here: https://www.elastic.co/guide/en/kibana/7.10/email-action-type.html#configuring-email mentions the secure option, and should reflect what the toggle to off would do better (in some cases, it's necessary to disable secure for the initial connection, and a secure connection will be established if the provider requires it).

For example when going to the nodemailer docs for that you get this important detail:

if true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false

This is especially true with o365 email, as it uses port 587, but should possibly or even probably not have secure enabled when using it with Kibana Alerts.

Also appears that the Outlook example may be dated in the docs, per:
https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-for-outlook-com-d088b986-291d-42b8-9564-9c414e2aa040

Steps to reproduce:
N/A - Documentation update request

@mark54g mark54g added the bug Fixes for quality problems that affect the customer experience label Jan 14, 2021
@pmuellr pmuellr added docs Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Jan 14, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@pmuellr pmuellr self-assigned this Jan 20, 2021
@pmuellr
Copy link
Member

pmuellr commented Feb 1, 2021

Looking at the email docs, I can see we added the examples in this PR, where some of the values came from watcher docs - #69601 (comment) . Those may be slightly out-of-date (eg, the outlook one seems to have changed).

The values that nodemailer uses, when you just pass a "service" name, are here: https://github.com/nodemailer/nodemailer/blob/master/lib/well-known/services.json - I think we may want to link to this file in the connector doc, somehow. I often refer people to it ...

pmuellr added a commit to pmuellr/kibana that referenced this issue Feb 2, 2021
resolves elastic#88333

Fixed:

- add note that `secure: false` will use TLS, but after an initial connection
  with TCP; we have been getting questions from customers who believed that
  `secure: false` implied TLS was not used at all.

- added a link to the nodemailer "well-known services" module, to allow
  customers to see examples of other email service configurations

- updated the Outlook config example to use the current nodemailer values

- couple of other small tweaks
pmuellr added a commit that referenced this issue Feb 8, 2021
resolves #88333

Fixed:

- add note that `secure: false` will use TLS, but after an initial connection
  with TCP; we have been getting questions from customers who believed that
  `secure: false` implied TLS was not used at all.

- added a link to the nodemailer "well-known services" module, to allow
  customers to see examples of other email service configurations

- updated the Outlook config example to use the current nodemailer values

- couple of other small tweaks
pmuellr added a commit to pmuellr/kibana that referenced this issue Feb 8, 2021
resolves elastic#88333

Fixed:

- add note that `secure: false` will use TLS, but after an initial connection
  with TCP; we have been getting questions from customers who believed that
  `secure: false` implied TLS was not used at all.

- added a link to the nodemailer "well-known services" module, to allow
  customers to see examples of other email service configurations

- updated the Outlook config example to use the current nodemailer values

- couple of other small tweaks
pmuellr added a commit that referenced this issue Feb 8, 2021
resolves #88333

Fixed:

- add note that `secure: false` will use TLS, but after an initial connection
  with TCP; we have been getting questions from customers who believed that
  `secure: false` implied TLS was not used at all.

- added a link to the nodemailer "well-known services" module, to allow
  customers to see examples of other email service configurations

- updated the Outlook config example to use the current nodemailer values

- couple of other small tweaks
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience docs Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants