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] Adds uiSettingsClient to alerting framework services #126648

Merged
merged 5 commits into from
Mar 2, 2022

Conversation

dplumlee
Copy link
Contributor

@dplumlee dplumlee commented Mar 1, 2022

Summary

Related to #64588 and brought up in this (much more recent) PR comment

Some of the plugins that use the alerting framework plugin (such as the security solution) require access to kibana's ui advanced settings on the backend. Previously this had been achieved by using the uiSettings config off the savedObjectsClient directly but as stated in the above comment, this is not a best practice approach as the location/format of the config is subject to change.

This PR adds the uiSettingsClient from the kibana core start service and passes it down through to the alerting framework services which then allows it to be consumed and utilized by dependent features such as the security solution rule executors.

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

@dplumlee dplumlee added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Team:Detections and Resp Security Detection Response Team Team:Detection Alerts Security Detection Alerts Area Team v8.2.0 labels Mar 1, 2022
@dplumlee dplumlee self-assigned this Mar 1, 2022
@dplumlee dplumlee marked this pull request as ready for review March 1, 2022 21:20
@dplumlee dplumlee requested a review from a team as a code owner March 1, 2022 21:20
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@dplumlee dplumlee force-pushed the uiSettingsClient-alerting-framework branch from 2dff7ae to 844b10b Compare March 1, 2022 22:05
@dplumlee dplumlee requested a review from a team as a code owner March 2, 2022 00:00
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
alerting 292 293 +1
Unknown metric groups

API count

id before after diff
alerting 300 301 +1

History

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

cc @dplumlee

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! Thanks for adding this!

@dplumlee dplumlee merged commit 08b8bb8 into elastic:main Mar 2, 2022
@dplumlee dplumlee added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 2, 2022
@kibanamachine
Copy link
Contributor

💔 Backport failed

The pull request could not be backported due to the following error:
There are no branches to backport to. Aborting.

How to fix

Re-run the backport manually:

node scripts/backport --pr 126648

Questions ?

Please refer to the Backport tool documentation

@dplumlee dplumlee deleted the uiSettingsClient-alerting-framework branch March 2, 2022 17:43
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 3, 2022
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 126648 or prevent reminders by adding the backport:skip label.

@marshallmain marshallmain removed auto-backport Deprecated - use backport:version if exact versions are needed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Mar 3, 2022
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 126648 or prevent reminders by adding the backport:skip label.

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 4, 2022
@dplumlee dplumlee added backport:skip This commit does not require backporting and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Mar 4, 2022
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 release_note:skip Skip the PR/issue when compiling release notes Team:Detection Alerts Security Detection Alerts Area Team Team:Detections and Resp Security Detection Response Team Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.2.0
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

6 participants