Add footer to all emails sent by Kibana email connector with a link to open Kibana or to the alert details page #84371

mikecote · 2020-11-25T20:23:06Z

Resolves #71243

In this PR, I'm making the following changes to allow alert emails to have a link back to the alert details page:

Email action type to always have a footer with a link back to Kibana
Email action type has a new parameter viewInKibanaPath which allows executors to pass a path within Kibana to use instead of the default root
Footer displays Click here to open Kibana. when the path is the default and Click here to view in Kibana. when a specific path is provided.
Alert transformActionParams function now injects viewInKibanaPath for email action types with a path to the alert details page

TODO:

Remove KIBANA_ROOT and use outcome of Add "network.publish_host" style configuration in Kibana #45815

Examples

Email sent by testing the connector

Email sent by an alert

Notes for testing

I've been using this app (https://nodemailer.com/app/) to test outbound emails.

Different scenarios

Not configuring server.publicBaseUrl and you will only see This message was sent by Kibana. footer when testing the connector.
Configuring server.publicBaseUrl to the URL you access Kibana from and you will see This message was sent by Kibana. Go to Kibana. footer when testing the connector and This message was sent by Kibana. View alert in Kibana. footer when an alert is sending an email.

Note for docs

Update documentation for email action params to mention the new property kibanaFooterLink with { path, text } as customization options.
A mention to the user they need to configure server.publicBaseUrl in order to get a link back to Kibana.

mikecote · 2020-11-25T20:32:36Z

@gchaps I'm working on adding a footer to all emails sent by our connectors. I'm thinking it would be good to link the user to which Kibana deployment sent the email and where possible have a deep link to a specific page.

I'm working on the messaging for each scenario, looking for some of your recommendations 🙏

When we have a link to a specific page:

This message was sent by a Kibana connector. Click here to view in Kibana.

When we don't have a link to a specific page but rather the Kibana URL:

This message was sent by a Kibana connector. Click here to open Kibana.

I'm using view when we have a link to a specific page (ex: from alerts) and open when we don't (ex: testing the connector). You can see examples w/ screenshots in the PR description.

gchaps · 2020-11-25T21:46:30Z

@mikecote We avoid using "click here" for accessibility reasons. So I'd remove that wording and use this text as the link:

View in Kibana
Open Kibana

For the first link, is it possible to be more specific: View alert in Kibana

mikecote · 2020-11-26T12:44:07Z

Thanks @gchaps! Absolutely, we can make the text more specific for alerts.

mikecote · 2020-11-26T18:10:21Z

@gchaps I've made the changes, let me know what you think. I've updated the screenshots in the "Examples" section of the PR description.

gchaps · 2020-11-30T16:03:20Z

@mikecote "Open Kibana" seems a little abrupt. Would this work "Open Kibana and view alert".

…l-footer-url

mikecote · 2020-11-30T19:42:34Z

@gchaps I've updated the examples in the PR description based on our offline discussion:

This message was sent by Kibana.
Go to Kibana

Let me know what you think

gchaps

text LGTM

…l-footer-url

elasticmachine · 2020-12-14T19:17:30Z

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

…l-footer-url

ymao1

LGTM! Tested sending emails for alerts with and without the publicBaseUrl specified.

pmuellr

LGTM; posted a few notes/questions, none blockers.

tested all the varieties locally, works great!

pmuellr · 2020-12-14T20:50:19Z

x-pack/plugins/actions/server/builtin_action_types/email.ts

@@ -30,6 +30,8 @@ export type EmailActionTypeExecutorOptions = ActionTypeExecutorOptions<
 // config definition
 export type ActionTypeConfigType = TypeOf<typeof ConfigSchema>;

+const EMAIL_FOOTER_DIVIDER = '\n\n--\n\n';


the way this ends up getting rendered is with an empty line, a line with --, and empty line. I'm wondering if the intent is to use markdown --- which renders a horizontal rule, instead of a line with --. Seems like this would look nicer. But also thinking two dashes by themselves is also some kind of default thing in email used before a "sig"? Anyhoo, example below of using the --- hr ...

This message was written by pmuellr.

@pmuellr yeah, I was looking at a common way to do email footers and it seemed the "empty line, --, empty line" was fairly common (mostly the --) by GitHub and a lot personal email signatures. I'm good changing it to whatever is preferred.

I think the hr-flavored one looks a little more "modern", but it doesn't matter that much to me.

pmuellr · 2020-12-14T21:10:48Z

x-pack/plugins/actions/server/builtin_action_types/email.ts

@@ -101,6 +103,14 @@ const ParamsSchema = schema.object(
    bcc: schema.arrayOf(schema.string(), { defaultValue: [] }),
    subject: schema.string(),
    message: schema.string(),
+    kibanaFooterLink: schema.object({


this is slightly weird - action params that aren't really intended to be updated by the user.

I'm guessing this was the easiest way to get the value passed in, without making more widespread changes, like adding some additional "bag" of variables/strings all over the place.

Seems fine for now, maybe we'll figure out a cleaner way to do this later. I think it's probably worth a comment above kibanaFooterLink though, indicating we don't intend customers to be setting this value explicitly.

@pmuellr ++ I'll add a comment. I agree these values won't be set by end users. Though I can still see them as parameters set programatically elsewhere like "share to" where it's done browser side and want to put a link to the visualization.

I was thinking of waiting and seeing further patterns to know what is better than params for this. Right now it's almost like hidden-from-user-while-still-being-params.

Ya, I suspect there will be other patterns to deal with, and agree we can live with the design used in this PR till we need more. Some things already considered:

sending the results of a previous action into a subsequent action

allowing customer-specified messaging "prefixes" (legal statements, etc - this kind of thing always seems to come up)

At one point I was thinking that "message" parameters should maybe be considered a list of messages, independently settable, that we'd serialize into a single message. Something like Slack's BlockKit blocks.

pmuellr · 2020-12-14T21:19:23Z

...est/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/email.ts

-              text: 'email-message',
+              html: `<p>email-message</p>\n<p>--</p>\n<p>This message was sent by Kibana. <a href=\"https://localhost:5601\">Go to Kibana</a>.</p>\n`,
+              text:
+                'email-message\n\n--\n\nThis message was sent by Kibana. [Go to Kibana](https://localhost:5601).',


I'm guessing we can't build a FT that provides a link into the alerting app, since we have no way of validating what the emails that get sent actually contain, since we don't have an email emulator, yet. Good to see the link to Kibana though!

Or could/should we cheat, by passing in an explicit kibanaFooterLink param, in a new test?

Yeah since there's no emulator yet I went ahead and tested the params portion instead (commit: 99b5cad).

YulNaumenko

LGTM. Tested and it works as expected

mikecote · 2020-12-15T16:01:36Z

@elasticmachine merge upstream

mikecote · 2020-12-15T16:33:25Z

@elasticmachine merge upstream

mikecote · 2020-12-15T16:37:12Z

@elasticmachine merge upstream

kibanamachine · 2020-12-15T18:50:17Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 0dbc6e1

Metrics [docs]

Distributable file count

id	before	after	diff
`default`	47241	48002	+761

History

💔 Build #94541 failed 4078870
💔 Build #94528 failed 0ef3031
💔 Build #94446 failed 098ad91
💔 Build #94436 failed 99b5cad
💚 Build #94161 succeeded f076a2f

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…o open Kibana or to the alert details page (elastic#84371) * Initial work * Change messaging from copy * Fix jest tests for email connector * Fix jest tests for alerts plugin * Update copy * Use server.publicBaseUrl * Fix jest tests * Update tests * Cleanup jest test * Code cleanup * Improve email parameter names for kibana footer url * Cleanup * Add test for kibana footer link * Fix type check * Fix jest test Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

pmuellr · 2020-12-16T00:23:19Z

so nice to see this merged! \o/

…o open Kibana or to the alert details page (#84371) (#86003) * Initial work * Change messaging from copy * Fix jest tests for email connector * Fix jest tests for alerts plugin * Update copy * Use server.publicBaseUrl * Fix jest tests * Update tests * Cleanup jest test * Code cleanup * Improve email parameter names for kibana footer url * Cleanup * Add test for kibana footer link * Fix type check * Fix jest test Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Initial work

191ecbc

mikecote added release_note:enhancement Feature:Alerting v8.0.0 Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.11.0 labels Nov 25, 2020

mikecote self-assigned this Nov 25, 2020

mikecote added 3 commits November 26, 2020 13:11

Change messaging from copy

ef22bf7

Fix jest tests for email connector

b1de0f1

Fix jest tests for alerts plugin

6d284e1

Merge branch 'master' of github.com:elastic/kibana into alerting/emai…

94ffce3

…l-footer-url

Update copy

f001906

gchaps approved these changes Nov 30, 2020

View reviewed changes

mikecote added 4 commits December 7, 2020 08:38

Merge branch 'master' of github.com:elastic/kibana into alerting/emai…

ee7f216

…l-footer-url

Merge branch 'master' of github.com:elastic/kibana into alerting/emai…

7471e04

…l-footer-url

Use server.publicBaseUrl

2f5519d

Fix jest tests

1867bba

mikecote added the needs_docs label Dec 9, 2020

mikecote added 5 commits December 9, 2020 13:41

Update tests

6ae221a

Cleanup jest test

6c71106

Code cleanup

d2aac98

Merge branch 'master' of github.com:elastic/kibana into alerting/emai…

f73718f

…l-footer-url

Improve email parameter names for kibana footer url

0e33787

mikecote marked this pull request as ready for review December 14, 2020 19:17

mikecote requested a review from a team as a code owner December 14, 2020 19:17

mikecote added 2 commits December 14, 2020 14:30

Cleanup

800e3b5

Merge branch 'master' of github.com:elastic/kibana into alerting/emai…

f076a2f

…l-footer-url

ymao1 approved these changes Dec 14, 2020

View reviewed changes

pmuellr approved these changes Dec 14, 2020

View reviewed changes

YulNaumenko approved these changes Dec 14, 2020

View reviewed changes

mikecote added 4 commits December 15, 2020 08:00

Update with master + PR feedback

e9d237f

Add test for kibana footer link

99b5cad

Fix type check

098ad91

Fix jest test

0ef3031

Merge branch 'master' into alerting/email-footer-url

4078870

mikecote mentioned this pull request Dec 15, 2020

Failing test: API Integration Tests.test/api_integration/apis/saved_objects/find·js - apis saved_objects find without kibana index page beyond total should return 200 with empty response #85911

Closed

Merge branch 'master' into alerting/email-footer-url

2b01fdc

Merge branch 'master' into alerting/email-footer-url

0dbc6e1

mikecote merged commit ccfb4b6 into elastic:master Dec 15, 2020

mikecote mentioned this pull request Dec 15, 2020

[7.x] Add footer to all emails sent by Kibana email connector with a link to open Kibana or to the alert details page (#84371) #86003

Merged

mikecote mentioned this pull request Feb 23, 2021

Catch-up release documentation #92411

Merged

mikecote removed the needs_docs label Feb 24, 2021

lucabelluccini mentioned this pull request Jun 29, 2022

Kibana Alert emails should have a customizable footer #135402

Closed

pmuellr mentioned this pull request Apr 13, 2023

[ResponseOps] provide config to turn off email action footer #154919

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add footer to all emails sent by Kibana email connector with a link to open Kibana or to the alert details page #84371

Add footer to all emails sent by Kibana email connector with a link to open Kibana or to the alert details page #84371

mikecote commented Nov 25, 2020 •

edited

Loading

mikecote commented Nov 25, 2020

gchaps commented Nov 25, 2020

mikecote commented Nov 26, 2020

mikecote commented Nov 26, 2020

gchaps commented Nov 30, 2020

mikecote commented Nov 30, 2020

gchaps left a comment

elasticmachine commented Dec 14, 2020

ymao1 left a comment

pmuellr left a comment

pmuellr Dec 14, 2020

mikecote Dec 15, 2020

pmuellr Dec 15, 2020

pmuellr Dec 14, 2020

mikecote Dec 15, 2020

pmuellr Dec 15, 2020

pmuellr Dec 14, 2020

mikecote Dec 15, 2020

YulNaumenko left a comment

mikecote commented Dec 15, 2020

mikecote commented Dec 15, 2020

mikecote commented Dec 15, 2020

kibanamachine commented Dec 15, 2020

pmuellr commented Dec 16, 2020

Add footer to all emails sent by Kibana email connector with a link to open Kibana or to the alert details page #84371

Add footer to all emails sent by Kibana email connector with a link to open Kibana or to the alert details page #84371

Conversation

mikecote commented Nov 25, 2020 • edited Loading

Examples

Notes for testing

Note for docs

mikecote commented Nov 25, 2020

gchaps commented Nov 25, 2020

mikecote commented Nov 26, 2020

mikecote commented Nov 26, 2020

gchaps commented Nov 30, 2020

mikecote commented Nov 30, 2020

gchaps left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 14, 2020

ymao1 left a comment

Choose a reason for hiding this comment

pmuellr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YulNaumenko left a comment

Choose a reason for hiding this comment

mikecote commented Dec 15, 2020

mikecote commented Dec 15, 2020

mikecote commented Dec 15, 2020

kibanamachine commented Dec 15, 2020

💚 Build Succeeded

Metrics [docs]

Distributable file count

History

pmuellr commented Dec 16, 2020

mikecote commented Nov 25, 2020 •

edited

Loading