[Search] Search batching using bfetch (again) #84043

lizozom · 2020-11-23T09:08:33Z

Summary

This PR introduces search request batching using bfetch.
It is especially beneficial to applications that send multiple requests in a session, like dashboard.
It should address customer complaints on loading taking long and using a lot of network due to making multiple connections.

Without bfetch

With bfetch, the dashboard is re-loaded using a single request.

Edge cases and things to pay attention to

Requests can be sent in more than one batch. Batches are limited by size and by time. In some cases, multiple batches might be sent

Query cancellation

Query cancellation still works!

In OSS we rely on a hangup like before. Since bfetch was adjusted not to wait for aborted requests, it will close the connection as all other requests in the batch are completed.

In xpack, the same logic applies, but we also send the cancellation request

Errors

Regular errors are returned as part of the response stream and are passed back to the issuing request.
If a bfetch stream is hung up for some reason, all requests are rejected properly.

Release Notes

This PR introduces search request batching using bfetch.
It should address performance issues due to opening multiple connections for search, especially in applications like dashboard.

Users who wish to opt-out and fallback to legacy behavior for any reason, can toggle the Use legacy search option in Advanced Settings.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

…fetch-in-search

This reverts commit 17de9fa.

…fetch-in-search

lizozom · 2020-11-23T14:50:27Z

Blocked by #84036

…fetch-in-search # Conflicts: # x-pack/plugins/security_solution/cypress/support/commands.js

…fetch-in-search

…ana into enhance/use-bfetch-in-search

…fetch-in-search

kibanamachine · 2020-11-25T14:07:51Z

💚 Build Succeeded

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

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`bfetch`	20	21	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`bfetch`	18.6KB	20.0KB	+1.4KB
`data`	973.5KB	973.1KB	-417.0B
`dataEnhanced`	35.2KB	35.2KB	+28.0B
total			+1.0KB

History

💔 Build #90173 failed 77148ca
💔 Build #90127 failed 6e8cc8d
💔 Build #90113 failed 55629da
💚 Build #89527 succeeded b5a0a44

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

Re-merging after cypress fixes

* master: (70 commits) [Uptime] Fix headers io-ts type (elastic#84089) [fleet] Add config options to accepted docker env vars (elastic#84338) [Fleet] Support URL query state in agent logs UI (elastic#84298) [basePathProxy] include query in redirect (elastic#84356) [Security Solution] Add Endpoint policy feature checks (elastic#83972) Fix issues with show_license_expiration (elastic#84361) [Security Solution][Resolver] Add support for predefined schemas for endpoint and winlogbeat (elastic#84103) [cli/dev] log a warning when --no-base-path is used with --dev (elastic#84354) [Fleet] Support input-level vars & templates (elastic#83878) [APM] Elastic chart issues (elastic#84238) [Time to Visualize] Fix Unlink Action via Rollback of ReplacePanel (elastic#83873) redirect to visualize listing page when by value visualization editor doesn't have a value input (elastic#84287) add live region for field search (elastic#84310) [ML] Persisted URL state for Anomalies table (elastic#84314) [dev/cli] detect worker type using env, not cluster module (elastic#83977) [Workplace Search] Migrate DisplaySettings tree (elastic#84283) Deprecate `xpack.task_manager.index` setting (elastic#84155) [Search] Search batching using bfetch (again) (elastic#84043) Use .kibana instead of .kibana_current to mark migration completion (elastic#83373) [Monitoring] Only look at ES for the missing data alert for now (elastic#83839) ...

* master: (119 commits) [Uptime] Fix headers io-ts type (elastic#84089) [fleet] Add config options to accepted docker env vars (elastic#84338) [Fleet] Support URL query state in agent logs UI (elastic#84298) [basePathProxy] include query in redirect (elastic#84356) [Security Solution] Add Endpoint policy feature checks (elastic#83972) Fix issues with show_license_expiration (elastic#84361) [Security Solution][Resolver] Add support for predefined schemas for endpoint and winlogbeat (elastic#84103) [cli/dev] log a warning when --no-base-path is used with --dev (elastic#84354) [Fleet] Support input-level vars & templates (elastic#83878) [APM] Elastic chart issues (elastic#84238) [Time to Visualize] Fix Unlink Action via Rollback of ReplacePanel (elastic#83873) redirect to visualize listing page when by value visualization editor doesn't have a value input (elastic#84287) add live region for field search (elastic#84310) [ML] Persisted URL state for Anomalies table (elastic#84314) [dev/cli] detect worker type using env, not cluster module (elastic#83977) [Workplace Search] Migrate DisplaySettings tree (elastic#84283) Deprecate `xpack.task_manager.index` setting (elastic#84155) [Search] Search batching using bfetch (again) (elastic#84043) Use .kibana instead of .kibana_current to mark migration completion (elastic#83373) [Monitoring] Only look at ES for the missing data alert for now (elastic#83839) ...

Liza K added 30 commits November 10, 2020 14:45

Use bfetch for search (no abort behavior)

20bb351

fix merge

8b4eb1c

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

9eebded

…fetch-in-search

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

812a06b

…fetch-in-search

Handle request abortion + unit tests

aaa3122

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

b1a2cf2

…fetch-in-search

fix jest

2cdfc47

shim totals in oss

e8fc98f

proper formatting for errors

993e385

jest, types and docs

e89a46f

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

b727e49

…fetch-in-search

Fix doc

3de838c

Remove old search code and rename UI Setting

17de9fa

jest mocks

56e7a46

jest

5aaeefa

Solve unhanled error

c393416

Use AbortSignal

a1b2979

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

811da0a

…fetch-in-search

ts

162473d

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

8c83657

…fetch-in-search

code review - use abort controller instead of observable

662b810

Revert "Remove old search code and rename UI Setting"

41f6406

This reverts commit 17de9fa.

Remove old search code and rename UI Setting

cbd8106

revert search route

1ec890a

fix event unsubscribe

3e334a7

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

c7aebdf

…fetch-in-search

code review 2

8abff48

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

b4193e2

…fetch-in-search

revert filter

9d16439

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

4a1e69c

…fetch-in-search

lizozom changed the title ~~Enhance/use bfetch in search~~ [Search] Search batching using bfetch Nov 23, 2020

lizozom added release_note:enhancement v7.11.0 v8.0.0 labels Nov 23, 2020

Liza K added 2 commits November 23, 2020 11:17

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

be828c2

…fetch-in-search

Handle JSON parse error in bfetch + test

b5a0a44

lizozom mentioned this pull request Nov 23, 2020

[Search] Search batching using bfetch #83418

Merged

8 tasks

lizozom changed the title ~~[Search] Search batching using bfetch~~ [Search] Search batching using bfetch (again) Nov 23, 2020

Adjust Security Solution Cypress tests to bsearch

4413f8a

lizozom requested review from a team as code owners November 24, 2020 22:15

patrykkopycinski and others added 6 commits November 24, 2020 23:34

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

55629da

…fetch-in-search # Conflicts: # x-pack/plugins/security_solution/cypress/support/commands.js

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

42ec042

…fetch-in-search

Merge branch 'enhance/use-bfetch-in-search' of github.com:lizozom/kib…

6e8cc8d

…ana into enhance/use-bfetch-in-search

Merge branch 'master' of github.com:elastic/kibana into enhance/use-b…

9cc2922

…fetch-in-search

shimmy

77148ca

fix cypress

1c925de

patrykkopycinski approved these changes Nov 25, 2020

View reviewed changes

lizozom merged commit b3430e3 into elastic:master Nov 25, 2020

lizozom added a commit to lizozom/kibana that referenced this pull request Nov 25, 2020

[Search] Search batching using bfetch (again) (elastic#84043)

8866112

Re-merging after cypress fixes

lizozom mentioned this pull request Nov 25, 2020

[7.x] [Search] Search batching using bfetch (again) (#84043) #84334

Merged

lizozom added a commit that referenced this pull request Nov 25, 2020

[Search] Search batching using bfetch (again) (#84043) (#84334)

f30e0e2

Re-merging after cypress fixes

patrykkopycinski mentioned this pull request Nov 26, 2020

[Security Solution] Fix Security Solution Cypress to properly stub bs… #84036

Closed

8 tasks

lizozom mentioned this pull request Apr 22, 2021

[bfetch] compress stream chunks #97994

Merged

9 tasks

lukasolson mentioned this pull request Jul 29, 2021

[Search service] Integrate batched fetch (bfetch) #54207

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search] Search batching using bfetch (again) #84043

[Search] Search batching using bfetch (again) #84043

lizozom commented Nov 23, 2020

lizozom commented Nov 23, 2020

kibanamachine commented Nov 25, 2020

[Search] Search batching using bfetch (again) #84043

[Search] Search batching using bfetch (again) #84043

Conversation

lizozom commented Nov 23, 2020

Summary

Edge cases and things to pay attention to

Query cancellation

Errors

Release Notes

Checklist

For maintainers

lizozom commented Nov 23, 2020

kibanamachine commented Nov 25, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Page load bundle

History