Skip to content

Commit 8cb3dbc

Browse files
flash1293flash1293
authored
[Lens] Time shift metrics (#98781)
1 parent dfd6ec9 commit 8cb3dbc

File tree

116 files changed

+3698
-222
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+3698
-222
lines changed

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.gettimeshift.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getTimeShift](./kibana-plugin-plugins-data-public.aggconfig.gettimeshift.md)
4+
5+
## AggConfig.getTimeShift() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getTimeShift(): undefined | moment.Duration;
11+
```
12+
<b>Returns:</b>
13+
14+
`undefined | moment.Duration`
15+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.hastimeshift.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [hasTimeShift](./kibana-plugin-plugins-data-public.aggconfig.hastimeshift.md)
4+
5+
## AggConfig.hasTimeShift() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
hasTimeShift(): boolean;
11+
```
12+
<b>Returns:</b>
13+
14+
`boolean`
15+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ export declare class AggConfig
4646
| [getRequestAggs()](./kibana-plugin-plugins-data-public.aggconfig.getrequestaggs.md) | | |
4747
| [getResponseAggs()](./kibana-plugin-plugins-data-public.aggconfig.getresponseaggs.md) | | |
4848
| [getTimeRange()](./kibana-plugin-plugins-data-public.aggconfig.gettimerange.md) | | |
49+
| [getTimeShift()](./kibana-plugin-plugins-data-public.aggconfig.gettimeshift.md) | | |
4950
| [getValue(bucket)](./kibana-plugin-plugins-data-public.aggconfig.getvalue.md) | | |
5051
| [getValueBucketPath()](./kibana-plugin-plugins-data-public.aggconfig.getvaluebucketpath.md) | | Returns the bucket path containing the main value the agg will produce (e.g. for sum of bytes it will point to the sum, for median it will point to the 50 percentile in the percentile multi value bucket) |
52+
| [hasTimeShift()](./kibana-plugin-plugins-data-public.aggconfig.hastimeshift.md) | | |
5153
| [isFilterable()](./kibana-plugin-plugins-data-public.aggconfig.isfilterable.md) | | |
5254
| [makeLabel(percentageMode)](./kibana-plugin-plugins-data-public.aggconfig.makelabel.md) | | |
5355
| [nextId(list)](./kibana-plugin-plugins-data-public.aggconfig.nextid.md) | <code>static</code> | Calculate the next id based on the ids in this list {<!-- -->array<!-- -->} list - a list of objects with id properties |

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.forcenow.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) &gt; [forceNow](./kibana-plugin-plugins-data-public.aggconfigs.forcenow.md)
4+
5+
## AggConfigs.forceNow property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
forceNow?: Date;
11+
```

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.getsearchsourcetimefilter.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) &gt; [getSearchSourceTimeFilter](./kibana-plugin-plugins-data-public.aggconfigs.getsearchsourcetimefilter.md)
4+
5+
## AggConfigs.getSearchSourceTimeFilter() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getSearchSourceTimeFilter(forceNow?: Date): RangeFilter[] | {
11+
meta: {
12+
index: string | undefined;
13+
params: {};
14+
alias: string;
15+
disabled: boolean;
16+
negate: boolean;
17+
};
18+
query: {
19+
bool: {
20+
should: {
21+
bool: {
22+
filter: {
23+
range: {
24+
[x: string]: {
25+
gte: string;
26+
lte: string;
27+
};
28+
};
29+
}[];
30+
};
31+
}[];
32+
minimum_should_match: number;
33+
};
34+
};
35+
}[];
36+
```
37+
38+
## Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| forceNow | <code>Date</code> | |
43+
44+
<b>Returns:</b>
45+
46+
`RangeFilter[] | {
47+
meta: {
48+
index: string | undefined;
49+
params: {};
50+
alias: string;
51+
disabled: boolean;
52+
negate: boolean;
53+
};
54+
query: {
55+
bool: {
56+
should: {
57+
bool: {
58+
filter: {
59+
range: {
60+
[x: string]: {
61+
gte: string;
62+
lte: string;
63+
};
64+
};
65+
}[];
66+
};
67+
}[];
68+
minimum_should_match: number;
69+
};
70+
};
71+
}[]`
72+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.gettimeshiftinterval.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) &gt; [getTimeShiftInterval](./kibana-plugin-plugins-data-public.aggconfigs.gettimeshiftinterval.md)
4+
5+
## AggConfigs.getTimeShiftInterval() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getTimeShiftInterval(): moment.Duration | undefined;
11+
```
12+
<b>Returns:</b>
13+
14+
`moment.Duration | undefined`
15+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.gettimeshifts.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) &gt; [getTimeShifts](./kibana-plugin-plugins-data-public.aggconfigs.gettimeshifts.md)
4+
5+
## AggConfigs.getTimeShifts() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getTimeShifts(): Record<string, moment.Duration>;
11+
```
12+
<b>Returns:</b>
13+
14+
`Record<string, moment.Duration>`
15+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.hastimeshifts.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) &gt; [hasTimeShifts](./kibana-plugin-plugins-data-public.aggconfigs.hastimeshifts.md)
4+
5+
## AggConfigs.hasTimeShifts() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
hasTimeShifts(): boolean;
11+
```
12+
<b>Returns:</b>
13+
14+
`boolean`
15+

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export declare class AggConfigs
2222
| --- | --- | --- | --- |
2323
| [aggs](./kibana-plugin-plugins-data-public.aggconfigs.aggs.md) | | <code>IAggConfig[]</code> | |
2424
| [createAggConfig](./kibana-plugin-plugins-data-public.aggconfigs.createaggconfig.md) | | <code>&lt;T extends AggConfig = AggConfig&gt;(params: CreateAggConfigParams, { addToAggConfigs }?: {</code><br/><code> addToAggConfigs?: boolean &#124; undefined;</code><br/><code> }) =&gt; T</code> | |
25+
| [forceNow](./kibana-plugin-plugins-data-public.aggconfigs.forcenow.md) | | <code>Date</code> | |
2526
| [hierarchical](./kibana-plugin-plugins-data-public.aggconfigs.hierarchical.md) | | <code>boolean</code> | |
2627
| [indexPattern](./kibana-plugin-plugins-data-public.aggconfigs.indexpattern.md) | | <code>IndexPattern</code> | |
2728
| [timeFields](./kibana-plugin-plugins-data-public.aggconfigs.timefields.md) | | <code>string[]</code> | |
@@ -43,8 +44,14 @@ export declare class AggConfigs
4344
| [getRequestAggs()](./kibana-plugin-plugins-data-public.aggconfigs.getrequestaggs.md) | | |
4445
| [getResponseAggById(id)](./kibana-plugin-plugins-data-public.aggconfigs.getresponseaggbyid.md) | | Find a response agg by it's id. This may be an agg in the aggConfigs, or one created specifically for a response value |
4546
| [getResponseAggs()](./kibana-plugin-plugins-data-public.aggconfigs.getresponseaggs.md) | | Gets the AggConfigs (and possibly ResponseAggConfigs) that represent the values that will be produced when all aggs are run.<!-- -->With multi-value metric aggs it is possible for a single agg request to result in multiple agg values, which is why the length of a vis' responseValuesAggs may be different than the vis' aggs {<!-- -->array\[AggConfig\]<!-- -->} |
47+
| [getSearchSourceTimeFilter(forceNow)](./kibana-plugin-plugins-data-public.aggconfigs.getsearchsourcetimefilter.md) | | |
48+
| [getTimeShiftInterval()](./kibana-plugin-plugins-data-public.aggconfigs.gettimeshiftinterval.md) | | |
49+
| [getTimeShifts()](./kibana-plugin-plugins-data-public.aggconfigs.gettimeshifts.md) | | |
50+
| [hasTimeShifts()](./kibana-plugin-plugins-data-public.aggconfigs.hastimeshifts.md) | | |
4651
| [jsonDataEquals(aggConfigs)](./kibana-plugin-plugins-data-public.aggconfigs.jsondataequals.md) | | Data-by-data comparison of this Aggregation Ignores the non-array indexes |
4752
| [onSearchRequestStart(searchSource, options)](./kibana-plugin-plugins-data-public.aggconfigs.onsearchrequeststart.md) | | |
53+
| [postFlightTransform(response)](./kibana-plugin-plugins-data-public.aggconfigs.postflighttransform.md) | | |
54+
| [setForceNow(now)](./kibana-plugin-plugins-data-public.aggconfigs.setforcenow.md) | | |
4855
| [setTimeFields(timeFields)](./kibana-plugin-plugins-data-public.aggconfigs.settimefields.md) | | |
4956
| [setTimeRange(timeRange)](./kibana-plugin-plugins-data-public.aggconfigs.settimerange.md) | | |
5057
| [toDsl()](./kibana-plugin-plugins-data-public.aggconfigs.todsl.md) | | |

‎docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfigs.postflighttransform.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfigs](./kibana-plugin-plugins-data-public.aggconfigs.md) &gt; [postFlightTransform](./kibana-plugin-plugins-data-public.aggconfigs.postflighttransform.md)
4+
5+
## AggConfigs.postFlightTransform() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
postFlightTransform(response: IEsSearchResponse<any>): IEsSearchResponse<any>;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| response | <code>IEsSearchResponse&lt;any&gt;</code> | |
18+
19+
<b>Returns:</b>
20+
21+
`IEsSearchResponse<any>`
22+

0 commit comments

Comments
 (0)