-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '7.x' into backport/7.x/pr-99447
- Loading branch information
Showing
360 changed files
with
9,043 additions
and
2,875 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| --- | ||
| id: kibDevTutorialExpressions | ||
| slug: /kibana-dev-docs/tutorials/expressions | ||
| title: Kibana Expressions Service | ||
| summary: Kibana Expressions Service | ||
| date: 2021-06-01 | ||
| tags: ['kibana', 'onboarding', 'dev', 'architecture'] | ||
| --- | ||
|
|
||
| ## Expressions service | ||
|
|
||
| Expression service exposes a registry of reusable functions primary used for fetching and transposing data and a registry of renderer functions that can render data into a DOM element. | ||
| Adding functions is easy and so is reusing them. An expression is a chain of functions with provided arguments, which given a single input translates to a single output. | ||
| Each expression is representable by a human friendly string which a user can type. | ||
|
|
||
| ### creating expressions | ||
|
|
||
| Here is a very simple expression string: | ||
|
|
||
| essql 'select column1, column2 from myindex' | mapColumn name=column3 fn='{ column1 + 3 }' | table | ||
|
|
||
|
|
||
| It consists of 3 functions: | ||
|
|
||
| - essql which runs given sql query against elasticsearch and returns the results | ||
| - `mapColumn`, which computes a new column from existing ones; | ||
| - `table`, which prepares the data for rendering in a tabular format. | ||
|
|
||
| The same expression could also be constructed in the code: | ||
|
|
||
| ```ts | ||
| import { buildExpression, buildExpressionFunction } from 'src/plugins/expressions'; | ||
|
|
||
| const expression = buildExpression([ | ||
| buildExpressionFunction<ExpressionFunctionEssql>('essql', [ q: 'select column1, column2 from myindex' ]), | ||
| buildExpressionFunction<ExpressionFunctionMapColumn>('mapColumn', [ name: 'column3', expression: 'column1 + 3' ]), | ||
| buildExpressionFunction<ExpressionFunctionTable>('table'), | ||
| ] | ||
| ``` | ||
| Note: Consumers need to be aware which plugin registers specific functions with expressions function registry and import correct type definitions from there. | ||
| <DocCallOut title="Server Side Search"> | ||
| The `expressions` service is available on both server and client, with similar APIs. | ||
| </DocCallOut> | ||
| ### Running expressions | ||
| Expression service exposes `execute` method which allows you to execute an expression: | ||
| ```ts | ||
| const executionContract = expressions.execute(expression, input); | ||
| const result = await executionContract.getData(); | ||
| ``` | ||
| <DocCallOut title="Server Side Search"> | ||
| Check the full spec of execute function [here](https://github.com/elastic/kibana/blob/master/docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.execution.md) | ||
| </DocCallOut> | ||
| In addition, on the browser side, there are two additional ways to run expressions and render the results. | ||
| #### React expression renderer component | ||
| This is the easiest way to get expressions rendered inside your application. | ||
| ```ts | ||
| <ReactExpressionRenderer expression={expression} /> | ||
| ``` | ||
| <DocCallOut title="Server Side Search"> | ||
| Check the full spec of ReactExpressionRenderer component props [here](https://github.com/elastic/kibana/blob/master/docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.reactexpressionrendererprops.md) | ||
| </DocCallOut> | ||
| #### Expression loader | ||
| If you are not using React, you can use the loader expression service provides to achieve the same: | ||
| ```ts | ||
| const handler = loader(domElement, expression, params); | ||
| ``` | ||
| <DocCallOut title="Server Side Search"> | ||
| Check the full spec of expression loader params [here](https://github.com/elastic/kibana/blob/master/docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.iexpressionloaderparams.md) | ||
| </DocCallOut> | ||
| ### Creating new expression functions | ||
| Creating a new expression function is easy, just call `registerFunction` method on expressions service setup contract with your function definition: | ||
| ```ts | ||
| const functionDefinition = { | ||
| name: 'clog', | ||
| args: {}, | ||
| help: 'Outputs the context to the console', | ||
| fn: (input: unknown) => { | ||
| // eslint-disable-next-line no-console | ||
| console.log(input); | ||
| return input; | ||
| }, | ||
| }; | ||
|
|
||
| expressions.registerFunction(functionDefinition); | ||
| ``` | ||
| <DocCallOut title="Server Side Search"> | ||
| Check the full interface of ExpressionFuntionDefinition [here](https://github.com/elastic/kibana/blob/master/docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionfunctiondefinition.md) | ||
| </DocCallOut> | ||
| ### Creating new expression renderers | ||
| Adding new renderers is just as easy as adding functions: | ||
| ```ts | ||
| const rendererDefinition = { | ||
| name: 'debug', | ||
| help: 'Outputs the context to the dom element', | ||
| render: (domElement, input, handlers) => { | ||
| // eslint-disable-next-line no-console | ||
| domElement.innerText = JSON.strinfigy(input); | ||
| handlers.done(); | ||
| }, | ||
| }; | ||
|
|
||
| expressions.registerRenderer(rendererDefinition); | ||
| ``` | ||
| <DocCallOut title="Server Side Search"> | ||
| Check the full interface of ExpressionRendererDefinition [here](https://github.com/elastic/kibana/blob/master/docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.expressionrenderdefinition.md) | ||
| </DocCallOut> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,6 @@ correctiveActions: { | |
| [key: string]: any; | ||
| }; | ||
| }; | ||
| manualSteps?: string[]; | ||
| manualSteps: string[]; | ||
| }; | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
...plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.gettimeshift.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getTimeShift](./kibana-plugin-plugins-data-public.aggconfig.gettimeshift.md) | ||
|
|
||
| ## AggConfig.getTimeShift() method | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| getTimeShift(): undefined | moment.Duration; | ||
| ``` | ||
| <b>Returns:</b> | ||
|
|
||
| `undefined | moment.Duration` | ||
|
|
15 changes: 15 additions & 0 deletions
15
...plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.hastimeshift.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [hasTimeShift](./kibana-plugin-plugins-data-public.aggconfig.hastimeshift.md) | ||
|
|
||
| ## AggConfig.hasTimeShift() method | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| hasTimeShift(): boolean; | ||
| ``` | ||
| <b>Returns:</b> | ||
|
|
||
| `boolean` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
...nt/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.forcenow.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) > [forceNow](./kibana-plugin-plugins-data-public.aggconfigs.forcenow.md) | ||
|
|
||
| ## AggConfigs.forceNow property | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| forceNow?: Date; | ||
| ``` |
72 changes: 72 additions & 0 deletions
72
...ublic/kibana-plugin-plugins-data-public.aggconfigs.getsearchsourcetimefilter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) > [getSearchSourceTimeFilter](./kibana-plugin-plugins-data-public.aggconfigs.getsearchsourcetimefilter.md) | ||
|
|
||
| ## AggConfigs.getSearchSourceTimeFilter() method | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| getSearchSourceTimeFilter(forceNow?: Date): RangeFilter[] | { | ||
| meta: { | ||
| index: string | undefined; | ||
| params: {}; | ||
| alias: string; | ||
| disabled: boolean; | ||
| negate: boolean; | ||
| }; | ||
| query: { | ||
| bool: { | ||
| should: { | ||
| bool: { | ||
| filter: { | ||
| range: { | ||
| [x: string]: { | ||
| gte: string; | ||
| lte: string; | ||
| }; | ||
| }; | ||
| }[]; | ||
| }; | ||
| }[]; | ||
| minimum_should_match: number; | ||
| }; | ||
| }; | ||
| }[]; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | forceNow | <code>Date</code> | | | ||
|
|
||
| <b>Returns:</b> | ||
|
|
||
| `RangeFilter[] | { | ||
| meta: { | ||
| index: string | undefined; | ||
| params: {}; | ||
| alias: string; | ||
| disabled: boolean; | ||
| negate: boolean; | ||
| }; | ||
| query: { | ||
| bool: { | ||
| should: { | ||
| bool: { | ||
| filter: { | ||
| range: { | ||
| [x: string]: { | ||
| gte: string; | ||
| lte: string; | ||
| }; | ||
| }; | ||
| }[]; | ||
| }; | ||
| }[]; | ||
| minimum_should_match: number; | ||
| }; | ||
| }; | ||
| }[]` | ||
|
|
15 changes: 15 additions & 0 deletions
15
...ata/public/kibana-plugin-plugins-data-public.aggconfigs.gettimeshiftinterval.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) > [getTimeShiftInterval](./kibana-plugin-plugins-data-public.aggconfigs.gettimeshiftinterval.md) | ||
|
|
||
| ## AggConfigs.getTimeShiftInterval() method | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| getTimeShiftInterval(): moment.Duration | undefined; | ||
| ``` | ||
| <b>Returns:</b> | ||
|
|
||
| `moment.Duration | undefined` | ||
|
|
Oops, something went wrong.