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

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

Merged
merged 1 commit into from
Apr 17, 2023

Conversation

pmuellr
Copy link
Member

@pmuellr pmuellr commented Apr 13, 2023

resolves #135402

Release note

Adds a new Kibana configuration setting xpack.actions.enableFooterInEmail to allow the footer added to emails sent from Kibana alerting rules to NOT be added. The footer is still added by default, or if the setting value true is used.
When set to false, the footer will not be added to the email.

Summary

Footers were added to emails sent as alerting actions in #84371. In this PR, we provide a config option to turn it off - xpack.actions.enableFooterInEmail - default true.

This should be cloud-enabled by making the appropriate changes in that repo.

Drive-by fix: I noticed in the original PR, I had made a comment about using --- before the footer instead of -- - it renders better. Decided to make that fix here as well. Comparison:

before:

image

after:

image

Checklist

Delete any items that are not applicable to this PR.

@pmuellr pmuellr force-pushed the alerting/email-footer branch from 2e9612e to eb8d22c Compare April 13, 2023 18:51
@pmuellr pmuellr added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.8.0 labels Apr 17, 2023
@pmuellr pmuellr force-pushed the alerting/email-footer branch from c14caf5 to c1a10fd Compare April 17, 2023 12:18
@pmuellr pmuellr marked this pull request as ready for review April 17, 2023 12:19
@pmuellr pmuellr requested a review from a team as a code owner April 17, 2023 12:19
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
securitySolution 432 435 +3

Total ESLint disabled count

id before after diff
securitySolution 512 515 +3

History

  • 💚 Build #120126 succeeded c14caf599d822887b7a3041e683aaa6baaaf948c
  • 💚 Build #119987 succeeded 9b2673aad2d53e001159cdb9ca714fab1927a0b4
  • 💔 Build #119934 failed 0af1f02b5c6a0200687098a7802754d68042d5c5
  • 💔 Build #119899 failed 2e9612e487b21d107644004850368c7c97690cb0
  • 💔 Build #119851 failed 6a8ae8178ac62d597414ced57aee7620d4d48a33
  • 💔 Build #119821 failed acc06417577b6dc71d547fdd7c85d10c3d9f6693

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

Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

LGTM! One comment about docker allowlist

@@ -130,6 +130,9 @@ A list of allowed email domains which can be used with the email connector. When

WARNING: This feature is available in {kib} 7.17.4 and 8.3.0 onwards but is not supported in {kib} 8.0, 8.1 or 8.2. As such, this setting should be removed before upgrading from 7.17 to 8.0, 8.1 or 8.2. It is possible to configure the settings in 7.17.4 and then upgrade to 8.3.0 directly.

`xpack.actions.enableFooterInEmail` {ess-icon}::
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also add this to the docker allowlist?

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

The docker allowlist is here src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker :)

Copy link
Member Author

Choose a reason for hiding this comment

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

ah crap - I thought it was all the in cloud repo 🤦🏻!

Just merged this and saw this comment, so will open another PR to add it there ... thx!

Copy link
Member Author

Choose a reason for hiding this comment

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

merged that fix here: #155076

@pmuellr pmuellr merged commit bcfe4b0 into elastic:main Apr 17, 2023
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Apr 17, 2023
pmuellr added a commit that referenced this pull request Apr 17, 2023
)

## Summary

In PR #154919, we forgot to
add the config to the docker allow-list in the appropriate file.

We add it in this PR.
@pmuellr pmuellr added release_note:enhancement and removed release_note:skip Skip the PR/issue when compiling release notes labels Apr 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Actions Feature:Alerting release_note:enhancement Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Kibana Alert emails should have a customizable footer
5 participants