[Search] Server strategy example #71679

lizozom · 2020-07-14T15:55:48Z

Summary

This example shows how to use the data services, focusing on the data.search.search API.

It illustrates:

Selecting an IndexPattern and a Field.
Getting the configurations from TopNavMenu.
Building an aggregation using AggConfigs
Using the search API to execute an Elasticsearch search:
- Using the default server side es strategy. Data will be fetched synchronously or asynchronously depending on licensing.
- Using a custom myStrategy that takes a custom request and returns a custom response.
- Running a search on the server using the server side service in a synchronous manner.
- TODO: Add a server side utility for async search.

To run, start Kibana with yarn start --run-examples and find the plugin on the Developer Examples page

This PR also renames the names is_partial and is_running we get from ES to isPartial and isRunning (compatible with naming standards in Kibana.

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
This was checked for keyboard-only and screenreader accessibility
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

elasticmachine · 2020-07-15T12:05:11Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

mdefazio

All this css looks good! ;)

lukasolson

Added a few minor comments below, overall this is looking good. I'm wondering if we may want to show a little more realistic example (rather than a strategy that just returns an extra parameter).

lukasolson · 2020-07-15T16:17:34Z

examples/search_examples/common/index.ts

+export const PLUGIN_ID = 'searchExamples';
+export const PLUGIN_NAME = 'search_examples';
+
+export interface IMyStrategyResponse extends IEsSearchResponse {


Just some thoughts: I wonder if it will be more common for custom strategies to extend IKibanaSearchResponse rather than IEsSearchResponse since they will likely be doing some sort of data manipulation and not sending the raw response back.

examples/search_examples/public/components/app.tsx

examples/search_examples/server/my_strategy.ts

lukasolson · 2020-07-15T18:21:49Z

src/plugins/data/common/search/es_search/types.ts

+  /**
+   * Indicates whether async search is still in flight
+   */
+  isRunning?: boolean;


It probably makes sense to either move these directly to IKibanaSearchResponse, or move id inside here. Maybe we can have a conversation about what should be in IKibanaSearchResponse (or if it's necessary).

examples/search_examples/public/components/app.tsx

examples/search_examples/kibana.json

Renamed is_partial to isPartial Added isPartial and isRunning to OSS response type

Co-authored-by: Lukas Olson <[email protected]>

…-strategy-example

lukasolson

Added a couple of minor things below... I think this example illustrates that our types need a little work. I have a simple idea I can run by you tomorrow about improving it.

lukasolson · 2020-08-04T16:59:45Z

examples/search_examples/public/components/app.tsx

+    const aggs = [{ type: 'avg', params: { field: selectedField.name } }];
+    const aggsDsl = data.search.aggs.createAggConfigs(indexPattern, aggs).toDsl();


I think it's good that we're using the agg configs service here, but it doesn't answer the question, "Why would I want to use the data.search.aggs service instead of just writing the DSL myself?" Maybe just adding a comment would be sufficient.

examples/search_examples/public/application.tsx

examples/search_examples/public/components/app.tsx

Co-authored-by: Lukas Olson <[email protected]>

lizozom · 2020-08-06T13:56:34Z

@elasticmachine merge upstream

lizozom · 2020-08-06T14:26:19Z

@elasticmachine merge upstream

…-strategy-example

…ibana into search/server-strategy-example

lizozom · 2020-08-11T10:18:20Z

@elasticmachine merge upstream

kibanamachine · 2020-08-11T12:09:52Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: dff19c8

Build metrics

page load bundle size

id	value	diff	baseline
data	1.4MB	+1.7KB	1.4MB
dataEnhanced	178.0KB	+111.0B	177.9KB
total		+1.8KB

History

💚 Build #67191 succeeded 9aebaae
💔 Build #66923 failed 741d8b3
💔 Build #66911 failed 5459bca
💚 Build #66579 succeeded b54f734
💔 Build #66578 failed 828ab62

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

lukasolson

LGTM

* Server strategy example * Add tsconfig Renamed is_partial to isPartial Added isPartial and isRunning to OSS response type * Docs + remove unused sample code * Fix test naming of arguments * ts * ts fix * Add filters and query input selector * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * Use new service * exapmle plugin ts * unsubscribe + use timefilter * typo * docs * Add comments and use agg config * Added agg configs Added field selector Added a custom input param * Adding getEsQuery to query service (??) * Add server side example * docs * caps * list plugin in examples page * fix typo * Update examples/search_examples/public/application.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/application.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * eslint Co-authored-by: Lukas Olson <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

…nes/processor-forms-a-d * 'master' of github.com:elastic/kibana: (25 commits) [ML] Removing full lodash library imports (elastic#74742) [Search] Server strategy example (elastic#71679) [Reporting] Fix and test for Listing of Reports (elastic#74453) [maps] fix drawing shapes (elastic#74689) [Resolver] Improve simulator. Add more click-through tests and panel tests. (elastic#74601) Deprecate schema-less specs in Vega (elastic#73805) [Security Solution] Rename Administration > Hosts subtab to Endpoints (elastic#74287) Timelion deprecation doc (elastic#74508) [Functional Tests] Adds a wait time between setting the index pattern and the time field on TSVB (elastic#74736) [Lens] Add styling options for x and y axes on the settings popover (elastic#71829) [Maps] add initial location option that fits to data bounds (elastic#74583) theme function (elastic#73451) [data.ui.query] Write filters to query log from default editor. (elastic#74474) [data.search.SearchSource] Move some SearchSource dependencies to the server. (elastic#74607) [Canvas][tech-debt] Convert renderers (elastic#74134) [security solutions][lists] Adds end to end tests (elastic#74473) pluralized for occurrences vs occurrence (elastic#74564) Update links that pointed to CONTRIBUTING.md (elastic#74757) [Ingest pipelines] Implement tabs in processor flyout (elastic#74469) [Event log] Use Alerts client & Actions client when fetching these types of SOs (elastic#73257) ... # Conflicts: # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/field_components/text_editor.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/manage_processor_form.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/append.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/bytes.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/circle.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/field_name_field.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/ignore_missing_field.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/convert.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/csv.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/date.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/date_index_name.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/dissect.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/dot_expander.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/drop.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/index.ts # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/shared.ts

* master: [Vega] add functional tests for Vega visualization (elastic#74097) [ML] Removing full lodash library imports (elastic#74742) [Search] Server strategy example (elastic#71679) [Reporting] Fix and test for Listing of Reports (elastic#74453) [maps] fix drawing shapes (elastic#74689) [Resolver] Improve simulator. Add more click-through tests and panel tests. (elastic#74601) Deprecate schema-less specs in Vega (elastic#73805) [Security Solution] Rename Administration > Hosts subtab to Endpoints (elastic#74287) Timelion deprecation doc (elastic#74508)

* [Search] Server strategy example (#71679) * Server strategy example * Add tsconfig Renamed is_partial to isPartial Added isPartial and isRunning to OSS response type * Docs + remove unused sample code * Fix test naming of arguments * ts * ts fix * Add filters and query input selector * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * Use new service * exapmle plugin ts * unsubscribe + use timefilter * typo * docs * Add comments and use agg config * Added agg configs Added field selector Added a custom input param * Adding getEsQuery to query service (??) * Add server side example * docs * caps * list plugin in examples page * fix typo * Update examples/search_examples/public/application.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/application.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * Update examples/search_examples/public/components/app.tsx Co-authored-by: Lukas Olson <[email protected]> * eslint Co-authored-by: Lukas Olson <[email protected]> Co-authored-by: Elastic Machine <[email protected]> * Update kibana.json Co-authored-by: Lukas Olson <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

simianhacker · 2020-08-17T21:28:32Z

Did this get reverted?

simianhacker · 2020-08-17T21:32:48Z

Nevermind... My VS Code was not updating properly.

lizozom self-assigned this Jul 15, 2020

lizozom marked this pull request as ready for review July 15, 2020 12:04

lizozom requested review from a team as code owners July 15, 2020 12:04

lizozom requested a review from lukasolson July 15, 2020 12:04

lizozom added v7.9.0 v8.0.0 Feature:Search Querying infrastructure in Kibana Team:AppArch labels Jul 15, 2020

lizozom added the release_note:skip Skip the PR/issue when compiling release notes label Jul 15, 2020

lizozom requested a review from alexwizp July 15, 2020 13:16

mdefazio approved these changes Jul 15, 2020

View reviewed changes

lukasolson reviewed Jul 15, 2020

View reviewed changes

alexwizp reviewed Jul 20, 2020

View reviewed changes

examples/search_examples/public/components/app.tsx Outdated Show resolved Hide resolved

alexwizp reviewed Jul 20, 2020

View reviewed changes

examples/search_examples/kibana.json Outdated Show resolved Hide resolved

lizozom requested a review from a team July 20, 2020 10:06

lizozom requested a review from a team as a code owner July 22, 2020 16:00

lizozom changed the title ~~Search server strategy example~~ [Search] server strategy example Jul 23, 2020

lizozom marked this pull request as draft July 27, 2020 13:55

alexwizp approved these changes Jul 28, 2020

View reviewed changes

Liza K and others added 9 commits July 29, 2020 11:21

Server strategy example

cf412aa

Add tsconfig

0f22458

Renamed is_partial to isPartial Added isPartial and isRunning to OSS response type

Docs + remove unused sample code

b9a5efe

Fix test naming of arguments

f7cd473

ts

f7f51c7

ts fix

170bae5

Add filters and query input selector

47d7302

Update examples/search_examples/public/components/app.tsx

a84eafb

Co-authored-by: Lukas Olson <[email protected]>

Use new service

ee3ff70

Liza K added 4 commits August 3, 2020 12:56

list plugin in examples page

c451122

Merge branch 'master' of github.com:elastic/kibana into search/server…

cf06006

…-strategy-example

fix typo

48aead1

Merge branch 'master' of github.com:elastic/kibana into search/server…

e86823a

…-strategy-example

lukasolson reviewed Aug 4, 2020

View reviewed changes

lizozom and others added 5 commits August 5, 2020 11:53

Update examples/search_examples/public/application.tsx

f90a78d

Co-authored-by: Lukas Olson <[email protected]>

Update examples/search_examples/public/application.tsx

d5f1976

Co-authored-by: Lukas Olson <[email protected]>

Update examples/search_examples/public/components/app.tsx

b118ea0

Co-authored-by: Lukas Olson <[email protected]>

Update examples/search_examples/public/components/app.tsx

828ab62

Co-authored-by: Lukas Olson <[email protected]>

Update examples/search_examples/public/components/app.tsx

b54f734

Co-authored-by: Lukas Olson <[email protected]>

Merge branch 'master' into search/server-strategy-example

5459bca

elasticmachine and others added 4 commits August 6, 2020 08:26

Merge branch 'master' into search/server-strategy-example

741d8b3

eslint

0a67c4f

Merge branch 'master' of github.com:elastic/kibana into search/server…

1960c84

…-strategy-example

Merge branch 'search/server-strategy-example' of github.com:lizozom/k…

9aebaae

…ibana into search/server-strategy-example

lizozom requested a review from lukasolson August 10, 2020 12:22

Merge branch 'master' into search/server-strategy-example

dff19c8

lukasolson approved these changes Aug 11, 2020

View reviewed changes

lizozom merged commit 506e953 into elastic:master Aug 11, 2020

lizozom mentioned this pull request Aug 11, 2020

[7.x] [Search] Server strategy example (#71679) #74805

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search] Server strategy example #71679

[Search] Server strategy example #71679

lizozom commented Jul 14, 2020 •

edited

Loading

elasticmachine commented Jul 15, 2020

mdefazio left a comment

lukasolson left a comment

lukasolson Jul 15, 2020

lukasolson Jul 15, 2020

lukasolson left a comment

lukasolson Aug 4, 2020

lizozom commented Aug 6, 2020

lizozom commented Aug 6, 2020

lizozom commented Aug 11, 2020

kibanamachine commented Aug 11, 2020

lukasolson left a comment

simianhacker commented Aug 17, 2020

simianhacker commented Aug 17, 2020

		const aggs = [{ type: 'avg', params: { field: selectedField.name } }];
		const aggsDsl = data.search.aggs.createAggConfigs(indexPattern, aggs).toDsl();

[Search] Server strategy example #71679

[Search] Server strategy example #71679

Conversation

lizozom commented Jul 14, 2020 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Jul 15, 2020

mdefazio left a comment

Choose a reason for hiding this comment

lukasolson left a comment

Choose a reason for hiding this comment

lukasolson Jul 15, 2020

Choose a reason for hiding this comment

lukasolson Jul 15, 2020

Choose a reason for hiding this comment

lukasolson left a comment

Choose a reason for hiding this comment

lukasolson Aug 4, 2020

Choose a reason for hiding this comment

lizozom commented Aug 6, 2020

lizozom commented Aug 6, 2020

lizozom commented Aug 11, 2020

kibanamachine commented Aug 11, 2020

💚 Build Succeeded

Build metrics

page load bundle size

History

lukasolson left a comment

Choose a reason for hiding this comment

simianhacker commented Aug 17, 2020

simianhacker commented Aug 17, 2020

lizozom commented Jul 14, 2020 •

edited

Loading