[Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing by gmmorris · Pull Request #77040 · elastic/kibana

gmmorris · 2020-09-09T12:17:13Z

Summary

The Alerts Authorisation now manually builds the authorization filter instead of parsing a KQL string in order to get around the performance issue we recently identified in KQL. #76811

Initial testing showed a marked improvement, where the average duration of the find api in our integration test improved from an average of 386.14359232038ms (median of 199.40039098263ms) to an average of 108.44588107765ms (median of 89.378548502922ms).

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2020-09-09T16:15:54Z

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

x-pack/plugins/alerts/server/authorization/alerts_authorization_kuery.ts

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

* master: (41 commits) [bugfix] Replace panel flyout opens 2 flyouts (elastic#76931) clean up test (elastic#76887) [Enterprise Search] Update shared API request handler (elastic#77112) [Maps] convert ESAggSource to TS (elastic#76999) Add plugin status API - take 2 (elastic#76732) Adds lens as a readable saved object for read-only dashboard users (elastic#77067) Skip checking for the reserved realm (elastic#76687) Reporting/diagnostics (elastic#74314) Reporting/Test: unskip non-screenshot tests (elastic#77088) Move metrics to setup and add cgroup metrics (elastic#76730) [Enterprise Search] Add Overview landing page/plugin (elastic#76734) First pass. Change TS type. Update OpenAPI (elastic#76434) [CI] Balance xpack ci groups a bit (elastic#77068) [Security_solution][Detections] Refactor signal ancestry to allow multiple parents (elastic#76531) [Maps] convert MetricsEditor to TS (elastic#76727) IndexMigrator: fix non blocking migration wrapper promise rejection (elastic#77018) [Enterprise Search] Update config data endpoint to v2 (elastic#76970) [ML] Add decision path charts to exploration results table (elastic#73561) Bump eventemitter3 from 4.0.0 to 4.0.7 (elastic#77016) [Ingest Pipelines] Add descriptions for ingest processors K-S (elastic#76981) ...

kobelb

The way we're building the KueryNode looks 👍 to me! I didn't thoroughly review the rest of the PR, so we'll want to get another approval from the Alerting team also.

mikecote

Changes LGTM! Great to see an improvement in efficiency!

gmmorris · 2020-09-14T08:31:52Z

@elasticmachine merge upstream

YulNaumenko

LGTM

* master: (65 commits) [Security Solution][Resolver] Analyzed event styling (elastic#77115) filter invalid SOs from the searc hresults in Task Manager (elastic#76891) [RUM Dashboard] Visitors by region map (elastic#77135) [Security Solution][Endpoint][Admin] Task/endpoint list actions (elastic#76555) [Ingest pipelines] Forms for processors T-U (elastic#76710) updating datatable type (elastic#77320) [ML] Fix custom URLs processing for security app (elastic#76957) [telemetry] add schema guideline + schema_check new check for --path config (elastic#75747) [ML] Transforms: API schemas and integration tests (elastic#75164) [Mappings editor] Add support for wildcard field type (elastic#76574) [Ingest Manager] Fix flyout instruction selection (elastic#77071) [Telemetry Tools] update lodash to 4.17 (elastic#77317) [APM] Service inventory redesign (elastic#76744) Hide management sections based on cluster/index privileges (elastic#67791) [Snapshot Restore] Disable steps when form is invalid (elastic#76540) [Mappings editor] Add support for positive_score_impact to rank_feature (elastic#76824) Update apm.ts (elastic#77310) [OBS] Remove beta badge, change news feed size and add external icon to news feed link (elastic#77164) [Discover] Convert legacy sort to be compatible with multi sort (elastic#76986) [APM] API Snapshot Testing (elastic#77229) ...

… into alerts/improve-find-pref * 'alerts/improve-find-pref' of github.com:gmmorris/kibana:

kibanamachine · 2020-09-14T19:23:19Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 1e3fe6c

Build metrics

distributable file count

id	value	diff	baseline
default	45541	+2	45539

History

💚 Build #74037 succeeded efe2ee5
💚 Build #73626 succeeded 9d86fcd
💔 Build #73600 failed cb1fc7a
💚 Build #73352 succeeded eb1ae15

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

…Client.find by skipping KQL parsing (elastic#77040) The Alerts Authorisation now manually builds the authorization filter instead of parsing a KQL string in order to get around the performance issue we recently identified in KQL.

* master: (25 commits) [Security Solution] Add unit tests for Network search strategy (elastic#77416) [Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing (elastic#77040) [Ingest Manager] Add route for package installation by upload (elastic#77044) [APM-UI][E2E] filter PRs from the uptime GH team (elastic#77359) [APM] Remove useLocation and some minor route improvements (elastic#76343) [Enterprise Search] Update enterpriseSearchRequestHandler to manage range of errors + add handleAPIErrors helper (elastic#77258) [SECURITY_SOLUTION] Task/hostname policy response ux updates (elastic#76444) Move remaining uses of serviceName away from urlParams (elastic#77248) [Lens] Move configuration popover to flyout (elastic#76046) [Ingest Manager] Manually build Fleet kuery with Node arguments (elastic#76589) skip flaky suite (elastic#59975) Neutral-naming in reporting plugin (elastic#77371) [Enterprise Search] Add UserIcon styles (elastic#77385) [RUM Dashboard] Added loading state to visitor breakdown pie charts (elastic#77201) [Ingest Manager] Fix polling for new agent action (elastic#77339) Remote cluster - Functional UI test to change the superuser to a test_user with limited role (elastic#77212) Stacked headers and navigational search (elastic#72331) [ML] DF Analytics creation wizard: Fixing field loading race condition (elastic#77326) [Monitoring] Handle no mappings found for sort and collapse fields (elastic#77099) Add Lens to Recently Accessed (elastic#77249) ...

* master: (293 commits) Fix tsvb filter ration for table (elastic#77272) [Security Solution] Add unit tests for Network search strategy (elastic#77416) [Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing (elastic#77040) [Ingest Manager] Add route for package installation by upload (elastic#77044) [APM-UI][E2E] filter PRs from the uptime GH team (elastic#77359) [APM] Remove useLocation and some minor route improvements (elastic#76343) [Enterprise Search] Update enterpriseSearchRequestHandler to manage range of errors + add handleAPIErrors helper (elastic#77258) [SECURITY_SOLUTION] Task/hostname policy response ux updates (elastic#76444) Move remaining uses of serviceName away from urlParams (elastic#77248) [Lens] Move configuration popover to flyout (elastic#76046) [Ingest Manager] Manually build Fleet kuery with Node arguments (elastic#76589) skip flaky suite (elastic#59975) Neutral-naming in reporting plugin (elastic#77371) [Enterprise Search] Add UserIcon styles (elastic#77385) [RUM Dashboard] Added loading state to visitor breakdown pie charts (elastic#77201) [Ingest Manager] Fix polling for new agent action (elastic#77339) Remote cluster - Functional UI test to change the superuser to a test_user with limited role (elastic#77212) Stacked headers and navigational search (elastic#72331) [ML] DF Analytics creation wizard: Fixing field loading race condition (elastic#77326) [Monitoring] Handle no mappings found for sort and collapse fields (elastic#77099) ...

…Client.find by skipping KQL parsing (#77040) (#77439) The Alerts Authorisation now manually builds the authorization filter instead of parsing a KQL string in order to get around the performance issue we recently identified in KQL.

gmmorris added 2 commits September 9, 2020 11:36

extracted asFiltersByAlertTypeAndConsumer to own file

53a2c38

use kuery nodes instead of kuery query

eb1ae15

gmmorris added Feature:Alerting Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v7.10.0 v8.0.0 labels Sep 9, 2020

gmmorris changed the title ~~[Alerting] Improves pref of the authorization filter in AlertsClient.find by skipping KQL parsing~~ [Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing Sep 9, 2020

gmmorris added the release_note:enhancement label Sep 9, 2020

gmmorris marked this pull request as ready for review September 9, 2020 16:15

gmmorris requested a review from a team as a code owner September 9, 2020 16:15

kobelb requested changes Sep 9, 2020

View reviewed changes

x-pack/plugins/alerts/server/authorization/alerts_authorization_kuery.ts Outdated Show resolved Hide resolved

gmmorris and others added 2 commits September 10, 2020 08:24

optimized the is node

cb1fc7a

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

kobelb approved these changes Sep 10, 2020

View reviewed changes

mikecote self-requested a review September 10, 2020 15:21

mikecote approved these changes Sep 10, 2020

View reviewed changes

Merge branch 'master' into alerts/improve-find-pref

efe2ee5

YulNaumenko approved these changes Sep 14, 2020

View reviewed changes

gmmorris added 2 commits September 14, 2020 18:30

Merge branch 'alerts/improve-find-pref' of github.com:gmmorris/kibana…

1e3fe6c

… into alerts/improve-find-pref * 'alerts/improve-find-pref' of github.com:gmmorris/kibana:

gmmorris merged commit 223a187 into elastic:master Sep 15, 2020

gmmorris mentioned this pull request Sep 15, 2020

[7.x] [Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing (#77040) #77439

Merged

dhurley14 mentioned this pull request Sep 21, 2020

[Security Solution][Detections] Performance enhancement for readRules function #76398

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing#77040

[Alerting] Improves performance of the authorization filter in AlertsClient.find by skipping KQL parsing#77040
gmmorris merged 7 commits intoelastic:masterfrom
gmmorris:alerts/improve-find-pref

gmmorris commented Sep 9, 2020 •

edited

Loading

Uh oh!

elasticmachine commented Sep 9, 2020

Uh oh!

Uh oh!

kobelb left a comment

Uh oh!

mikecote left a comment •

edited

Loading

Uh oh!

gmmorris commented Sep 14, 2020

Uh oh!

YulNaumenko left a comment

Uh oh!

kibanamachine commented Sep 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

gmmorris commented Sep 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

elasticmachine commented Sep 9, 2020

Uh oh!

Uh oh!

kobelb left a comment

Choose a reason for hiding this comment

Uh oh!

mikecote left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmmorris commented Sep 14, 2020

Uh oh!

YulNaumenko left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Sep 14, 2020

💚 Build Succeeded

Build metrics

distributable file count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gmmorris commented Sep 9, 2020 •

edited

Loading

mikecote left a comment •

edited

Loading