diff --git a/docs/apm/troubleshooting.asciidoc b/docs/apm/troubleshooting.asciidoc
index 65f7a378ec244..e00a67f6c78a4 100644
--- a/docs/apm/troubleshooting.asciidoc
+++ b/docs/apm/troubleshooting.asciidoc
@@ -49,7 +49,7 @@ GET /_template/apm-{version}
*Using Logstash, Kafka, etc.*
If you're not outputting data directly from APM Server to Elasticsearch (perhaps you're using Logstash or Kafka),
then the index template will not be set up automatically. Instead, you'll need to
-{apm-server-ref}/_manually_loading_template_configuration.html[load the template manually].
+{apm-server-ref}/configuration-template.html[load the template manually].
*Using a custom index names*
This problem can also occur if you've customized the index name that you write APM data to.
diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md
index 89330d2a86f76..dfffdffb08a08 100644
--- a/docs/development/core/server/kibana-plugin-core-server.md
+++ b/docs/development/core/server/kibana-plugin-core-server.md
@@ -123,7 +123,7 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [LoggerFactory](./kibana-plugin-core-server.loggerfactory.md) | The single purpose of LoggerFactory interface is to define a way to retrieve a context-based logger instance. |
| [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) | Provides APIs to plugins for customizing the plugin's logger. |
| [LogMeta](./kibana-plugin-core-server.logmeta.md) | Contextual metadata |
-| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | |
+| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. |
| [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) | |
| [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
| [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md
new file mode 100644
index 0000000000000..6f05526b66c83
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) > [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md)
+
+## MetricsServiceSetup.collectionInterval property
+
+Interval metrics are collected in milliseconds
+
+Signature:
+
+```typescript
+readonly collectionInterval: number;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md
new file mode 100644
index 0000000000000..61107fbf20ad9
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) > [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md)
+
+## MetricsServiceSetup.getOpsMetrics$ property
+
+Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time, based on the `opts.interval` configuration property.
+
+Signature:
+
+```typescript
+getOpsMetrics$: () => Observable;
+```
+
+## Example
+
+
+```ts
+core.metrics.getOpsMetrics$().subscribe(metrics => {
+ // do something with the metrics
+})
+
+```
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md
index 0bec919797b6f..5fcb1417dea0e 100644
--- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md
@@ -4,8 +4,18 @@
## MetricsServiceSetup interface
+APIs to retrieves metrics gathered and exposed by the core platform.
+
Signature:
```typescript
export interface MetricsServiceSetup
```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md) | number | Interval metrics are collected in milliseconds |
+| [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md) | () => Observable<OpsMetrics> | Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's start phase, and a new value every fixed interval of time, based on the opts.interval configuration property. |
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md
new file mode 100644
index 0000000000000..25125569b7b38
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md)
+
+## OpsMetrics.collected\_at property
+
+Time metrics were recorded at.
+
+Signature:
+
+```typescript
+collected_at: Date;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md
index d2d4782385c06..9803c0fbd53cc 100644
--- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md
+++ b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md
@@ -16,6 +16,7 @@ export interface OpsMetrics
| Property | Type | Description |
| --- | --- | --- |
+| [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md) | Date | Time metrics were recorded at. |
| [concurrent\_connections](./kibana-plugin-core-server.opsmetrics.concurrent_connections.md) | OpsServerMetrics['concurrent_connections'] | number of current concurrent connections to the server |
| [os](./kibana-plugin-core-server.opsmetrics.os.md) | OpsOsMetrics | OS related metrics |
| [process](./kibana-plugin-core-server.opsmetrics.process.md) | OpsProcessMetrics | Process related metrics |
diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md
new file mode 100644
index 0000000000000..095c45266a251
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [cpu](./kibana-plugin-core-server.opsosmetrics.cpu.md)
+
+## OpsOsMetrics.cpu property
+
+cpu cgroup metrics, undefined when not running in a cgroup
+
+Signature:
+
+```typescript
+cpu?: {
+ control_group: string;
+ cfs_period_micros: number;
+ cfs_quota_micros: number;
+ stat: {
+ number_of_elapsed_periods: number;
+ number_of_times_throttled: number;
+ time_throttled_nanos: number;
+ };
+ };
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md
new file mode 100644
index 0000000000000..140646a0d1a35
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md
@@ -0,0 +1,16 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [cpuacct](./kibana-plugin-core-server.opsosmetrics.cpuacct.md)
+
+## OpsOsMetrics.cpuacct property
+
+cpu accounting metrics, undefined when not running in a cgroup
+
+Signature:
+
+```typescript
+cpuacct?: {
+ control_group: string;
+ usage_nanos: number;
+ };
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md
index 5fedb76a9c8d7..8938608531139 100644
--- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md
+++ b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md
@@ -16,6 +16,8 @@ export interface OpsOsMetrics
| Property | Type | Description |
| --- | --- | --- |
+| [cpu](./kibana-plugin-core-server.opsosmetrics.cpu.md) | { control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | cpu cgroup metrics, undefined when not running in a cgroup |
+| [cpuacct](./kibana-plugin-core-server.opsosmetrics.cpuacct.md) | { control_group: string; usage_nanos: number; } | cpu accounting metrics, undefined when not running in a cgroup |
| [distro](./kibana-plugin-core-server.opsosmetrics.distro.md) | string | The os distrib. Only present for linux platforms |
| [distroRelease](./kibana-plugin-core-server.opsosmetrics.distrorelease.md) | string | The os distrib release, prefixed by the os distrib. Only present for linux platforms |
| [load](./kibana-plugin-core-server.opsosmetrics.load.md) | { '1m': number; '5m': number; '15m': number; } | cpu load metrics |
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md
index 6ef7b991bb159..650459bfdb435 100644
--- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md
@@ -16,8 +16,6 @@ export interface SavedObjectsServiceSetup
When plugins access the Saved Objects client, a new client is created using the factory provided to `setClientFactory` and wrapped by all wrappers registered through `addClientWrapper`.
-All the setup APIs will throw if called after the service has started, and therefor cannot be used from legacy plugin code. Legacy plugins should use the legacy savedObject service until migrated.
-
## Example 1
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md
index 57c9e04966c1b..54e01d3110a2d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md
@@ -14,10 +14,6 @@ See the [mappings format](./kibana-plugin-core-server.savedobjectstypemappingdef
registerType: (type: SavedObjectsType) => void;
```
-## Remarks
-
-The type definition is an aggregation of the legacy savedObjects `schema`, `mappings` and `migration` concepts. This API is the single entry point to register saved object types in the new platform.
-
## Example
diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md
new file mode 100644
index 0000000000000..7475f0e3a4c1c
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [dependencies$](./kibana-plugin-core-server.statusservicesetup.dependencies_.md)
+
+## StatusServiceSetup.dependencies$ property
+
+Current status for all plugins this plugin depends on. Each key of the `Record` is a plugin id.
+
+Signature:
+
+```typescript
+dependencies$: Observable>;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md
new file mode 100644
index 0000000000000..6c65e44270a06
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md)
+
+## StatusServiceSetup.derivedStatus$ property
+
+The status of this plugin as derived from its dependencies.
+
+Signature:
+
+```typescript
+derivedStatus$: Observable;
+```
+
+## Remarks
+
+By default, plugins inherit this derived status from their dependencies. Calling overrides this default status.
+
+This may emit multliple times for a single status change event as propagates through the dependency tree
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md
index 3d3b73ccda25f..ba0645be4d26c 100644
--- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md
@@ -12,10 +12,73 @@ API for accessing status of Core and this plugin's dependencies as well as for c
export interface StatusServiceSetup
```
+## Remarks
+
+By default, a plugin inherits it's current status from the most severe status level of any Core services and any plugins that it depends on. This default status is available on the API.
+
+Plugins may customize their status calculation by calling the API with an Observable. Within this Observable, a plugin may choose to only depend on the status of some of its dependencies, to ignore severe status levels of particular Core services they are not concerned with, or to make its status dependent on other external services.
+
+## Example 1
+
+Customize a plugin's status to only depend on the status of SavedObjects:
+
+```ts
+core.status.set(
+ core.status.core$.pipe(
+. map((coreStatus) => {
+ return coreStatus.savedObjects;
+ }) ;
+ );
+);
+
+```
+
+## Example 2
+
+Customize a plugin's status to include an external service:
+
+```ts
+const externalStatus$ = interval(1000).pipe(
+ switchMap(async () => {
+ const resp = await fetch(`https://myexternaldep.com/_healthz`);
+ const body = await resp.json();
+ if (body.ok) {
+ return of({ level: ServiceStatusLevels.available, summary: 'External Service is up'});
+ } else {
+ return of({ level: ServiceStatusLevels.available, summary: 'External Service is unavailable'});
+ }
+ }),
+ catchError((error) => {
+ of({ level: ServiceStatusLevels.unavailable, summary: `External Service is down`, meta: { error }})
+ })
+);
+
+core.status.set(
+ combineLatest([core.status.derivedStatus$, externalStatus$]).pipe(
+ map(([derivedStatus, externalStatus]) => {
+ if (externalStatus.level > derivedStatus) {
+ return externalStatus;
+ } else {
+ return derivedStatus;
+ }
+ })
+ )
+);
+
+```
+
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [core$](./kibana-plugin-core-server.statusservicesetup.core_.md) | Observable<CoreStatus> | Current status for all Core services. |
+| [dependencies$](./kibana-plugin-core-server.statusservicesetup.dependencies_.md) | Observable<Record<string, ServiceStatus>> | Current status for all plugins this plugin depends on. Each key of the Record is a plugin id. |
+| [derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) | Observable<ServiceStatus> | The status of this plugin as derived from its dependencies. |
| [overall$](./kibana-plugin-core-server.statusservicesetup.overall_.md) | Observable<ServiceStatus> | Overall system status for all of Kibana. |
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [set(status$)](./kibana-plugin-core-server.statusservicesetup.set.md) | Allows a plugin to specify a custom status dependent on its own criteria. Completely overrides the default inherited status. |
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md
new file mode 100644
index 0000000000000..143cd397c40ae
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md
@@ -0,0 +1,28 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [set](./kibana-plugin-core-server.statusservicesetup.set.md)
+
+## StatusServiceSetup.set() method
+
+Allows a plugin to specify a custom status dependent on its own criteria. Completely overrides the default inherited status.
+
+Signature:
+
+```typescript
+set(status$: Observable): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| status$ | Observable<ServiceStatus> | |
+
+Returns:
+
+`void`
+
+## Remarks
+
+See the [StatusServiceSetup.derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) API for leveraging the default status calculation that is provided by Core.
+
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md
index 337b4b3302cc3..d32e9a955f890 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md
@@ -9,7 +9,6 @@
```typescript
export declare function getSearchParamsFromRequest(searchRequest: SearchRequest, dependencies: {
- esShardTimeout: number;
getConfig: GetConfigFn;
}): ISearchRequestParams;
```
@@ -19,7 +18,7 @@ export declare function getSearchParamsFromRequest(searchRequest: SearchRequest,
| Parameter | Type | Description |
| --- | --- | --- |
| searchRequest | SearchRequest | |
-| dependencies | { esShardTimeout: number; getConfig: GetConfigFn; } | |
+| dependencies | { getConfig: GetConfigFn; } | |
Returns:
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
index b651480a85899..0c493ca492953 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
@@ -69,6 +69,7 @@
| [OptionedValueProp](./kibana-plugin-plugins-data-public.optionedvalueprop.md) | |
| [Query](./kibana-plugin-plugins-data-public.query.md) | |
| [QueryState](./kibana-plugin-plugins-data-public.querystate.md) | All query state service state |
+| [QueryStateChange](./kibana-plugin-plugins-data-public.querystatechange.md) | |
| [QuerySuggestionBasic](./kibana-plugin-plugins-data-public.querysuggestionbasic.md) | \* |
| [QuerySuggestionField](./kibana-plugin-plugins-data-public.querysuggestionfield.md) | \* |
| [QuerySuggestionGetFnArgs](./kibana-plugin-plugins-data-public.querysuggestiongetfnargs.md) | \* |
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.appfilters.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.appfilters.md
new file mode 100644
index 0000000000000..b358e9477e515
--- /dev/null
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.appfilters.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [QueryStateChange](./kibana-plugin-plugins-data-public.querystatechange.md) > [appFilters](./kibana-plugin-plugins-data-public.querystatechange.appfilters.md)
+
+## QueryStateChange.appFilters property
+
+Signature:
+
+```typescript
+appFilters?: boolean;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.globalfilters.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.globalfilters.md
new file mode 100644
index 0000000000000..c395f169c35a5
--- /dev/null
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.globalfilters.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [QueryStateChange](./kibana-plugin-plugins-data-public.querystatechange.md) > [globalFilters](./kibana-plugin-plugins-data-public.querystatechange.globalfilters.md)
+
+## QueryStateChange.globalFilters property
+
+Signature:
+
+```typescript
+globalFilters?: boolean;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.md
new file mode 100644
index 0000000000000..71fb211da11d2
--- /dev/null
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.querystatechange.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [QueryStateChange](./kibana-plugin-plugins-data-public.querystatechange.md)
+
+## QueryStateChange interface
+
+Signature:
+
+```typescript
+export interface QueryStateChange extends QueryStateChangePartial
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [appFilters](./kibana-plugin-plugins-data-public.querystatechange.appfilters.md) | boolean | |
+| [globalFilters](./kibana-plugin-plugins-data-public.querystatechange.globalfilters.md) | boolean | |
+
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchbar.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchbar.md
index 498691c06285d..d1d20291a6799 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchbar.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchbar.md
@@ -7,7 +7,7 @@
Signature:
```typescript
-SearchBar: React.ComponentClass, "query" | "isLoading" | "filters" | "onRefresh" | "onRefreshChange" | "refreshInterval" | "indexPatterns" | "dataTestSubj" | "customSubmitButton" | "screenTitle" | "showQueryBar" | "showQueryInput" | "showFilterBar" | "showDatePicker" | "showAutoRefreshOnly" | "isRefreshPaused" | "dateRangeFrom" | "dateRangeTo" | "showSaveQuery" | "savedQuery" | "onQueryChange" | "onQuerySubmit" | "onSaved" | "onSavedQueryUpdated" | "onClearSavedQuery" | "indicateNoData" | "timeHistory" | "onFiltersUpdated">, any> & {
- WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>;
+SearchBar: React.ComponentClass, "query" | "isLoading" | "filters" | "onRefresh" | "onRefreshChange" | "refreshInterval" | "indexPatterns" | "dataTestSubj" | "timeHistory" | "customSubmitButton" | "screenTitle" | "showQueryBar" | "showQueryInput" | "showFilterBar" | "showDatePicker" | "showAutoRefreshOnly" | "isRefreshPaused" | "dateRangeFrom" | "dateRangeTo" | "showSaveQuery" | "savedQuery" | "onQueryChange" | "onQuerySubmit" | "onSaved" | "onSavedQueryUpdated" | "onClearSavedQuery" | "indicateNoData" | "onFiltersUpdated">, any> & {
+ WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>;
}
```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor._constructor_.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor._constructor_.md
index 6f5dd1076fb40..4c67639300883 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor._constructor_.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor._constructor_.md
@@ -4,12 +4,12 @@
## SearchInterceptor.(constructor)
-This class should be instantiated with a `requestTimeout` corresponding with how many ms after requests are initiated that they should automatically cancel.
+Constructs a new instance of the `SearchInterceptor` class
Signature:
```typescript
-constructor(deps: SearchInterceptorDeps, requestTimeout?: number | undefined);
+constructor(deps: SearchInterceptorDeps);
```
## Parameters
@@ -17,5 +17,4 @@ constructor(deps: SearchInterceptorDeps, requestTimeout?: number | undefined);
| Parameter | Type | Description |
| --- | --- | --- |
| deps | SearchInterceptorDeps | |
-| requestTimeout | number | undefined | |
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md
index 32954927504ae..fd9f23a7f0052 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md
@@ -14,21 +14,18 @@ export declare class SearchInterceptor
| Constructor | Modifiers | Description |
| --- | --- | --- |
-| [(constructor)(deps, requestTimeout)](./kibana-plugin-plugins-data-public.searchinterceptor._constructor_.md) | | This class should be instantiated with a requestTimeout corresponding with how many ms after requests are initiated that they should automatically cancel. |
+| [(constructor)(deps)](./kibana-plugin-plugins-data-public.searchinterceptor._constructor_.md) | | Constructs a new instance of the SearchInterceptor class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [deps](./kibana-plugin-plugins-data-public.searchinterceptor.deps.md) | | SearchInterceptorDeps | |
-| [requestTimeout](./kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md) | | number | undefined | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [getPendingCount$()](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md) | | Returns an Observable over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses. |
-| [runSearch(request, signal, strategy)](./kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md) | | |
| [search(request, options)](./kibana-plugin-plugins-data-public.searchinterceptor.search.md) | | Searches using the given search method. Overrides the AbortSignal with one that will abort either when cancelPending is called, when the request times out, or when the original AbortSignal is aborted. Updates pendingCount$ when the request is started/finalized. |
-| [setupTimers(options)](./kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md) | | |
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md
deleted file mode 100644
index 3123433762991..0000000000000
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-
-[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) > [requestTimeout](./kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md)
-
-## SearchInterceptor.requestTimeout property
-
-Signature:
-
-```typescript
-protected readonly requestTimeout?: number | undefined;
-```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md
deleted file mode 100644
index ad1d1dcb59d7b..0000000000000
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) > [runSearch](./kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md)
-
-## SearchInterceptor.runSearch() method
-
-Signature:
-
-```typescript
-protected runSearch(request: IEsSearchRequest, signal: AbortSignal, strategy?: string): Observable;
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| request | IEsSearchRequest | |
-| signal | AbortSignal | |
-| strategy | string | |
-
-Returns:
-
-`Observable`
-
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md
deleted file mode 100644
index fe35655258b4c..0000000000000
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-
-[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) > [setupTimers](./kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md)
-
-## SearchInterceptor.setupTimers() method
-
-Signature:
-
-```typescript
-protected setupTimers(options?: ISearchOptions): {
- combinedSignal: AbortSignal;
- cleanup: () => void;
- };
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| options | ISearchOptions | |
-
-Returns:
-
-`{
- combinedSignal: AbortSignal;
- cleanup: () => void;
- }`
-
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ui_settings.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ui_settings.md
index e515c3513df6c..6ed20beb396f1 100644
--- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ui_settings.md
+++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ui_settings.md
@@ -20,6 +20,7 @@ UI_SETTINGS: {
readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: "courier:maxConcurrentShardRequests";
readonly COURIER_BATCH_SEARCHES: "courier:batchSearches";
readonly SEARCH_INCLUDE_FROZEN: "search:includeFrozen";
+ readonly SEARCH_TIMEOUT: "search:timeout";
readonly HISTOGRAM_BAR_TARGET: "histogram:barTarget";
readonly HISTOGRAM_MAX_BARS: "histogram:maxBars";
readonly HISTORY_LIMIT: "history:limit";
diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getdefaultsearchparams.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getdefaultsearchparams.md
index 9de005c1fd0dd..e718ca42ca30f 100644
--- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getdefaultsearchparams.md
+++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getdefaultsearchparams.md
@@ -7,24 +7,26 @@
Signature:
```typescript
-export declare function getDefaultSearchParams(config: SharedGlobalConfig): {
- timeout: string;
+export declare function getDefaultSearchParams(uiSettingsClient: IUiSettingsClient): Promise<{
+ maxConcurrentShardRequests: number | undefined;
+ ignoreThrottled: boolean;
ignoreUnavailable: boolean;
- restTotalHitsAsInt: boolean;
-};
+ trackTotalHits: boolean;
+}>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
-| config | SharedGlobalConfig | |
+| uiSettingsClient | IUiSettingsClient | |
Returns:
-`{
- timeout: string;
+`Promise<{
+ maxConcurrentShardRequests: number | undefined;
+ ignoreThrottled: boolean;
ignoreUnavailable: boolean;
- restTotalHitsAsInt: boolean;
-}`
+ trackTotalHits: boolean;
+}>`
diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getshardtimeout.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getshardtimeout.md
new file mode 100644
index 0000000000000..d7e2a597ff33d
--- /dev/null
+++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.getshardtimeout.md
@@ -0,0 +1,30 @@
+
+
+[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [getShardTimeout](./kibana-plugin-plugins-data-server.getshardtimeout.md)
+
+## getShardTimeout() function
+
+Signature:
+
+```typescript
+export declare function getShardTimeout(config: SharedGlobalConfig): {
+ timeout: string;
+} | {
+ timeout?: undefined;
+};
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| config | SharedGlobalConfig | |
+
+Returns:
+
+`{
+ timeout: string;
+} | {
+ timeout?: undefined;
+}`
+
diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md
index 70c32adeab9fd..f5b587d86b349 100644
--- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md
+++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.md
@@ -26,11 +26,13 @@
| Function | Description |
| --- | --- |
-| [getDefaultSearchParams(config)](./kibana-plugin-plugins-data-server.getdefaultsearchparams.md) | |
+| [getDefaultSearchParams(uiSettingsClient)](./kibana-plugin-plugins-data-server.getdefaultsearchparams.md) | |
+| [getShardTimeout(config)](./kibana-plugin-plugins-data-server.getshardtimeout.md) | |
| [getTime(indexPattern, timeRange, options)](./kibana-plugin-plugins-data-server.gettime.md) | |
| [parseInterval(interval)](./kibana-plugin-plugins-data-server.parseinterval.md) | |
| [plugin(initializerContext)](./kibana-plugin-plugins-data-server.plugin.md) | Static code to be shared externally |
| [shouldReadFieldFromDocValues(aggregatable, esType)](./kibana-plugin-plugins-data-server.shouldreadfieldfromdocvalues.md) | |
+| [toSnakeCase(obj)](./kibana-plugin-plugins-data-server.tosnakecase.md) | |
| [usageProvider(core)](./kibana-plugin-plugins-data-server.usageprovider.md) | |
## Interfaces
diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.plugin.start.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.plugin.start.md
index 2d9104ef894bc..455c5ecdd8195 100644
--- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.plugin.start.md
+++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.plugin.start.md
@@ -8,7 +8,7 @@
```typescript
start(core: CoreStart): {
- search: ISearchStart>;
+ search: ISearchStart>;
fieldFormats: {
fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise;
};
@@ -27,7 +27,7 @@ start(core: CoreStart): {
Returns:
`{
- search: ISearchStart>;
+ search: ISearchStart>;
fieldFormats: {
fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise;
};
diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.tosnakecase.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.tosnakecase.md
new file mode 100644
index 0000000000000..eda9e9c312e59
--- /dev/null
+++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.tosnakecase.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [toSnakeCase](./kibana-plugin-plugins-data-server.tosnakecase.md)
+
+## toSnakeCase() function
+
+Signature:
+
+```typescript
+export declare function toSnakeCase(obj: Record): import("lodash").Dictionary;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| obj | Record<string, any> | |
+
+Returns:
+
+`import("lodash").Dictionary`
+
diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ui_settings.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ui_settings.md
index e419b64cd43aa..2d4ce75b956df 100644
--- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ui_settings.md
+++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ui_settings.md
@@ -20,6 +20,7 @@ UI_SETTINGS: {
readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: "courier:maxConcurrentShardRequests";
readonly COURIER_BATCH_SEARCHES: "courier:batchSearches";
readonly SEARCH_INCLUDE_FROZEN: "search:includeFrozen";
+ readonly SEARCH_TIMEOUT: "search:timeout";
readonly HISTOGRAM_BAR_TARGET: "histogram:barTarget";
readonly HISTOGRAM_MAX_BARS: "histogram:maxBars";
readonly HISTORY_LIMIT: "history:limit";
diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc
index a64a0330ae43f..ed20166c87f29 100644
--- a/docs/management/advanced-options.asciidoc
+++ b/docs/management/advanced-options.asciidoc
@@ -225,6 +225,7 @@ be inconsistent because different shards might be in different refresh states.
`search:includeFrozen`:: Includes {ref}/frozen-indices.html[frozen indices] in results.
Searching through frozen indices
might increase the search time. This setting is off by default. Users must opt-in to include frozen indices.
+`search:timeout`:: Change the maximum timeout for a search session or set to 0 to disable the timeout and allow queries to run to completion.
[float]
[[kibana-siem-settings]]
diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc
index 4a931aabd3646..f03022e9e9f00 100644
--- a/docs/setup/settings.asciidoc
+++ b/docs/setup/settings.asciidoc
@@ -20,12 +20,12 @@ which may cause a delay before pages start being served.
Set to `false` to disable Console. *Default: `true`*
| `cpu.cgroup.path.override:`
- | Override for cgroup cpu path when mounted in a
-manner that is inconsistent with `/proc/self/cgroup`.
+ | *deprecated* This setting has been renamed to `ops.cGroupOverrides.cpuPath`
+and the old name will no longer be supported as of 8.0.
| `cpuacct.cgroup.path.override:`
- | Override for cgroup cpuacct path when mounted
-in a manner that is inconsistent with `/proc/self/cgroup`.
+ | *deprecated* This setting has been renamed to `ops.cGroupOverrides.cpuAcctPath`
+and the old name will no longer be supported as of 8.0.
| `csp.rules:`
| A https://w3c.github.io/webappsec-csp/[content-security-policy] template
@@ -438,6 +438,14 @@ not saved in {es}. *Default: `data`*
| Set the interval in milliseconds to sample
system and process performance metrics. The minimum value is 100. *Default: `5000`*
+| `ops.cGroupOverrides.cpuPath:`
+ | Override for cgroup cpu path when mounted in a
+manner that is inconsistent with `/proc/self/cgroup`.
+
+| `ops.cGroupOverrides.cpuAcctPath:`
+ | Override for cgroup cpuacct path when mounted
+in a manner that is inconsistent with `/proc/self/cgroup`.
+
| `server.basePath:`
| Enables you to specify a path to mount {kib} at if you are
running behind a proxy. Use the `server.rewriteBasePath` setting to tell {kib}
diff --git a/docs/user/dashboard/dashboard-drilldown.asciidoc b/docs/user/dashboard/dashboard-drilldown.asciidoc
new file mode 100644
index 0000000000000..84701cae2ecc6
--- /dev/null
+++ b/docs/user/dashboard/dashboard-drilldown.asciidoc
@@ -0,0 +1,76 @@
+[[dashboard-drilldown]]
+=== Dashboard drilldown
+
+The dashboard drilldown allows you to navigate from one dashboard to another dashboard.
+For example, you might have a dashboard that shows the overall status of multiple data centers.
+You can create a drilldown that navigates from this dashboard to a dashboard
+that shows a single data center or server.
+
+This example shows a dashboard panel that contains a pie chart with a configured dashboard drilldown:
+
+[role="screenshot"]
+image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
+
+[float]
+[[drilldowns-example]]
+==== Try it: Create a dashboard drilldown
+
+Create the *Host Overview* drilldown shown above.
+
+*Set up the dashboards*
+
+. Add the <> data set.
+
+. Create a new dashboard, called `Host Overview`, and include these visualizations
+from the sample data set:
++
+[%hardbreaks]
+*[Logs] Heatmap*
+*[Logs] Visitors by OS*
+*[Logs] Host, Visits, and Bytes Table*
+*[Logs] Total Requests and Bytes*
++
+TIP: If you don’t see data for a panel, try changing the time range.
+
+. Open the *[Logs] Web traffic* dashboard.
+
+. Set a search and filter.
++
+[%hardbreaks]
+Search: `extension.keyword:( “gz” or “css” or “deb”)`
+Filter: `geo.src : CN`
+
+
+*Create the drilldown*
+
+
+. In the dashboard menu bar, click *Edit*.
+
+. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
+
+. Pick *Go to dashboard* action.
+
+. Give the drilldown a name.
+
+. Select *Host Overview* as the destination dashboard.
+
+. Keep both filters enabled so that the drilldown carries over the global filters and date range.
++
+Your input should look similar to this:
++
+[role="screenshot"]
+image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]
+
+. Click *Create drilldown.*
+
+. Save the dashboard.
++
+If you don’t save the drilldown, and then navigate away, the drilldown is lost.
+
+. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
++
+[role="screenshot"]
+image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
++
+You are navigated to your destination dashboard. Verify that the search query, filters,
+and time range are carried over.
diff --git a/docs/user/dashboard/dashboard.asciidoc b/docs/user/dashboard/dashboard.asciidoc
index 0c0151cc3ace2..c8bff91be91a6 100644
--- a/docs/user/dashboard/dashboard.asciidoc
+++ b/docs/user/dashboard/dashboard.asciidoc
@@ -4,9 +4,9 @@
[partintro]
--
-A _dashboard_ is a collection of panels that you use to analyze your data. On a dashboard, you can add a variety of panels that
-you can rearrange and tell a story about your data. Panels contain everything you need, including visualizations,
-interactive controls, markdown, and more.
+A _dashboard_ is a collection of panels that you use to analyze your data. On a dashboard, you can add a variety of panels that
+you can rearrange and tell a story about your data. Panels contain everything you need, including visualizations,
+interactive controls, markdown, and more.
With *Dashboard*s, you can:
@@ -18,7 +18,7 @@ With *Dashboard*s, you can:
* Create and apply filters to focus on the data you want to display.
-* Control who can use your data, and share the dashboard with a small or large audience.
+* Control who can use your data, and share the dashboard with a small or large audience.
* Generate reports based on your findings.
@@ -42,7 +42,7 @@ image::images/dashboard-read-only-badge.png[Example of Dashboard read only acces
[[types-of-panels]]
== Types of panels
-Panels contain everything you need to tell a story about you data, including visualizations,
+Panels contain everything you need to tell a story about you data, including visualizations,
interactive controls, Markdown, and more.
[cols="50, 50"]
@@ -50,30 +50,30 @@ interactive controls, Markdown, and more.
a| *Area*
-Displays data points, connected by a line, where the area between the line and axes are shaded.
+Displays data points, connected by a line, where the area between the line and axes are shaded.
Use area charts to compare two or more categories over time, and display the magnitude of trends.
| image:images/area.png[Area chart]
a| *Stacked area*
-Displays the evolution of the value of several data groups. The values of each group are displayed
-on top of each other. Use stacked area charts to visualize part-to-whole relationships, and to show
+Displays the evolution of the value of several data groups. The values of each group are displayed
+on top of each other. Use stacked area charts to visualize part-to-whole relationships, and to show
how each category contributes to the cumulative total.
| image:images/stacked_area.png[Stacked area chart]
a| *Bar*
-Displays bars side-by-side where each bar represents a category. Use bar charts to compare data across a
-large number of categories, display data that includes categories with negative values, and easily identify
+Displays bars side-by-side where each bar represents a category. Use bar charts to compare data across a
+large number of categories, display data that includes categories with negative values, and easily identify
the categories that represent the highest and lowest values. Kibana also supports horizontal bar charts.
| image:images/bar.png[Bar chart]
a| *Stacked bar*
-Displays numeric values across two or more categories. Use stacked bar charts to compare numeric values between
+Displays numeric values across two or more categories. Use stacked bar charts to compare numeric values between
levels of a categorical value. Kibana also supports stacked horizontal bar charts.
| image:images/stacked_bar.png[Stacked area chart]
@@ -81,15 +81,15 @@ levels of a categorical value. Kibana also supports stacked horizontal bar chart
a| *Line*
-Displays data points that are connected by a line. Use line charts to visualize a sequence of values, discover
+Displays data points that are connected by a line. Use line charts to visualize a sequence of values, discover
trends over time, and forecast future values.
| image:images/line.png[Line chart]
a| *Pie*
-Displays slices that represent a data category, where the slice size is proportional to the quantity it represents.
-Use pie charts to show comparisons between multiple categories, illustrate the dominance of one category over others,
+Displays slices that represent a data category, where the slice size is proportional to the quantity it represents.
+Use pie charts to show comparisons between multiple categories, illustrate the dominance of one category over others,
and show percentage or proportional data.
| image:images/pie.png[Pie chart]
@@ -103,7 +103,7 @@ Similar to the pie chart, but the central circle is removed. Use donut charts wh
a| *Tree map*
-Relates different segments of your data to the whole. Each rectangle is subdivided into smaller rectangles, or sub branches, based on
+Relates different segments of your data to the whole. Each rectangle is subdivided into smaller rectangles, or sub branches, based on
its proportion to the whole. Use treemaps to make efficient use of space to show percent total for each category.
| image:images/treemap.png[Tree map]
@@ -111,7 +111,7 @@ its proportion to the whole. Use treemaps to make efficient use of space to show
a| *Heat map*
-Displays graphical representations of data where the individual values are represented by colors. Use heat maps when your data set includes
+Displays graphical representations of data where the individual values are represented by colors. Use heat maps when your data set includes
categorical data. For example, use a heat map to see the flights of origin countries compared to destination countries using the sample flight data.
| image:images/heat_map.png[Heat map]
@@ -125,7 +125,7 @@ Displays how your metric progresses toward a fixed goal. Use the goal to display
a| *Gauge*
-Displays your data along a scale that changes color according to where your data falls on the expected scale. Use the gauge to show how metric
+Displays your data along a scale that changes color according to where your data falls on the expected scale. Use the gauge to show how metric
values relate to reference threshold values, or determine how a specified field is performing versus how it is expected to perform.
| image:images/gauge.png[Gauge]
@@ -133,7 +133,7 @@ values relate to reference threshold values, or determine how a specified field
a| *Metric*
-Displays a single numeric value for an aggregation. Use the metric visualization when you have a numeric value that is powerful enough to tell
+Displays a single numeric value for an aggregation. Use the metric visualization when you have a numeric value that is powerful enough to tell
a story about your data.
| image:images/metric.png[Metric]
@@ -141,7 +141,7 @@ a story about your data.
a| *Data table*
-Displays your raw data or aggregation results in a tabular format. Use data tables to display server configuration details, track counts, min,
+Displays your raw data or aggregation results in a tabular format. Use data tables to display server configuration details, track counts, min,
or max values for a specific field, and monitor the status of key services.
| image:images/data_table.png[Data table]
@@ -149,7 +149,7 @@ or max values for a specific field, and monitor the status of key services.
a| *Tag cloud*
-Graphical representations of how frequently a word appears in the source text. Use tag clouds to easily produce a summary of large documents and
+Graphical representations of how frequently a word appears in the source text. Use tag clouds to easily produce a summary of large documents and
create visual art for a specific topic.
| image:images/tag_cloud.png[Tag cloud]
@@ -168,16 +168,16 @@ For all your mapping needs, use <>.
[[create-panels]]
== Create panels
-To create a panel, make sure you have {ref}/getting-started-index.html[data indexed into {es}] and an <>
-to retrieve the data from {es}. If you aren’t ready to use your own data, {kib} comes with several pre-built dashboards that you can test out. For more information,
+To create a panel, make sure you have {ref}/getting-started-index.html[data indexed into {es}] and an <>
+to retrieve the data from {es}. If you aren’t ready to use your own data, {kib} comes with several pre-built dashboards that you can test out. For more information,
refer to <>.
-To begin, click *Create new*, then choose one of the following options on the
+To begin, click *Create new*, then choose one of the following options on the
*New Visualization* window:
-* Click on the type of panel you want to create, then configure the options.
+* Click on the type of panel you want to create, then configure the options.
-* Select an editor to help you create the panel.
+* Select an editor to help you create the panel.
[role="screenshot"]
image:images/Dashboard_add_new_visualization.png[Example add new visualization to dashboard]
@@ -188,19 +188,19 @@ image:images/Dashboard_add_new_visualization.png[Example add new visualization t
[[lens]]
=== Create panels with Lens
-*Lens* is the simplest and fastest way to create powerful visualizations of your data. To use *Lens*, you drag and drop as many data fields
+*Lens* is the simplest and fastest way to create powerful visualizations of your data. To use *Lens*, you drag and drop as many data fields
as you want onto the visualization builder pane, and *Lens* uses heuristics to decide how to apply each field to the visualization.
With *Lens*, you can:
* Use the automatically generated suggestions to change the visualization type.
-* Create visualizations with multiple layers and indices.
+* Create visualizations with multiple layers and indices.
* Change the aggregation and labels to customize the data.
[role="screenshot"]
image::images/lens_drag_drop.gif[Drag and drop]
-TIP: Drag-and-drop capabilities are available only when *Lens* knows how to use the data. If *Lens* is unable to automatically generate a
+TIP: Drag-and-drop capabilities are available only when *Lens* knows how to use the data. If *Lens* is unable to automatically generate a
visualization, configure the customization options for your visualization.
[float]
@@ -220,7 +220,7 @@ To filter the data fields:
[[view-data-summaries]]
==== View data summaries
-To help you decide exactly the data you want to display, get a quick summary of each field. The summary shows the distribution of
+To help you decide exactly the data you want to display, get a quick summary of each field. The summary shows the distribution of
values within the specified time range.
To view the data field summary information, navigate to the field, then click *i*.
@@ -250,10 +250,10 @@ When there is an exclamation point (!) next to a visualization type, *Lens* is u
[[customize-the-data]]
==== Customize the data
-For each visualization type, you can customize the aggregation and labels. The options available depend on the selected visualization type.
+For each visualization type, you can customize the aggregation and labels. The options available depend on the selected visualization type.
. Click a data field name in the editor, or click *Drop a field here*.
-. Change the options that appear.
+. Change the options that appear.
+
[role="screenshot"]
image::images/lens_aggregation_labels.png[Quick function options]
@@ -262,7 +262,7 @@ image::images/lens_aggregation_labels.png[Quick function options]
[[add-layers-and-indices]]
==== Add layers and indices
-To compare and analyze data from different sources, you can visualize multiple data layers and indices. Multiple layers and indices are
+To compare and analyze data from different sources, you can visualize multiple data layers and indices. Multiple layers and indices are
supported in area, line, and bar charts.
To add a layer, click *+*, then drag and drop the data fields for the new layer.
@@ -281,7 +281,7 @@ Ready to try out *Lens*? Refer to the <>.
[[tsvb]]
=== Create panels with TSVB
-*TSVB* is a time series data visualizer that allows you to use the full power of the Elasticsearch aggregation framework. To use *TSVB*,
+*TSVB* is a time series data visualizer that allows you to use the full power of the Elasticsearch aggregation framework. To use *TSVB*,
you can combine an infinite number of <> to display your data.
With *TSVB*, you can:
@@ -295,15 +295,15 @@ image::images/tsvb.png[TSVB UI]
[float]
[[configure-the-data]]
-==== Configure the data
+==== Configure the data
-With *TSVB*, you can add and display multiple data sets to compare and analyze. {kib} uses many types of <> that you can use to build
+With *TSVB*, you can add and display multiple data sets to compare and analyze. {kib} uses many types of <> that you can use to build
complex summaries of that data.
. Select *Data*. If you are using *Table*, select *Columns*.
-. From the *Aggregation* drop down, select the aggregation you want to visualize.
+. From the *Aggregation* drop down, select the aggregation you want to visualize.
+
-If you don’t see any data, change the <>.
+If you don’t see any data, change the <>.
+
To add multiple aggregations, click *+*.
. From the *Group by* drop down, select how you want to group or split the data.
@@ -315,14 +315,14 @@ When you have more than one aggregation, the last value is displayed, which is i
[[change-the-data-display]]
==== Change the data display
-To find the best way to display your data, *TSVB* supports several types of panels and charts.
+To find the best way to display your data, *TSVB* supports several types of panels and charts.
To change the *Time Series* chart type:
. Click *Data > Options*.
. Select the *Chart type*.
-To change the panel type, click on the panel options:
+To change the panel type, click on the panel options:
[role="screenshot"]
image::images/tsvb_change_display.gif[TSVB change the panel type]
@@ -331,7 +331,7 @@ image::images/tsvb_change_display.gif[TSVB change the panel type]
[[custommize-the-data]]
==== Customize the data
-View data in a different <>, and change the data label name and colors. The options available depend on the panel type.
+View data in a different <>, and change the data label name and colors. The options available depend on the panel type.
To change the index pattern, click *Panel options*, then enter the new *Index Pattern*.
@@ -361,7 +361,7 @@ image::images/tsvb_annotations.png[TSVB annotations]
[[filter-the-panel]]
==== Filter the panel
-The data that displays on the panel is based on the <> and <>.
+The data that displays on the panel is based on the <> and <>.
You can filter the data on the panels using the <>.
Click *Panel options*, then enter the syntax in the *Panel Filter* field.
@@ -372,7 +372,7 @@ If you want to ignore filters from all of {kib}, select *Yes* for *Ignore global
[[vega]]
=== Create custom panels with Vega
-Build custom visualizations using *Vega* and *Vega-Lite*, backed by one or more data sources including {es}, Elastic Map Service,
+Build custom visualizations using *Vega* and *Vega-Lite*, backed by one or more data sources including {es}, Elastic Map Service,
URL, or static data. Use the {kib} extensions to embed *Vega* in your dashboard, and add interactive tools.
Use *Vega* and *Vega-Lite* when you want to create a visualization for:
@@ -405,7 +405,7 @@ For more information about *Vega* and *Vega-Lite*, refer to:
[[timelion]]
=== Create panels with Timelion
-*Timelion* is a time series data visualizer that enables you to combine independent data sources within a single visualization.
+*Timelion* is a time series data visualizer that enables you to combine independent data sources within a single visualization.
*Timelion* is driven by a simple expression language that you use to:
@@ -422,9 +422,41 @@ Ready to try out Timelion? For step-by-step tutorials, refer to:
* <>
* <>
+[float]
+[[timelion-deprecation]]
+==== Timelion app deprecation
+
+Deprecated since 7.0, the Timelion app will be removed in 8.0. If you have any Timelion worksheets, you must migrate them to a dashboard.
+
+NOTE: Only the Timelion app is deprecated. {kib} continues to support Timelion
+visualizations on dashboards and in Visualize and Canvas.
+
+To migrate a Timelion worksheet to a dashboard:
+
+. Open the menu, click **Dashboard**, then click **Create dashboard**.
+
+. On the dashboard, click **Create New**, then select the Timelion visualization.
+
+. On a new tab, open the Timelion app, select the chart you want to copy, and copy its expression.
++
+[role="screenshot"]
+image::images/timelion-copy-expression.png[]
+
+. Return to the other tab and paste the copied expression to the *Timelion Expression* field and click **Update**.
++
+[role="screenshot"]
+image::images/timelion-vis-paste-expression.png[]
+
+. Save the new visualization, give it a name, and click **Save and Return**.
++
+Your Timelion visualization will appear on the dashboard. Repeat this for all your charts on each worksheet.
++
+[role="screenshot"]
+image::images/timelion-dashboard.png[]
+
[float]
[[save-panels]]
-=== Save panels
+== Save panels
When you’ve finished making changes, save the panels.
@@ -436,7 +468,7 @@ When you’ve finished making changes, save the panels.
[[add-existing-panels]]
== Add existing panels
-Add panels that you’ve already created to your dashboard.
+Add panels that you’ve already created to your dashboard.
On the dashboard, click *Add an existing*, then select the panel you want to add.
@@ -445,7 +477,7 @@ When a panel contains a stored query, both queries are applied.
[role="screenshot"]
image:images/Dashboard_add_visualization.png[Example add visualization to dashboard]
-To make changes to the panel, put the dashboard in *Edit* mode, then select the edit option from the panel menu.
+To make changes to the panel, put the dashboard in *Edit* mode, then select the edit option from the panel menu.
The changes you make appear in every dashboard that uses the panel, except if you edit the panel title. Changes to the panel title appear only on the dashboard where you made the change.
[float]
@@ -463,6 +495,8 @@ include::edit-dashboards.asciidoc[]
include::explore-dashboard-data.asciidoc[]
+include::drilldowns.asciidoc[]
+
include::share-dashboards.asciidoc[]
include::tutorials.asciidoc[]
diff --git a/docs/user/dashboard/drilldowns.asciidoc b/docs/user/dashboard/drilldowns.asciidoc
index 5fca974d58135..85230f1b6f70d 100644
--- a/docs/user/dashboard/drilldowns.asciidoc
+++ b/docs/user/dashboard/drilldowns.asciidoc
@@ -1,106 +1,51 @@
-[float]
[[drilldowns]]
-=== Use drilldowns for dashboard actions
+== Use drilldowns for dashboard actions
Drilldowns, also known as custom actions, allow you to configure a
workflow for analyzing and troubleshooting your data.
-Using a drilldown, you can navigate from one dashboard to another,
+For example, using a drilldown, you can navigate from one dashboard to another,
taking the current time range, filters, and other parameters with you,
so the context remains the same. You can continue your analysis from a new perspective.
-For example, you might have a dashboard that shows the overall status of multiple data centers.
-You can create a drilldown that navigates from this dashboard to a dashboard
-that shows a single data center or server.
-
-[float]
-[[how-drilldowns-work]]
-==== How drilldowns work
-
-Drilldowns are user-configurable {kib} actions that are stored with the
-dashboard metadata. Drilldowns are specific to the dashboard panel
-for which you create them—they are not shared across panels.
-A panel can have multiple drilldowns.
-
-This example shows a dashboard panel that contains a pie chart.
-Typically, clicking a pie slice applies the current filter.
-When a panel has a drilldown, clicking a pie slice opens a menu with
-the default action and your drilldowns. Refer to the <>
-for instructions on how to create this drilldown.
-
[role="screenshot"]
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
-Third-party developers can create drilldowns.
-Refer to https://github.com/elastic/kibana/tree/master/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
-to learn how to code drilldowns.
-
-[float]
-[[create-manage-drilldowns]]
-==== Create and manage drilldowns
-
-Your dashboard must be in *Edit* mode to create a drilldown.
-Once a panel has at least one drilldown, the menu also includes a *Manage drilldowns* action
-for editing and deleting drilldowns.
-
-[role="screenshot"]
-image::images/drilldown_menu.png[Panel menu with Create drilldown and Manage drilldown actions]
+Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns.
[float]
-[[drilldowns-example]]
-==== Try it: Create a drilldown
-
-This example shows how to create the *Host Overview* drilldown shown earlier in this doc.
+[[actions]]
+=== Drilldown actions
-*Set up the dashboards*
+Drilldowns are user-configurable {kib} actions that are stored with the dashboard metadata.
+Kibana provides the following types of actions:
-. Add the <> data set.
+[cols="2"]
+|===
-. Create a new dashboard, called `Host Overview`, and include these visualizations
-from the sample data set:
-+
-[%hardbreaks]
-*[Logs] Heatmap*
-*[Logs] Visitors by OS*
-*[Logs] Host, Visits, and Bytes Table*
-*[Logs] Total Requests and Bytes*
-+
-TIP: If you don’t see data for a panel, try changing the time range.
+a| <>
-. Open the *[Logs] Web traffic* dashboard.
+| Navigate to a dashboard.
-. Set a search and filter.
-+
-[%hardbreaks]
-Search: `extension.keyword:( “gz” or “css” or “deb”)`
-Filter: `geo.src : CN`
+a| <>
-*Create the drilldown*
+| Navigate to external or internal URL.
-. In the dashboard menu bar, click *Edit*.
+|===
-. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
+[NOTE]
+==============================================
+Some action types are paid commercial features, while others are free.
+For a comparison of the Elastic subscription levels,
+see https://www.elastic.co/subscriptions[the subscription page].
+==============================================
-. Give the drilldown a name.
-
-. Select *Host Overview* as the destination dashboard.
-
-. Keep both filters enabled so that the drilldown carries over the global filters and date range.
-+
-Your input should look similar to this:
-+
-[role="screenshot"]
-image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]
-
-. Click *Create drilldown.*
+[float]
+[[code-drilldowns]]
+=== Code drilldowns
+Third-party developers can create drilldowns.
+Refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
+to learn how to code drilldowns.
-. Save the dashboard.
-+
-If you don’t save the drilldown, and then navigate away, the drilldown is lost.
+include::dashboard-drilldown.asciidoc[]
+include::url-drilldown.asciidoc[]
-. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
-+
-[role="screenshot"]
-image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
-+
-You are navigated to your destination dashboard. Verify that the search query, filters,
-and time range are carried over.
diff --git a/docs/user/dashboard/explore-dashboard-data.asciidoc b/docs/user/dashboard/explore-dashboard-data.asciidoc
index a0564f5bceb3d..238dfb79e900b 100644
--- a/docs/user/dashboard/explore-dashboard-data.asciidoc
+++ b/docs/user/dashboard/explore-dashboard-data.asciidoc
@@ -16,5 +16,3 @@ The data that displays depends on the element that you inspect.
image:images/Dashboard_inspect.png[Inspect in dashboard]
include::explore-underlying-data.asciidoc[]
-
-include::drilldowns.asciidoc[]
diff --git a/docs/user/dashboard/images/drilldown_pick_an_action.png b/docs/user/dashboard/images/drilldown_pick_an_action.png
new file mode 100644
index 0000000000000..c99e931e3fbe1
Binary files /dev/null and b/docs/user/dashboard/images/drilldown_pick_an_action.png differ
diff --git a/docs/user/dashboard/images/url_drilldown_github.png b/docs/user/dashboard/images/url_drilldown_github.png
new file mode 100644
index 0000000000000..d2eaec311948e
Binary files /dev/null and b/docs/user/dashboard/images/url_drilldown_github.png differ
diff --git a/docs/user/dashboard/images/url_drilldown_go_to_github.gif b/docs/user/dashboard/images/url_drilldown_go_to_github.gif
new file mode 100644
index 0000000000000..7cca3f72d5a68
Binary files /dev/null and b/docs/user/dashboard/images/url_drilldown_go_to_github.gif differ
diff --git a/docs/user/dashboard/images/url_drilldown_pick_an_action.png b/docs/user/dashboard/images/url_drilldown_pick_an_action.png
new file mode 100644
index 0000000000000..c99e931e3fbe1
Binary files /dev/null and b/docs/user/dashboard/images/url_drilldown_pick_an_action.png differ
diff --git a/docs/user/dashboard/images/url_drilldown_popup.png b/docs/user/dashboard/images/url_drilldown_popup.png
new file mode 100644
index 0000000000000..392edd16ea328
Binary files /dev/null and b/docs/user/dashboard/images/url_drilldown_popup.png differ
diff --git a/docs/user/dashboard/images/url_drilldown_trigger_picker.png b/docs/user/dashboard/images/url_drilldown_trigger_picker.png
new file mode 100644
index 0000000000000..2fe930f35dce8
Binary files /dev/null and b/docs/user/dashboard/images/url_drilldown_trigger_picker.png differ
diff --git a/docs/user/dashboard/images/url_drilldown_url_template.png b/docs/user/dashboard/images/url_drilldown_url_template.png
new file mode 100644
index 0000000000000..d8515afe66a80
Binary files /dev/null and b/docs/user/dashboard/images/url_drilldown_url_template.png differ
diff --git a/docs/user/dashboard/url-drilldown.asciidoc b/docs/user/dashboard/url-drilldown.asciidoc
new file mode 100644
index 0000000000000..16f82477756b7
--- /dev/null
+++ b/docs/user/dashboard/url-drilldown.asciidoc
@@ -0,0 +1,221 @@
+[[url-drilldown]]
+=== URL drilldown
+
+The URL drilldown allows you to navigate from a dashboard to an internal or external URL.
+The destination URL can be dynamic, depending on the dashboard context or user’s interaction with a visualization.
+
+For example, you might have a dashboard that shows data from a Github repository.
+You can create a drilldown that navigates from this dashboard to Github.
+
+[role="screenshot"]
+image:images/url_drilldown_go_to_github.gif[Drilldown on pie chart that navigates to Github]
+
+NOTE: URL drilldown is available with the https://www.elastic.co/subscriptions[Gold subscription] and higher.
+
+[float]
+[[try-it]]
+==== Try it: Create a URL drilldown
+
+This example shows how to create the "Show on Github" drilldown shown above.
+
+. Add the <> data set.
+. Open the *[Logs] Web traffic* dashboard. This isn’t data from Github, but it should work for demonstration purposes.
+. In the dashboard menu bar, click *Edit*.
+. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
+. Give the drilldown a name: *Show on Github*.
+. Select a drilldown action: *Go to URL*.
++
+[role="screenshot"]
+image:images/url_drilldown_pick_an_action.png[Action picker]
+. Enter a URL template:
++
+[source, bash]
+----
+https://github.com/elastic/kibana/issues?q=is:issue+is:open+{{event.value}}
+----
++
+This example URL navigates to {kib} issues on Github. `{{event.value}}` will be substituted with a value associated with a clicked pie slice. In _preview_ `{{event.value}}` is substituted with a <> value.
+[role="screenshot"]
+image:images/url_drilldown_url_template.png[URL template input]
+. Click *Create drilldown*.
+. Save the dashboard.
++
+If you don’t save the drilldown, and then navigate away, the drilldown is lost.
+
+. In *[Logs] Visitors by OS*, click any slice of the pie, and then select the drilldown *Show on Github*.
++
+[role="screenshot"]
+image:images/url_drilldown_popup.png[URL drilldown popup]
++
+You are navigated to the issue list in the {kib} repository. Verify that value from a pie slice you’ve clicked on is carried over to Github.
++
+[role="screenshot"]
+image:images/url_drilldown_github.png[Github]
+
+[float]
+[[trigger-picker]]
+==== Picking a trigger for a URL drilldown
+
+Some panels support multiple user interactions (called triggers) for which you can configure a URL drilldown. The list of supported variables in the URL template depends on the trigger you selected.
+In the preceding example, you configured a URL drilldown on a pie chart. The only trigger that pie chart supports is clicking on a pie slice, so you didn’t have to pick a trigger.
+
+However, the sample *[Logs] Unique Visitors vs. Average Bytes* chart supports both clicking on a data point and selecting a range. When you create a URL drilldown for this chart, you have the following choices:
+
+[role="screenshot"]
+image:images/url_drilldown_trigger_picker.png[Trigger picker: Single click and Range selection]
+
+Variables in the URL template differ per trigger.
+For example, *Single click* has `{{event.value}}` and *Range selection* has `{{event.from}}` and `{{event.to}}`.
+You can create multiple URL drilldowns per panel and attach them to different triggers.
+
+[float]
+[[templating]]
+==== URL templating language
+
+The URL template input uses Handlebars — a simple templating language. Handlebars templates look like regular text with embedded Handlebars expressions.
+
+[source, bash]
+----
+https://github.com/elastic/kibana/issues?q={{event.value}}
+----
+
+A Handlebars expression is a `{{`, some contents, followed by a `}}`. When the drilldown is executed, these expressions are replaced by values from the dashboard and interaction context.
+
+Refer to Handlebars https://handlebarsjs.com/guide/expressions.html#expressions[documentation] to learn about advanced use cases.
+
+[[helpers]]
+In addition to https://handlebarsjs.com/guide/builtin-helpers.html[built-in] Handlebars helpers, you can use the following custom helpers:
+
+
+|===
+|Helper |Use case
+
+|json
+a|Serialize variables in JSON format.
+
+Example:
+
+`{{json event}}` +
+`{{json event.key event.value}}` +
+`{{json filters=context.panel.filters}}`
+
+
+|rison
+a|Serialize variables in https://github.com/w33ble/rison-node[rison] format. Rison is a common format for {kib} apps for storing state in the URL.
+
+Example:
+
+`{{rison event}}` +
+`{{rison event.key event.value}}` +
+`{{rison filters=context.panel.filters}}`
+
+
+|date
+a|Format dates. Supports relative dates expressions (for example, "now-15d"). Refer to the https://momentjs.com/docs/#/displaying/format/[moment] docs for different formatting options.
+
+Example:
+
+`{{ date event.from “YYYY MM DD”}}` +
+`{{date “now-15”}}`
+|===
+
+
+[float]
+[[variables]]
+==== URL template variables
+
+The URL drilldown template has three sources for variables:
+
+* *Global* static variables that don’t change depending on the place where the URL drilldown is used or which user interaction executed the drilldown. For example: `{{kibanaUrl}}`.
+* *Context* variables that change depending on where the drilldown is created and used. These variables are extracted from a context of a panel on a dashboard. For example, `{{context.panel.filters}}` gives access to filters that applied to the current panel.
+* *Event* variables that depend on the trigger context. These variables are dynamically extracted from the interaction context when the drilldown is executed.
+
+[[values-in-preview]]
+A subtle but important difference between *context* and *event* variables is that *context* variables use real values in previews when creating a URL drilldown.
+For example, `{{context.panel.filters}}` are previewed with the current filters that applied to a panel.
+*Event* variables are extracted during drilldown execution from a user interaction with a panel (for example, from a pie slice that the user clicked on).
+
+Because there is no user interaction with a panel in preview, there is no interaction context to use in a preview.
+To work around this, {kib} provides a sample interaction that relies on a picked <>.
+So in a preview, you might notice that `{{event.value}}` is replaced with `{{event.value}}` instead of with a sample from your data.
+Such previews can help you make sure that the structure of your URL template is valid.
+However, to ensure that the configured URL drilldown works as expected with your data, you have to save the dashboard and test in the panel.
+
+You can access the full list of variables available for the current panel and selected trigger by clicking *Add variable* in the top-right corner of a URL template input.
+
+[float]
+[[variables-reference]]
+==== Variables reference
+
+
+|===
+|Source |Variable |Description
+
+|*Global*
+| kibanaUrl
+| {kib} base URL. Useful for creating URL drilldowns that navigate within {kib}.
+
+| *Context*
+| context.panel
+| Context provided by current dashboard panel.
+
+|
+| context.panel.id
+| ID of a panel.
+
+|
+| context.panel.title
+| Title of a panel.
+
+|
+| context.panel.filters
+| List of {kib} filters applied to a panel. +
+Tip: Use in combination with <> helper for
+internal {kib} navigations with carrying over current filters.
+
+|
+| context.panel.query.query
+| Current query string.
+
+|
+| context.panel.query.lang
+| Current query language.
+
+|
+| context.panel.timeRange.from +
+context.panel.timeRange.to
+| Current time picker values. +
+Tip: Use in combination with <> helper to format date.
+
+|
+| context.panel.timeRange.indexPatternId +
+context.panel.timeRange.indexPatternIds
+|Index pattern ids used by a panel.
+
+|
+| context.panel.savedObjectId
+| ID of saved object behind a panel.
+
+| *Single click*
+| event.value
+| Value behind clicked data point.
+
+|
+| event.key
+| Field name behind clicked data point
+
+|
+| event.negate
+| Boolean, indicating whether clicked data point resulted in negative filter.
+
+| *Range selection*
+| event.from +
+event.to
+| `from` and `to` values of selected range. Depending on your data, could be either a date or number. +
+Tip: Consider using <> helper for date formatting.
+
+|
+| event.key
+| Aggregation field behind the selected range, if available.
+
+|===
diff --git a/docs/user/reporting/reporting-troubleshooting.asciidoc b/docs/user/reporting/reporting-troubleshooting.asciidoc
index dc4ffdfebdae9..82f0aa7ca0f19 100644
--- a/docs/user/reporting/reporting-troubleshooting.asciidoc
+++ b/docs/user/reporting/reporting-troubleshooting.asciidoc
@@ -7,6 +7,7 @@
Having trouble? Here are solutions to common problems you might encounter while using Reporting.
+* <>
* <>
* <>
* <>
@@ -15,6 +16,11 @@ Having trouble? Here are solutions to common problems you might encounter while
* <>
* <>
+[float]
+[[reporting-diagnostics]]
+=== Reporting Diagnostics
+Reporting comes with a built-in utility to try to automatically find common issues. When Kibana is running, navigate to the Report Listing page, and click the "Run reporting diagnostics..." button. This will open up a diagnostic tool that checks various parts of the Kibana deployment to come up with any relevant recommendations.
+
[float]
[[reporting-troubleshooting-system-dependencies]]
=== System dependencies
diff --git a/kibana.d.ts b/kibana.d.ts
index d64752abd8b60..517bda374af9d 100644
--- a/kibana.d.ts
+++ b/kibana.d.ts
@@ -39,8 +39,6 @@ export namespace Legacy {
export type KibanaConfig = LegacyKibanaServer.KibanaConfig;
export type Request = LegacyKibanaServer.Request;
export type ResponseToolkit = LegacyKibanaServer.ResponseToolkit;
- export type SavedObjectsClient = LegacyKibanaServer.SavedObjectsClient;
- export type SavedObjectsService = LegacyKibanaServer.SavedObjectsLegacyService;
export type Server = LegacyKibanaServer.Server;
export type InitPluginFunction = LegacyKibanaPluginSpec.InitPluginFunction;
diff --git a/package.json b/package.json
index ff487510f7a32..95a6de337f62a 100644
--- a/package.json
+++ b/package.json
@@ -231,7 +231,7 @@
"@babel/parser": "^7.11.2",
"@babel/types": "^7.11.0",
"@elastic/apm-rum": "^5.5.0",
- "@elastic/charts": "21.0.1",
+ "@elastic/charts": "21.1.2",
"@elastic/ems-client": "7.9.3",
"@elastic/eslint-config-kibana": "0.15.0",
"@elastic/eslint-plugin-eui": "0.0.2",
diff --git a/packages/kbn-ui-shared-deps/package.json b/packages/kbn-ui-shared-deps/package.json
index 4b2e88d155245..bbe7b1bc2e8da 100644
--- a/packages/kbn-ui-shared-deps/package.json
+++ b/packages/kbn-ui-shared-deps/package.json
@@ -9,7 +9,7 @@
"kbn:watch": "node scripts/build --dev --watch"
},
"dependencies": {
- "@elastic/charts": "21.0.1",
+ "@elastic/charts": "21.1.2",
"@elastic/eui": "28.2.0",
"@elastic/numeral": "^2.5.0",
"@kbn/i18n": "1.0.0",
diff --git a/rfcs/text/0010_service_status.md b/rfcs/text/0010_service_status.md
index ded594930a367..76195c4f1ab89 100644
--- a/rfcs/text/0010_service_status.md
+++ b/rfcs/text/0010_service_status.md
@@ -137,7 +137,7 @@ interface StatusSetup {
* Current status for all dependencies of the current plugin.
* Each key of the `Record` is a plugin id.
*/
- plugins$: Observable>;
+ dependencies$: Observable>;
/**
* The status of this plugin as derived from its dependencies.
diff --git a/src/legacy/utils/binder.ts b/src/cli/cluster/binder.ts
similarity index 100%
rename from src/legacy/utils/binder.ts
rename to src/cli/cluster/binder.ts
diff --git a/src/legacy/utils/binder_for.ts b/src/cli/cluster/binder_for.ts
similarity index 100%
rename from src/legacy/utils/binder_for.ts
rename to src/cli/cluster/binder_for.ts
diff --git a/src/cli/cluster/worker.ts b/src/cli/cluster/worker.ts
index 097a549187429..c8a8a067d30bf 100644
--- a/src/cli/cluster/worker.ts
+++ b/src/cli/cluster/worker.ts
@@ -21,7 +21,7 @@ import _ from 'lodash';
import cluster from 'cluster';
import { EventEmitter } from 'events';
-import { BinderFor } from '../../legacy/utils/binder_for';
+import { BinderFor } from './binder_for';
import { fromRoot } from '../../core/server/utils';
const cliPath = fromRoot('src/cli');
diff --git a/src/cli_keystore/add.js b/src/cli_keystore/add.js
index 462259ec942dd..232392f34c63b 100644
--- a/src/cli_keystore/add.js
+++ b/src/cli_keystore/add.js
@@ -18,7 +18,7 @@
*/
import { Logger } from '../cli_plugin/lib/logger';
-import { confirm, question } from '../legacy/server/utils';
+import { confirm, question } from './utils';
import { createPromiseFromStreams, createConcatStream } from '../core/server/utils';
/**
diff --git a/src/cli_keystore/add.test.js b/src/cli_keystore/add.test.js
index b5d5009667eb4..f1adee8879bc2 100644
--- a/src/cli_keystore/add.test.js
+++ b/src/cli_keystore/add.test.js
@@ -42,7 +42,7 @@ import { PassThrough } from 'stream';
import { Keystore } from '../legacy/server/keystore';
import { add } from './add';
import { Logger } from '../cli_plugin/lib/logger';
-import * as prompt from '../legacy/server/utils/prompt';
+import * as prompt from './utils/prompt';
describe('Kibana keystore', () => {
describe('add', () => {
diff --git a/src/cli_keystore/create.js b/src/cli_keystore/create.js
index 8be1eb36882f1..55fe2c151dec0 100644
--- a/src/cli_keystore/create.js
+++ b/src/cli_keystore/create.js
@@ -18,7 +18,7 @@
*/
import { Logger } from '../cli_plugin/lib/logger';
-import { confirm } from '../legacy/server/utils';
+import { confirm } from './utils';
export async function create(keystore, command, options) {
const logger = new Logger(options);
diff --git a/src/cli_keystore/create.test.js b/src/cli_keystore/create.test.js
index f48b3775ddfff..cb85475eab1cb 100644
--- a/src/cli_keystore/create.test.js
+++ b/src/cli_keystore/create.test.js
@@ -41,7 +41,7 @@ import sinon from 'sinon';
import { Keystore } from '../legacy/server/keystore';
import { create } from './create';
import { Logger } from '../cli_plugin/lib/logger';
-import * as prompt from '../legacy/server/utils/prompt';
+import * as prompt from './utils/prompt';
describe('Kibana keystore', () => {
describe('create', () => {
diff --git a/src/legacy/server/utils/index.js b/src/cli_keystore/utils/index.js
similarity index 100%
rename from src/legacy/server/utils/index.js
rename to src/cli_keystore/utils/index.js
diff --git a/src/legacy/server/utils/prompt.js b/src/cli_keystore/utils/prompt.js
similarity index 100%
rename from src/legacy/server/utils/prompt.js
rename to src/cli_keystore/utils/prompt.js
diff --git a/src/legacy/server/utils/prompt.test.js b/src/cli_keystore/utils/prompt.test.js
similarity index 100%
rename from src/legacy/server/utils/prompt.test.js
rename to src/cli_keystore/utils/prompt.test.js
diff --git a/src/core/public/core_app/status/lib/load_status.test.ts b/src/core/public/core_app/status/lib/load_status.test.ts
index 3a444a4448467..5a9f982e106a7 100644
--- a/src/core/public/core_app/status/lib/load_status.test.ts
+++ b/src/core/public/core_app/status/lib/load_status.test.ts
@@ -57,6 +57,7 @@ const mockedResponse: StatusResponse = {
],
},
metrics: {
+ collected_at: new Date('2020-01-01 01:00:00'),
collection_interval_in_millis: 1000,
os: {
platform: 'darwin' as const,
diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts
index fc753517fd940..95ac8bba57049 100644
--- a/src/core/public/doc_links/doc_links_service.ts
+++ b/src/core/public/doc_links/doc_links_service.ts
@@ -129,7 +129,7 @@ export class DocLinksService {
},
visualize: {
guide: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/visualize.html`,
- timelionDeprecation: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/timelion.html#timelion-deprecation`,
+ timelionDeprecation: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/dashboard.html#timelion-deprecation`,
},
},
});
diff --git a/src/core/server/config/deprecation/core_deprecations.ts b/src/core/server/config/deprecation/core_deprecations.ts
index e4e881ab24372..2b8b8e383da24 100644
--- a/src/core/server/config/deprecation/core_deprecations.ts
+++ b/src/core/server/config/deprecation/core_deprecations.ts
@@ -113,7 +113,7 @@ const mapManifestServiceUrlDeprecation: ConfigDeprecation = (settings, fromPath,
return settings;
};
-export const coreDeprecationProvider: ConfigDeprecationProvider = ({ unusedFromRoot }) => [
+export const coreDeprecationProvider: ConfigDeprecationProvider = ({ rename, unusedFromRoot }) => [
unusedFromRoot('savedObjects.indexCheckTimeout'),
unusedFromRoot('server.xsrf.token'),
unusedFromRoot('maps.manifestServiceUrl'),
@@ -136,6 +136,8 @@ export const coreDeprecationProvider: ConfigDeprecationProvider = ({ unusedFromR
unusedFromRoot('optimize.workers'),
unusedFromRoot('optimize.profile'),
unusedFromRoot('optimize.validateSyntaxOfNodeModules'),
+ rename('cpu.cgroup.path.override', 'ops.cGroupOverrides.cpuPath'),
+ rename('cpuacct.cgroup.path.override', 'ops.cGroupOverrides.cpuAcctPath'),
configPathDeprecation,
dataPathDeprecation,
rewriteBasePathDeprecation,
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
index c17d3d7546779..97aca74bfd48f 100644
--- a/src/core/server/index.ts
+++ b/src/core/server/index.ts
@@ -266,9 +266,7 @@ export {
SavedObjectUnsanitizedDoc,
SavedObjectsRepositoryFactory,
SavedObjectsResolveImportErrorsOptions,
- SavedObjectsSchema,
SavedObjectsSerializer,
- SavedObjectsLegacyService,
SavedObjectsUpdateOptions,
SavedObjectsUpdateResponse,
SavedObjectsAddToNamespacesOptions,
diff --git a/src/core/server/legacy/legacy_service.mock.ts b/src/core/server/legacy/legacy_service.mock.ts
index 26ec52185a5d8..c27f5be04d965 100644
--- a/src/core/server/legacy/legacy_service.mock.ts
+++ b/src/core/server/legacy/legacy_service.mock.ts
@@ -24,13 +24,7 @@ type LegacyServiceMock = jest.Mocked & { legacyId
const createDiscoverPluginsMock = (): LegacyServiceDiscoverPlugins => ({
pluginSpecs: [],
- uiExports: {
- savedObjectSchemas: {},
- savedObjectMappings: [],
- savedObjectMigrations: {},
- savedObjectValidations: {},
- savedObjectsManagement: {},
- },
+ uiExports: {},
navLinks: [],
pluginExtendedConfig: {
get: jest.fn(),
diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts
index 880011d2e1923..6e6d5cfc24340 100644
--- a/src/core/server/legacy/legacy_service.ts
+++ b/src/core/server/legacy/legacy_service.ts
@@ -264,6 +264,7 @@ export class LegacyService implements CoreService {
getTypeRegistry: startDeps.core.savedObjects.getTypeRegistry,
},
metrics: {
+ collectionInterval: startDeps.core.metrics.collectionInterval,
getOpsMetrics$: startDeps.core.metrics.getOpsMetrics$,
},
uiSettings: { asScopedToClient: startDeps.core.uiSettings.asScopedToClient },
@@ -310,6 +311,17 @@ export class LegacyService implements CoreService {
status: {
core$: setupDeps.core.status.core$,
overall$: setupDeps.core.status.overall$,
+ set: () => {
+ throw new Error(`core.status.set is unsupported in legacy`);
+ },
+ // @ts-expect-error
+ get dependencies$() {
+ throw new Error(`core.status.dependencies$ is unsupported in legacy`);
+ },
+ // @ts-expect-error
+ get derivedStatus$() {
+ throw new Error(`core.status.derivedStatus$ is unsupported in legacy`);
+ },
},
uiSettings: {
register: setupDeps.core.uiSettings.register,
@@ -341,11 +353,9 @@ export class LegacyService implements CoreService {
registerStaticDir: setupDeps.core.http.registerStaticDir,
},
hapiServer: setupDeps.core.http.server,
- kibanaMigrator: startDeps.core.savedObjects.migrator,
uiPlugins: setupDeps.uiPlugins,
elasticsearch: setupDeps.core.elasticsearch,
rendering: setupDeps.core.rendering,
- savedObjectsClientProvider: startDeps.core.savedObjects.clientProvider,
legacy: this.legacyInternals,
},
logger: this.coreContext.logger,
diff --git a/src/core/server/legacy/types.ts b/src/core/server/legacy/types.ts
index cf08689a6d0d4..1105308fd44cf 100644
--- a/src/core/server/legacy/types.ts
+++ b/src/core/server/legacy/types.ts
@@ -24,7 +24,6 @@ import { KibanaRequest, LegacyRequest } from '../http';
import { InternalCoreSetup, InternalCoreStart } from '../internal_types';
import { PluginsServiceSetup, PluginsServiceStart, UiPlugins } from '../plugins';
import { InternalRenderingServiceSetup } from '../rendering';
-import { SavedObjectsLegacyUiExports } from '../types';
/**
* @internal
@@ -128,13 +127,13 @@ export type LegacyNavLink = Omit;
unknown?: [{ pluginSpec: LegacyPluginSpec; type: unknown }];
-};
+}
/**
* @public
diff --git a/src/core/server/metrics/collectors/cgroup.test.ts b/src/core/server/metrics/collectors/cgroup.test.ts
new file mode 100644
index 0000000000000..39f917b9f0ba1
--- /dev/null
+++ b/src/core/server/metrics/collectors/cgroup.test.ts
@@ -0,0 +1,115 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import mockFs from 'mock-fs';
+import { OsCgroupMetricsCollector } from './cgroup';
+
+describe('OsCgroupMetricsCollector', () => {
+ afterEach(() => mockFs.restore());
+
+ it('returns empty object when no cgroup file present', async () => {
+ mockFs({
+ '/proc/self': {
+ /** empty directory */
+ },
+ });
+
+ const collector = new OsCgroupMetricsCollector({});
+ expect(await collector.collect()).toEqual({});
+ });
+
+ it('collects default cgroup data', async () => {
+ mockFs({
+ '/proc/self/cgroup': `
+123:memory:/groupname
+123:cpu:/groupname
+123:cpuacct:/groupname
+ `,
+ '/sys/fs/cgroup/cpuacct/groupname/cpuacct.usage': '111',
+ '/sys/fs/cgroup/cpu/groupname/cpu.cfs_period_us': '222',
+ '/sys/fs/cgroup/cpu/groupname/cpu.cfs_quota_us': '333',
+ '/sys/fs/cgroup/cpu/groupname/cpu.stat': `
+nr_periods 444
+nr_throttled 555
+throttled_time 666
+ `,
+ });
+
+ const collector = new OsCgroupMetricsCollector({});
+ expect(await collector.collect()).toMatchInlineSnapshot(`
+ Object {
+ "cpu": Object {
+ "cfs_period_micros": 222,
+ "cfs_quota_micros": 333,
+ "control_group": "/groupname",
+ "stat": Object {
+ "number_of_elapsed_periods": 444,
+ "number_of_times_throttled": 555,
+ "time_throttled_nanos": 666,
+ },
+ },
+ "cpuacct": Object {
+ "control_group": "/groupname",
+ "usage_nanos": 111,
+ },
+ }
+ `);
+ });
+
+ it('collects override cgroup data', async () => {
+ mockFs({
+ '/proc/self/cgroup': `
+123:memory:/groupname
+123:cpu:/groupname
+123:cpuacct:/groupname
+ `,
+ '/sys/fs/cgroup/cpuacct/xxcustomcpuacctxx/cpuacct.usage': '111',
+ '/sys/fs/cgroup/cpu/xxcustomcpuxx/cpu.cfs_period_us': '222',
+ '/sys/fs/cgroup/cpu/xxcustomcpuxx/cpu.cfs_quota_us': '333',
+ '/sys/fs/cgroup/cpu/xxcustomcpuxx/cpu.stat': `
+nr_periods 444
+nr_throttled 555
+throttled_time 666
+ `,
+ });
+
+ const collector = new OsCgroupMetricsCollector({
+ cpuAcctPath: 'xxcustomcpuacctxx',
+ cpuPath: 'xxcustomcpuxx',
+ });
+ expect(await collector.collect()).toMatchInlineSnapshot(`
+ Object {
+ "cpu": Object {
+ "cfs_period_micros": 222,
+ "cfs_quota_micros": 333,
+ "control_group": "xxcustomcpuxx",
+ "stat": Object {
+ "number_of_elapsed_periods": 444,
+ "number_of_times_throttled": 555,
+ "time_throttled_nanos": 666,
+ },
+ },
+ "cpuacct": Object {
+ "control_group": "xxcustomcpuacctxx",
+ "usage_nanos": 111,
+ },
+ }
+ `);
+ });
+});
diff --git a/src/core/server/metrics/collectors/cgroup.ts b/src/core/server/metrics/collectors/cgroup.ts
new file mode 100644
index 0000000000000..867ea44dff1ae
--- /dev/null
+++ b/src/core/server/metrics/collectors/cgroup.ts
@@ -0,0 +1,194 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import fs from 'fs';
+import { join as joinPath } from 'path';
+import { MetricsCollector, OpsOsMetrics } from './types';
+
+type OsCgroupMetrics = Pick;
+
+interface OsCgroupMetricsCollectorOptions {
+ cpuPath?: string;
+ cpuAcctPath?: string;
+}
+
+export class OsCgroupMetricsCollector implements MetricsCollector {
+ /** Used to prevent unnecessary file reads on systems not using cgroups. */
+ private noCgroupPresent = false;
+ private cpuPath?: string;
+ private cpuAcctPath?: string;
+
+ constructor(private readonly options: OsCgroupMetricsCollectorOptions) {}
+
+ public async collect(): Promise {
+ try {
+ await this.initializePaths();
+ if (this.noCgroupPresent || !this.cpuAcctPath || !this.cpuPath) {
+ return {};
+ }
+
+ const [cpuAcctUsage, cpuFsPeriod, cpuFsQuota, cpuStat] = await Promise.all([
+ readCPUAcctUsage(this.cpuAcctPath),
+ readCPUFsPeriod(this.cpuPath),
+ readCPUFsQuota(this.cpuPath),
+ readCPUStat(this.cpuPath),
+ ]);
+
+ return {
+ cpuacct: {
+ control_group: this.cpuAcctPath,
+ usage_nanos: cpuAcctUsage,
+ },
+
+ cpu: {
+ control_group: this.cpuPath,
+ cfs_period_micros: cpuFsPeriod,
+ cfs_quota_micros: cpuFsQuota,
+ stat: cpuStat,
+ },
+ };
+ } catch (err) {
+ if (err.code === 'ENOENT') {
+ this.noCgroupPresent = true;
+ return {};
+ } else {
+ throw err;
+ }
+ }
+ }
+
+ public reset() {}
+
+ private async initializePaths() {
+ // Perform this setup lazily on the first collect call and then memoize the results.
+ // Makes the assumption this data doesn't change while the process is running.
+ if (this.cpuPath && this.cpuAcctPath) {
+ return;
+ }
+
+ // Only read the file if both options are undefined.
+ if (!this.options.cpuPath || !this.options.cpuAcctPath) {
+ const cgroups = await readControlGroups();
+ this.cpuPath = this.options.cpuPath || cgroups[GROUP_CPU];
+ this.cpuAcctPath = this.options.cpuAcctPath || cgroups[GROUP_CPUACCT];
+ } else {
+ this.cpuPath = this.options.cpuPath;
+ this.cpuAcctPath = this.options.cpuAcctPath;
+ }
+
+ // prevents undefined cgroup paths
+ if (!this.cpuPath || !this.cpuAcctPath) {
+ this.noCgroupPresent = true;
+ }
+ }
+}
+
+const CONTROL_GROUP_RE = new RegExp('\\d+:([^:]+):(/.*)');
+const CONTROLLER_SEPARATOR_RE = ',';
+
+const PROC_SELF_CGROUP_FILE = '/proc/self/cgroup';
+const PROC_CGROUP_CPU_DIR = '/sys/fs/cgroup/cpu';
+const PROC_CGROUP_CPUACCT_DIR = '/sys/fs/cgroup/cpuacct';
+
+const GROUP_CPUACCT = 'cpuacct';
+const CPUACCT_USAGE_FILE = 'cpuacct.usage';
+
+const GROUP_CPU = 'cpu';
+const CPU_FS_PERIOD_US_FILE = 'cpu.cfs_period_us';
+const CPU_FS_QUOTA_US_FILE = 'cpu.cfs_quota_us';
+const CPU_STATS_FILE = 'cpu.stat';
+
+async function readControlGroups() {
+ const data = await fs.promises.readFile(PROC_SELF_CGROUP_FILE);
+
+ return data
+ .toString()
+ .split(/\n/)
+ .reduce((acc, line) => {
+ const matches = line.match(CONTROL_GROUP_RE);
+
+ if (matches !== null) {
+ const controllers = matches[1].split(CONTROLLER_SEPARATOR_RE);
+ controllers.forEach((controller) => {
+ acc[controller] = matches[2];
+ });
+ }
+
+ return acc;
+ }, {} as Record);
+}
+
+async function fileContentsToInteger(path: string) {
+ const data = await fs.promises.readFile(path);
+ return parseInt(data.toString(), 10);
+}
+
+function readCPUAcctUsage(controlGroup: string) {
+ return fileContentsToInteger(joinPath(PROC_CGROUP_CPUACCT_DIR, controlGroup, CPUACCT_USAGE_FILE));
+}
+
+function readCPUFsPeriod(controlGroup: string) {
+ return fileContentsToInteger(joinPath(PROC_CGROUP_CPU_DIR, controlGroup, CPU_FS_PERIOD_US_FILE));
+}
+
+function readCPUFsQuota(controlGroup: string) {
+ return fileContentsToInteger(joinPath(PROC_CGROUP_CPU_DIR, controlGroup, CPU_FS_QUOTA_US_FILE));
+}
+
+async function readCPUStat(controlGroup: string) {
+ const stat = {
+ number_of_elapsed_periods: -1,
+ number_of_times_throttled: -1,
+ time_throttled_nanos: -1,
+ };
+
+ try {
+ const data = await fs.promises.readFile(
+ joinPath(PROC_CGROUP_CPU_DIR, controlGroup, CPU_STATS_FILE)
+ );
+ return data
+ .toString()
+ .split(/\n/)
+ .reduce((acc, line) => {
+ const fields = line.split(/\s+/);
+
+ switch (fields[0]) {
+ case 'nr_periods':
+ acc.number_of_elapsed_periods = parseInt(fields[1], 10);
+ break;
+
+ case 'nr_throttled':
+ acc.number_of_times_throttled = parseInt(fields[1], 10);
+ break;
+
+ case 'throttled_time':
+ acc.time_throttled_nanos = parseInt(fields[1], 10);
+ break;
+ }
+
+ return acc;
+ }, stat);
+ } catch (err) {
+ if (err.code === 'ENOENT') {
+ return stat;
+ }
+
+ throw err;
+ }
+}
diff --git a/src/core/server/metrics/collectors/collector.mock.ts b/src/core/server/metrics/collectors/collector.mock.ts
new file mode 100644
index 0000000000000..2a942e1fafe63
--- /dev/null
+++ b/src/core/server/metrics/collectors/collector.mock.ts
@@ -0,0 +1,33 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { MetricsCollector } from './types';
+
+const createCollector = (collectReturnValue: any = {}): jest.Mocked> => {
+ const collector: jest.Mocked> = {
+ collect: jest.fn().mockResolvedValue(collectReturnValue),
+ reset: jest.fn(),
+ };
+
+ return collector;
+};
+
+export const metricsCollectorMock = {
+ create: createCollector,
+};
diff --git a/src/core/server/metrics/collectors/index.ts b/src/core/server/metrics/collectors/index.ts
index f58ab02e63881..4540cb79be74b 100644
--- a/src/core/server/metrics/collectors/index.ts
+++ b/src/core/server/metrics/collectors/index.ts
@@ -18,6 +18,6 @@
*/
export { OpsProcessMetrics, OpsOsMetrics, OpsServerMetrics, MetricsCollector } from './types';
-export { OsMetricsCollector } from './os';
+export { OsMetricsCollector, OpsMetricsCollectorOptions } from './os';
export { ProcessMetricsCollector } from './process';
export { ServerMetricsCollector } from './server';
diff --git a/src/core/server/saved_objects/schema/index.ts b/src/core/server/metrics/collectors/os.test.mocks.ts
similarity index 77%
rename from src/core/server/saved_objects/schema/index.ts
rename to src/core/server/metrics/collectors/os.test.mocks.ts
index d30bbb8d34cd3..ee02b8c802151 100644
--- a/src/core/server/saved_objects/schema/index.ts
+++ b/src/core/server/metrics/collectors/os.test.mocks.ts
@@ -17,4 +17,9 @@
* under the License.
*/
-export { SavedObjectsSchema, SavedObjectsSchemaDefinition } from './schema';
+import { metricsCollectorMock } from './collector.mock';
+
+export const cgroupCollectorMock = metricsCollectorMock.create();
+jest.doMock('./cgroup', () => ({
+ OsCgroupMetricsCollector: jest.fn(() => cgroupCollectorMock),
+}));
diff --git a/src/core/server/metrics/collectors/os.test.ts b/src/core/server/metrics/collectors/os.test.ts
index 7d5a6da90b7d6..5e52cecb76be3 100644
--- a/src/core/server/metrics/collectors/os.test.ts
+++ b/src/core/server/metrics/collectors/os.test.ts
@@ -20,6 +20,7 @@
jest.mock('getos', () => (cb: Function) => cb(null, { dist: 'distrib', release: 'release' }));
import os from 'os';
+import { cgroupCollectorMock } from './os.test.mocks';
import { OsMetricsCollector } from './os';
describe('OsMetricsCollector', () => {
@@ -27,6 +28,8 @@ describe('OsMetricsCollector', () => {
beforeEach(() => {
collector = new OsMetricsCollector();
+ cgroupCollectorMock.collect.mockReset();
+ cgroupCollectorMock.reset.mockReset();
});
afterEach(() => {
@@ -96,4 +99,9 @@ describe('OsMetricsCollector', () => {
'15m': fifteenMinLoad,
});
});
+
+ it('calls the cgroup sub-collector', async () => {
+ await collector.collect();
+ expect(cgroupCollectorMock.collect).toHaveBeenCalled();
+ });
});
diff --git a/src/core/server/metrics/collectors/os.ts b/src/core/server/metrics/collectors/os.ts
index 59bef9d8ddd2b..eae49278405a9 100644
--- a/src/core/server/metrics/collectors/os.ts
+++ b/src/core/server/metrics/collectors/os.ts
@@ -21,10 +21,22 @@ import os from 'os';
import getosAsync, { LinuxOs } from 'getos';
import { promisify } from 'util';
import { OpsOsMetrics, MetricsCollector } from './types';
+import { OsCgroupMetricsCollector } from './cgroup';
const getos = promisify(getosAsync);
+export interface OpsMetricsCollectorOptions {
+ cpuPath?: string;
+ cpuAcctPath?: string;
+}
+
export class OsMetricsCollector implements MetricsCollector {
+ private readonly cgroupCollector: OsCgroupMetricsCollector;
+
+ constructor(options: OpsMetricsCollectorOptions = {}) {
+ this.cgroupCollector = new OsCgroupMetricsCollector(options);
+ }
+
public async collect(): Promise {
const platform = os.platform();
const load = os.loadavg();
@@ -43,20 +55,30 @@ export class OsMetricsCollector implements MetricsCollector {
used_in_bytes: os.totalmem() - os.freemem(),
},
uptime_in_millis: os.uptime() * 1000,
+ ...(await this.getDistroStats(platform)),
+ ...(await this.cgroupCollector.collect()),
};
+ return metrics;
+ }
+
+ public reset() {}
+
+ private async getDistroStats(
+ platform: string
+ ): Promise> {
if (platform === 'linux') {
try {
const distro = (await getos()) as LinuxOs;
- metrics.distro = distro.dist;
- metrics.distroRelease = `${distro.dist}-${distro.release}`;
+ return {
+ distro: distro.dist,
+ distroRelease: `${distro.dist}-${distro.release}`,
+ };
} catch (e) {
// ignore errors
}
}
- return metrics;
+ return {};
}
-
- public reset() {}
}
diff --git a/src/core/server/metrics/collectors/types.ts b/src/core/server/metrics/collectors/types.ts
index 73e8975a6b362..77ea13a1f0787 100644
--- a/src/core/server/metrics/collectors/types.ts
+++ b/src/core/server/metrics/collectors/types.ts
@@ -85,6 +85,33 @@ export interface OpsOsMetrics {
};
/** the OS uptime */
uptime_in_millis: number;
+
+ /** cpu accounting metrics, undefined when not running in a cgroup */
+ cpuacct?: {
+ /** name of this process's cgroup */
+ control_group: string;
+ /** cpu time used by this process's cgroup */
+ usage_nanos: number;
+ };
+
+ /** cpu cgroup metrics, undefined when not running in a cgroup */
+ cpu?: {
+ /** name of this process's cgroup */
+ control_group: string;
+ /** the length of the cfs period */
+ cfs_period_micros: number;
+ /** total available run-time within a cfs period */
+ cfs_quota_micros: number;
+ /** current stats on the cfs periods */
+ stat: {
+ /** number of cfs periods that elapsed */
+ number_of_elapsed_periods: number;
+ /** number of times the cgroup has been throttled */
+ number_of_times_throttled: number;
+ /** total amount of time the cgroup has been throttled for */
+ time_throttled_nanos: number;
+ };
+ };
}
/**
diff --git a/src/core/server/metrics/metrics_service.mock.ts b/src/core/server/metrics/metrics_service.mock.ts
index 769f6ee2a549a..2af653004a479 100644
--- a/src/core/server/metrics/metrics_service.mock.ts
+++ b/src/core/server/metrics/metrics_service.mock.ts
@@ -21,20 +21,18 @@ import { MetricsService } from './metrics_service';
import {
InternalMetricsServiceSetup,
InternalMetricsServiceStart,
+ MetricsServiceSetup,
MetricsServiceStart,
} from './types';
const createInternalSetupContractMock = () => {
- const setupContract: jest.Mocked = {};
- return setupContract;
-};
-
-const createStartContractMock = () => {
- const startContract: jest.Mocked = {
+ const setupContract: jest.Mocked = {
+ collectionInterval: 30000,
getOpsMetrics$: jest.fn(),
};
- startContract.getOpsMetrics$.mockReturnValue(
+ setupContract.getOpsMetrics$.mockReturnValue(
new BehaviorSubject({
+ collected_at: new Date('2020-01-01 01:00:00'),
process: {
memory: {
heap: { total_in_bytes: 1, used_in_bytes: 1, size_limit: 1 },
@@ -56,11 +54,21 @@ const createStartContractMock = () => {
concurrent_connections: 1,
})
);
+ return setupContract;
+};
+
+const createSetupContractMock = () => {
+ const startContract: jest.Mocked = createInternalSetupContractMock();
return startContract;
};
const createInternalStartContractMock = () => {
- const startContract: jest.Mocked = createStartContractMock();
+ const startContract: jest.Mocked = createInternalSetupContractMock();
+ return startContract;
+};
+
+const createStartContractMock = () => {
+ const startContract: jest.Mocked = createInternalSetupContractMock();
return startContract;
};
@@ -77,7 +85,7 @@ const createMock = () => {
export const metricsServiceMock = {
create: createMock,
- createSetupContract: createStartContractMock,
+ createSetupContract: createSetupContractMock,
createStartContract: createStartContractMock,
createInternalSetupContract: createInternalSetupContractMock,
createInternalStartContract: createInternalStartContractMock,
diff --git a/src/core/server/metrics/metrics_service.ts b/src/core/server/metrics/metrics_service.ts
index f28fb21aaac0d..d4696b3aa9aaf 100644
--- a/src/core/server/metrics/metrics_service.ts
+++ b/src/core/server/metrics/metrics_service.ts
@@ -17,7 +17,7 @@
* under the License.
*/
-import { Subject } from 'rxjs';
+import { ReplaySubject } from 'rxjs';
import { first } from 'rxjs/operators';
import { CoreService } from '../../types';
import { CoreContext } from '../core_context';
@@ -37,26 +37,21 @@ export class MetricsService
private readonly logger: Logger;
private metricsCollector?: OpsMetricsCollector;
private collectInterval?: NodeJS.Timeout;
- private metrics$ = new Subject();
+ private metrics$ = new ReplaySubject();
+ private service?: InternalMetricsServiceSetup;
constructor(private readonly coreContext: CoreContext) {
this.logger = coreContext.logger.get('metrics');
}
public async setup({ http }: MetricsServiceSetupDeps): Promise {
- this.metricsCollector = new OpsMetricsCollector(http.server);
- return {};
- }
-
- public async start(): Promise {
- if (!this.metricsCollector) {
- throw new Error('#setup() needs to be run first');
- }
const config = await this.coreContext.configService
.atPath(opsConfig.path)
.pipe(first())
.toPromise();
+ this.metricsCollector = new OpsMetricsCollector(http.server, config.cGroupOverrides);
+
await this.refreshMetrics();
this.collectInterval = setInterval(() => {
@@ -65,9 +60,20 @@ export class MetricsService
const metricsObservable = this.metrics$.asObservable();
- return {
+ this.service = {
+ collectionInterval: config.interval.asMilliseconds(),
getOpsMetrics$: () => metricsObservable,
};
+
+ return this.service;
+ }
+
+ public async start(): Promise {
+ if (!this.service) {
+ throw new Error('#setup() needs to be run first');
+ }
+
+ return this.service;
}
private async refreshMetrics() {
diff --git a/src/core/server/metrics/ops_config.ts b/src/core/server/metrics/ops_config.ts
index bd6ae5cc5474d..5f3f67e931c38 100644
--- a/src/core/server/metrics/ops_config.ts
+++ b/src/core/server/metrics/ops_config.ts
@@ -23,6 +23,10 @@ export const opsConfig = {
path: 'ops',
schema: schema.object({
interval: schema.duration({ defaultValue: '5s' }),
+ cGroupOverrides: schema.object({
+ cpuPath: schema.maybe(schema.string()),
+ cpuAcctPath: schema.maybe(schema.string()),
+ }),
}),
};
diff --git a/src/core/server/metrics/ops_metrics_collector.test.ts b/src/core/server/metrics/ops_metrics_collector.test.ts
index 9e76895b14578..7aa3f7cd3baf0 100644
--- a/src/core/server/metrics/ops_metrics_collector.test.ts
+++ b/src/core/server/metrics/ops_metrics_collector.test.ts
@@ -30,7 +30,7 @@ describe('OpsMetricsCollector', () => {
beforeEach(() => {
const hapiServer = httpServiceMock.createInternalSetupContract().server;
- collector = new OpsMetricsCollector(hapiServer);
+ collector = new OpsMetricsCollector(hapiServer, {});
mockOsCollector.collect.mockResolvedValue('osMetrics');
});
@@ -51,6 +51,7 @@ describe('OpsMetricsCollector', () => {
expect(mockServerCollector.collect).toHaveBeenCalledTimes(1);
expect(metrics).toEqual({
+ collected_at: expect.any(Date),
process: 'processMetrics',
os: 'osMetrics',
requests: 'serverRequestsMetrics',
diff --git a/src/core/server/metrics/ops_metrics_collector.ts b/src/core/server/metrics/ops_metrics_collector.ts
index 525515dba1457..af74caa6cb386 100644
--- a/src/core/server/metrics/ops_metrics_collector.ts
+++ b/src/core/server/metrics/ops_metrics_collector.ts
@@ -21,6 +21,7 @@ import { Server as HapiServer } from 'hapi';
import {
ProcessMetricsCollector,
OsMetricsCollector,
+ OpsMetricsCollectorOptions,
ServerMetricsCollector,
MetricsCollector,
} from './collectors';
@@ -31,9 +32,9 @@ export class OpsMetricsCollector implements MetricsCollector {
private readonly osCollector: OsMetricsCollector;
private readonly serverCollector: ServerMetricsCollector;
- constructor(server: HapiServer) {
+ constructor(server: HapiServer, opsOptions: OpsMetricsCollectorOptions) {
this.processCollector = new ProcessMetricsCollector();
- this.osCollector = new OsMetricsCollector();
+ this.osCollector = new OsMetricsCollector(opsOptions);
this.serverCollector = new ServerMetricsCollector(server);
}
@@ -44,6 +45,7 @@ export class OpsMetricsCollector implements MetricsCollector {
this.serverCollector.collect(),
]);
return {
+ collected_at: new Date(),
process,
os,
...server,
diff --git a/src/core/server/metrics/types.ts b/src/core/server/metrics/types.ts
index cbf0acacd6bab..c177b3ed25115 100644
--- a/src/core/server/metrics/types.ts
+++ b/src/core/server/metrics/types.ts
@@ -20,14 +20,15 @@
import { Observable } from 'rxjs';
import { OpsProcessMetrics, OpsOsMetrics, OpsServerMetrics } from './collectors';
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MetricsServiceSetup {}
/**
* APIs to retrieves metrics gathered and exposed by the core platform.
*
* @public
*/
-export interface MetricsServiceStart {
+export interface MetricsServiceSetup {
+ /** Interval metrics are collected in milliseconds */
+ readonly collectionInterval: number;
+
/**
* Retrieve an observable emitting the {@link OpsMetrics} gathered.
* The observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time,
@@ -42,6 +43,12 @@ export interface MetricsServiceStart {
*/
getOpsMetrics$: () => Observable;
}
+/**
+ * {@inheritdoc MetricsServiceSetup}
+ *
+ * @public
+ */
+export type MetricsServiceStart = MetricsServiceSetup;
export type InternalMetricsServiceSetup = MetricsServiceSetup;
export type InternalMetricsServiceStart = MetricsServiceStart;
@@ -53,6 +60,8 @@ export type InternalMetricsServiceStart = MetricsServiceStart;
* @public
*/
export interface OpsMetrics {
+ /** Time metrics were recorded at. */
+ collected_at: Date;
/** Process related metrics */
process: OpsProcessMetrics;
/** OS related metrics */
diff --git a/src/core/server/plugins/plugin_context.ts b/src/core/server/plugins/plugin_context.ts
index fa2659ca130a0..af0b0e19b3227 100644
--- a/src/core/server/plugins/plugin_context.ts
+++ b/src/core/server/plugins/plugin_context.ts
@@ -185,6 +185,9 @@ export function createPluginSetupContext(
status: {
core$: deps.status.core$,
overall$: deps.status.overall$,
+ set: deps.status.plugins.set.bind(null, plugin.name),
+ dependencies$: deps.status.plugins.getDependenciesStatus$(plugin.name),
+ derivedStatus$: deps.status.plugins.getDerivedStatus$(plugin.name),
},
uiSettings: {
register: deps.uiSettings.register,
@@ -233,6 +236,7 @@ export function createPluginStartContext(
getTypeRegistry: deps.savedObjects.getTypeRegistry,
},
metrics: {
+ collectionInterval: deps.metrics.collectionInterval,
getOpsMetrics$: deps.metrics.getOpsMetrics$,
},
uiSettings: {
diff --git a/src/core/server/plugins/plugins_system.test.ts b/src/core/server/plugins/plugins_system.test.ts
index 7af77491df1ab..71ac31db13f92 100644
--- a/src/core/server/plugins/plugins_system.test.ts
+++ b/src/core/server/plugins/plugins_system.test.ts
@@ -100,15 +100,27 @@ test('getPluginDependencies returns dependency tree of symbols', () => {
pluginsSystem.addPlugin(createPlugin('no-dep'));
expect(pluginsSystem.getPluginDependencies()).toMatchInlineSnapshot(`
- Map {
- Symbol(plugin-a) => Array [
- Symbol(no-dep),
- ],
- Symbol(plugin-b) => Array [
- Symbol(plugin-a),
- Symbol(no-dep),
- ],
- Symbol(no-dep) => Array [],
+ Object {
+ "asNames": Map {
+ "plugin-a" => Array [
+ "no-dep",
+ ],
+ "plugin-b" => Array [
+ "plugin-a",
+ "no-dep",
+ ],
+ "no-dep" => Array [],
+ },
+ "asOpaqueIds": Map {
+ Symbol(plugin-a) => Array [
+ Symbol(no-dep),
+ ],
+ Symbol(plugin-b) => Array [
+ Symbol(plugin-a),
+ Symbol(no-dep),
+ ],
+ Symbol(no-dep) => Array [],
+ },
}
`);
});
diff --git a/src/core/server/plugins/plugins_system.ts b/src/core/server/plugins/plugins_system.ts
index f5c1b35d678a3..b2acd9a6fd04b 100644
--- a/src/core/server/plugins/plugins_system.ts
+++ b/src/core/server/plugins/plugins_system.ts
@@ -20,10 +20,11 @@
import { CoreContext } from '../core_context';
import { Logger } from '../logging';
import { PluginWrapper } from './plugin';
-import { DiscoveredPlugin, PluginName, PluginOpaqueId } from './types';
+import { DiscoveredPlugin, PluginName } from './types';
import { createPluginSetupContext, createPluginStartContext } from './plugin_context';
import { PluginsServiceSetupDeps, PluginsServiceStartDeps } from './plugins_service';
import { withTimeout } from '../../utils';
+import { PluginDependencies } from '.';
const Sec = 1000;
/** @internal */
@@ -45,9 +46,19 @@ export class PluginsSystem {
* @returns a ReadonlyMap of each plugin and an Array of its available dependencies
* @internal
*/
- public getPluginDependencies(): ReadonlyMap {
- // Return dependency map of opaque ids
- return new Map(
+ public getPluginDependencies(): PluginDependencies {
+ const asNames = new Map(
+ [...this.plugins].map(([name, plugin]) => [
+ plugin.name,
+ [
+ ...new Set([
+ ...plugin.requiredPlugins,
+ ...plugin.optionalPlugins.filter((optPlugin) => this.plugins.has(optPlugin)),
+ ]),
+ ].map((depId) => this.plugins.get(depId)!.name),
+ ])
+ );
+ const asOpaqueIds = new Map(
[...this.plugins].map(([name, plugin]) => [
plugin.opaqueId,
[
@@ -58,6 +69,8 @@ export class PluginsSystem {
].map((depId) => this.plugins.get(depId)!.opaqueId),
])
);
+
+ return { asNames, asOpaqueIds };
}
public async setupPlugins(deps: PluginsServiceSetupDeps) {
diff --git a/src/core/server/plugins/types.ts b/src/core/server/plugins/types.ts
index eb2a9ca3daf5f..517261b5bc9bb 100644
--- a/src/core/server/plugins/types.ts
+++ b/src/core/server/plugins/types.ts
@@ -93,6 +93,12 @@ export type PluginName = string;
/** @public */
export type PluginOpaqueId = symbol;
+/** @internal */
+export interface PluginDependencies {
+ asNames: ReadonlyMap;
+ asOpaqueIds: ReadonlyMap;
+}
+
/**
* Describes the set of required and optional properties plugin can define in its
* mandatory JSON manifest file.
diff --git a/src/core/server/saved_objects/__snapshots__/utils.test.ts.snap b/src/core/server/saved_objects/__snapshots__/utils.test.ts.snap
deleted file mode 100644
index 7cd0297e57857..0000000000000
--- a/src/core/server/saved_objects/__snapshots__/utils.test.ts.snap
+++ /dev/null
@@ -1,184 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`convertLegacyTypes converts the legacy mappings using default values if no schemas are specified 1`] = `
-Array [
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": undefined,
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldA": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeA",
- "namespaceType": "single",
- },
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": undefined,
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldB": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeB",
- "namespaceType": "single",
- },
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": undefined,
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldC": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeC",
- "namespaceType": "single",
- },
-]
-`;
-
-exports[`convertLegacyTypes merges everything when all are present 1`] = `
-Array [
- Object {
- "convertToAliasScript": undefined,
- "hidden": true,
- "indexPattern": "myIndex",
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldA": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {
- "1.0.0": [Function],
- "2.0.4": [Function],
- },
- "name": "typeA",
- "namespaceType": "agnostic",
- },
- Object {
- "convertToAliasScript": "some alias script",
- "hidden": false,
- "indexPattern": undefined,
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "anotherFieldB": Object {
- "type": "boolean",
- },
- "fieldB": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeB",
- "namespaceType": "single",
- },
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": undefined,
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldC": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {
- "1.5.3": [Function],
- },
- "name": "typeC",
- "namespaceType": "single",
- },
-]
-`;
-
-exports[`convertLegacyTypes merges the mappings and the schema to create the type when schema exists for the type 1`] = `
-Array [
- Object {
- "convertToAliasScript": undefined,
- "hidden": true,
- "indexPattern": "fooBar",
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldA": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeA",
- "namespaceType": "agnostic",
- },
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": "barBaz",
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldB": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeB",
- "namespaceType": "multiple",
- },
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": undefined,
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldC": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeC",
- "namespaceType": "single",
- },
- Object {
- "convertToAliasScript": undefined,
- "hidden": false,
- "indexPattern": "bazQux",
- "management": undefined,
- "mappings": Object {
- "properties": Object {
- "fieldD": Object {
- "type": "text",
- },
- },
- },
- "migrations": Object {},
- "name": "typeD",
- "namespaceType": "agnostic",
- },
-]
-`;
diff --git a/src/core/server/saved_objects/index.ts b/src/core/server/saved_objects/index.ts
index a294b28753f7b..f2bae29c4743b 100644
--- a/src/core/server/saved_objects/index.ts
+++ b/src/core/server/saved_objects/index.ts
@@ -19,8 +19,6 @@
export * from './service';
-export { SavedObjectsSchema } from './schema';
-
export * from './import';
export {
diff --git a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
index 4fc94d1992869..4cc4f696d307c 100644
--- a/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/core/document_migrator.test.ts
@@ -48,7 +48,6 @@ describe('DocumentMigrator', () => {
return {
kibanaVersion: '25.2.3',
typeRegistry: createRegistry(),
- validateDoc: _.noop,
log: mockLogger,
};
}
@@ -60,7 +59,6 @@ describe('DocumentMigrator', () => {
name: 'foo',
migrations: _.noop as any,
}),
- validateDoc: _.noop,
log: mockLogger,
};
expect(() => new DocumentMigrator(invalidDefinition)).toThrow(
@@ -77,7 +75,6 @@ describe('DocumentMigrator', () => {
bar: (doc) => doc,
},
}),
- validateDoc: _.noop,
log: mockLogger,
};
expect(() => new DocumentMigrator(invalidDefinition)).toThrow(
@@ -94,7 +91,6 @@ describe('DocumentMigrator', () => {
'1.2.3': 23 as any,
},
}),
- validateDoc: _.noop,
log: mockLogger,
};
expect(() => new DocumentMigrator(invalidDefinition)).toThrow(
@@ -633,27 +629,6 @@ describe('DocumentMigrator', () => {
bbb: '3.2.3',
});
});
-
- test('fails if the validate doc throws', () => {
- const migrator = new DocumentMigrator({
- ...testOpts(),
- typeRegistry: createRegistry({
- name: 'aaa',
- migrations: {
- '2.3.4': (d) => set(d, 'attributes.counter', 42),
- },
- }),
- validateDoc: (d) => {
- if ((d.attributes as any).counter === 42) {
- throw new Error('Meaningful!');
- }
- },
- });
-
- const doc = { id: '1', type: 'foo', attributes: {}, migrationVersion: {}, aaa: {} };
-
- expect(() => migrator.migrate(doc)).toThrow(/Meaningful/);
- });
});
function renameAttr(path: string, newPath: string) {
diff --git a/src/core/server/saved_objects/migrations/core/document_migrator.ts b/src/core/server/saved_objects/migrations/core/document_migrator.ts
index c50f755fda994..345704fbfd783 100644
--- a/src/core/server/saved_objects/migrations/core/document_migrator.ts
+++ b/src/core/server/saved_objects/migrations/core/document_migrator.ts
@@ -73,12 +73,9 @@ import { SavedObjectMigrationFn } from '../types';
export type TransformFn = (doc: SavedObjectUnsanitizedDoc) => SavedObjectUnsanitizedDoc;
-type ValidateDoc = (doc: SavedObjectUnsanitizedDoc) => void;
-
interface DocumentMigratorOptions {
kibanaVersion: string;
typeRegistry: ISavedObjectTypeRegistry;
- validateDoc: ValidateDoc;
log: Logger;
}
@@ -113,19 +110,16 @@ export class DocumentMigrator implements VersionedTransformer {
* @param {DocumentMigratorOptions} opts
* @prop {string} kibanaVersion - The current version of Kibana
* @prop {SavedObjectTypeRegistry} typeRegistry - The type registry to get type migrations from
- * @prop {ValidateDoc} validateDoc - A function which, given a document throws an error if it is
- * not up to date. This is used to ensure we don't let unmigrated documents slip through.
* @prop {Logger} log - The migration logger
* @memberof DocumentMigrator
*/
- constructor({ typeRegistry, kibanaVersion, log, validateDoc }: DocumentMigratorOptions) {
+ constructor({ typeRegistry, kibanaVersion, log }: DocumentMigratorOptions) {
validateMigrationDefinition(typeRegistry);
this.migrations = buildActiveMigrations(typeRegistry, log);
this.transformDoc = buildDocumentTransform({
kibanaVersion,
migrations: this.migrations,
- validateDoc,
});
}
@@ -231,21 +225,16 @@ function buildActiveMigrations(
* Creates a function which migrates and validates any document that is passed to it.
*/
function buildDocumentTransform({
- kibanaVersion,
migrations,
- validateDoc,
}: {
kibanaVersion: string;
migrations: ActiveMigrations;
- validateDoc: ValidateDoc;
}): TransformFn {
return function transformAndValidate(doc: SavedObjectUnsanitizedDoc) {
const result = doc.migrationVersion
? applyMigrations(doc, migrations)
: markAsUpToDate(doc, migrations);
- validateDoc(result);
-
// In order to keep tests a bit more stable, we won't
// tack on an empy migrationVersion to docs that have
// no migrations defined.
diff --git a/src/core/server/saved_objects/migrations/core/index_migrator.test.ts b/src/core/server/saved_objects/migrations/core/index_migrator.test.ts
index df89137a1d798..13f771c16bc67 100644
--- a/src/core/server/saved_objects/migrations/core/index_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/core/index_migrator.test.ts
@@ -369,6 +369,30 @@ describe('IndexMigrator', () => {
],
});
});
+
+ test('rejects when the migration function throws an error', async () => {
+ const { client } = testOpts;
+ const migrateDoc = jest.fn((doc: SavedObjectUnsanitizedDoc) => {
+ throw new Error('error migrating document');
+ });
+
+ testOpts.documentMigrator = {
+ migrationVersion: { foo: '1.2.3' },
+ migrate: migrateDoc,
+ };
+
+ withIndex(client, {
+ numOutOfDate: 1,
+ docs: [
+ [{ _id: 'foo:1', _source: { type: 'foo', foo: { name: 'Bar' } } }],
+ [{ _id: 'foo:2', _source: { type: 'foo', foo: { name: 'Baz' } } }],
+ ],
+ });
+
+ await expect(new IndexMigrator(testOpts).migrate()).rejects.toThrowErrorMatchingInlineSnapshot(
+ `"error migrating document"`
+ );
+ });
});
function withIndex(
diff --git a/src/core/server/saved_objects/migrations/core/migrate_raw_docs.test.ts b/src/core/server/saved_objects/migrations/core/migrate_raw_docs.test.ts
index 4c9d2e870a7bb..83dc042d2b96b 100644
--- a/src/core/server/saved_objects/migrations/core/migrate_raw_docs.test.ts
+++ b/src/core/server/saved_objects/migrations/core/migrate_raw_docs.test.ts
@@ -90,4 +90,18 @@ describe('migrateRawDocs', () => {
expect(logger.error).toBeCalledTimes(1);
});
+
+ test('rejects when the transform function throws an error', async () => {
+ const transform = jest.fn((doc: any) => {
+ throw new Error('error during transform');
+ });
+ await expect(
+ migrateRawDocs(
+ new SavedObjectsSerializer(new SavedObjectTypeRegistry()),
+ transform,
+ [{ _id: 'a:b', _source: { type: 'a', a: { name: 'AAA' } } }],
+ createSavedObjectsMigrationLoggerMock()
+ )
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`"error during transform"`);
+ });
});
diff --git a/src/core/server/saved_objects/migrations/core/migrate_raw_docs.ts b/src/core/server/saved_objects/migrations/core/migrate_raw_docs.ts
index 2bdf59d25dc74..5a5048d8ad88f 100644
--- a/src/core/server/saved_objects/migrations/core/migrate_raw_docs.ts
+++ b/src/core/server/saved_objects/migrations/core/migrate_raw_docs.ts
@@ -78,10 +78,14 @@ function transformNonBlocking(
): (doc: SavedObjectUnsanitizedDoc) => Promise {
// promises aren't enough to unblock the event loop
return (doc: SavedObjectUnsanitizedDoc) =>
- new Promise((resolve) => {
+ new Promise((resolve, reject) => {
// set immediate is though
setImmediate(() => {
- resolve(transform(doc));
+ try {
+ resolve(transform(doc));
+ } catch (e) {
+ reject(e);
+ }
});
});
}
diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
index cc443093e30a3..7eb2cfefe4620 100644
--- a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
+++ b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.test.ts
@@ -134,7 +134,6 @@ const mockOptions = () => {
const options: MockedOptions = {
logger: loggingSystemMock.create().get(),
kibanaVersion: '8.2.3',
- savedObjectValidations: {},
typeRegistry: createRegistry([
{
name: 'testtype',
diff --git a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.ts b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.ts
index 85b9099308807..18a385c6994b8 100644
--- a/src/core/server/saved_objects/migrations/kibana/kibana_migrator.ts
+++ b/src/core/server/saved_objects/migrations/kibana/kibana_migrator.ts
@@ -28,7 +28,6 @@ import { BehaviorSubject } from 'rxjs';
import { Logger } from '../../../logging';
import { IndexMapping, SavedObjectsTypeMappingDefinitions } from '../../mappings';
import { SavedObjectUnsanitizedDoc, SavedObjectsSerializer } from '../../serialization';
-import { docValidator, PropertyValidators } from '../../validation';
import { buildActiveMappings, IndexMigrator, MigrationResult, MigrationStatus } from '../core';
import { DocumentMigrator, VersionedTransformer } from '../core/document_migrator';
import { MigrationEsClient } from '../core/';
@@ -44,7 +43,6 @@ export interface KibanaMigratorOptions {
kibanaConfig: KibanaConfigType;
kibanaVersion: string;
logger: Logger;
- savedObjectValidations: PropertyValidators;
}
export type IKibanaMigrator = Pick;
@@ -80,7 +78,6 @@ export class KibanaMigrator {
typeRegistry,
kibanaConfig,
savedObjectsConfig,
- savedObjectValidations,
kibanaVersion,
logger,
}: KibanaMigratorOptions) {
@@ -94,7 +91,6 @@ export class KibanaMigrator {
this.documentMigrator = new DocumentMigrator({
kibanaVersion,
typeRegistry,
- validateDoc: docValidator(savedObjectValidations || {}),
log: this.log,
});
// Building the active mappings (and associated md5sums) is an expensive
@@ -124,9 +120,17 @@ export class KibanaMigrator {
Array<{ status: string }>
> {
if (this.migrationResult === undefined || rerun) {
- this.status$.next({ status: 'running' });
+ // Reruns are only used by CI / EsArchiver. Publishing status updates on reruns results in slowing down CI
+ // unnecessarily, so we skip it in this case.
+ if (!rerun) {
+ this.status$.next({ status: 'running' });
+ }
+
this.migrationResult = this.runMigrationsInternal().then((result) => {
- this.status$.next({ status: 'completed', result });
+ // Similar to above, don't publish status updates when rerunning in CI.
+ if (!rerun) {
+ this.status$.next({ status: 'completed', result });
+ }
return result;
});
}
diff --git a/src/core/server/saved_objects/saved_objects_service.mock.ts b/src/core/server/saved_objects/saved_objects_service.mock.ts
index 6f5ecb1eb464b..e3d44c20dd190 100644
--- a/src/core/server/saved_objects/saved_objects_service.mock.ts
+++ b/src/core/server/saved_objects/saved_objects_service.mock.ts
@@ -26,8 +26,7 @@ import {
SavedObjectsServiceSetup,
SavedObjectsServiceStart,
} from './saved_objects_service';
-import { mockKibanaMigrator } from './migrations/kibana/kibana_migrator.mock';
-import { savedObjectsClientProviderMock } from './service/lib/scoped_client_provider.mock';
+
import { savedObjectsRepositoryMock } from './service/lib/repository.mock';
import { savedObjectsClientMock } from './service/saved_objects_client.mock';
import { typeRegistryMock } from './saved_objects_type_registry.mock';
@@ -54,11 +53,7 @@ const createStartContractMock = () => {
};
const createInternalStartContractMock = () => {
- const internalStartContract: jest.Mocked = {
- ...createStartContractMock(),
- clientProvider: savedObjectsClientProviderMock.create(),
- migrator: mockKibanaMigrator.create(),
- };
+ const internalStartContract: jest.Mocked = createStartContractMock();
return internalStartContract;
};
diff --git a/src/core/server/saved_objects/saved_objects_service.test.ts b/src/core/server/saved_objects/saved_objects_service.test.ts
index 8df6a07318c45..d6b30889eba5f 100644
--- a/src/core/server/saved_objects/saved_objects_service.test.ts
+++ b/src/core/server/saved_objects/saved_objects_service.test.ts
@@ -33,7 +33,6 @@ import { Env } from '../config';
import { configServiceMock } from '../mocks';
import { elasticsearchServiceMock } from '../elasticsearch/elasticsearch_service.mock';
import { elasticsearchClientMock } from '../elasticsearch/client/mocks';
-import { legacyServiceMock } from '../legacy/legacy_service.mock';
import { httpServiceMock } from '../http/http_service.mock';
import { httpServerMock } from '../http/http_server.mocks';
import { SavedObjectsClientFactoryProvider } from './service/lib';
@@ -65,7 +64,6 @@ describe('SavedObjectsService', () => {
return {
http: httpServiceMock.createInternalSetupContract(),
elasticsearch: elasticsearchMock,
- legacyPlugins: legacyServiceMock.createDiscoverPlugins(),
};
};
@@ -239,8 +237,7 @@ describe('SavedObjectsService', () => {
await soService.setup(createSetupDeps());
expect(migratorInstanceMock.runMigrations).toHaveBeenCalledTimes(0);
- const startContract = await soService.start(createStartDeps());
- expect(startContract.migrator).toBe(migratorInstanceMock);
+ await soService.start(createStartDeps());
expect(migratorInstanceMock.runMigrations).toHaveBeenCalledTimes(1);
});
diff --git a/src/core/server/saved_objects/saved_objects_service.ts b/src/core/server/saved_objects/saved_objects_service.ts
index f05e912b12ad8..5cc59d55a254e 100644
--- a/src/core/server/saved_objects/saved_objects_service.ts
+++ b/src/core/server/saved_objects/saved_objects_service.ts
@@ -23,12 +23,10 @@ import { CoreService } from '../../types';
import {
SavedObjectsClient,
SavedObjectsClientProvider,
- ISavedObjectsClientProvider,
SavedObjectsClientProviderOptions,
} from './';
import { KibanaMigrator, IKibanaMigrator } from './migrations';
import { CoreContext } from '../core_context';
-import { LegacyServiceDiscoverPlugins } from '../legacy';
import {
ElasticsearchClient,
IClusterClient,
@@ -49,9 +47,7 @@ import {
SavedObjectsClientWrapperFactory,
} from './service/lib/scoped_client_provider';
import { Logger } from '../logging';
-import { convertLegacyTypes } from './utils';
import { SavedObjectTypeRegistry, ISavedObjectTypeRegistry } from './saved_objects_type_registry';
-import { PropertyValidators } from './validation';
import { SavedObjectsSerializer } from './serialization';
import { registerRoutes } from './routes';
import { ServiceStatus } from '../status';
@@ -67,9 +63,6 @@ import { createMigrationEsClient } from './migrations/core/';
* the factory provided to `setClientFactory` and wrapped by all wrappers
* registered through `addClientWrapper`.
*
- * All the setup APIs will throw if called after the service has started, and therefor cannot be used
- * from legacy plugin code. Legacy plugins should use the legacy savedObject service until migrated.
- *
* @example
* ```ts
* import { SavedObjectsClient, CoreSetup } from 'src/core/server';
@@ -155,9 +148,6 @@ export interface SavedObjectsServiceSetup {
* }
* }
* ```
- *
- * @remarks The type definition is an aggregation of the legacy savedObjects `schema`, `mappings` and `migration` concepts.
- * This API is the single entry point to register saved object types in the new platform.
*/
registerType: (type: SavedObjectsType) => void;
@@ -230,16 +220,7 @@ export interface SavedObjectsServiceStart {
getTypeRegistry: () => ISavedObjectTypeRegistry;
}
-export interface InternalSavedObjectsServiceStart extends SavedObjectsServiceStart {
- /**
- * @deprecated Exposed only for injecting into Legacy
- */
- migrator: IKibanaMigrator;
- /**
- * @deprecated Exposed only for injecting into Legacy
- */
- clientProvider: ISavedObjectsClientProvider;
-}
+export type InternalSavedObjectsServiceStart = SavedObjectsServiceStart;
/**
* Factory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}
@@ -271,7 +252,6 @@ export interface SavedObjectsRepositoryFactory {
/** @internal */
export interface SavedObjectsSetupDeps {
http: InternalHttpServiceSetup;
- legacyPlugins: LegacyServiceDiscoverPlugins;
elasticsearch: InternalElasticsearchServiceSetup;
}
@@ -296,9 +276,8 @@ export class SavedObjectsService
private clientFactoryProvider?: SavedObjectsClientFactoryProvider;
private clientFactoryWrappers: WrappedClientFactoryWrapper[] = [];
- private migrator$ = new Subject();
+ private migrator$ = new Subject();
private typeRegistry = new SavedObjectTypeRegistry();
- private validations: PropertyValidators = {};
private started = false;
constructor(private readonly coreContext: CoreContext) {
@@ -310,13 +289,6 @@ export class SavedObjectsService
this.setupDeps = setupDeps;
- const legacyTypes = convertLegacyTypes(
- setupDeps.legacyPlugins.uiExports,
- setupDeps.legacyPlugins.pluginExtendedConfig
- );
- legacyTypes.forEach((type) => this.typeRegistry.registerType(type));
- this.validations = setupDeps.legacyPlugins.uiExports.savedObjectValidations || {};
-
const savedObjectsConfig = await this.coreContext.configService
.atPath('savedObjects')
.pipe(first())
@@ -471,8 +443,6 @@ export class SavedObjectsService
this.started = true;
return {
- migrator,
- clientProvider,
getScopedClient: clientProvider.getClient.bind(clientProvider),
createScopedRepository: repositoryFactory.createScopedRepository,
createInternalRepository: repositoryFactory.createInternalRepository,
@@ -488,13 +458,12 @@ export class SavedObjectsService
savedObjectsConfig: SavedObjectsMigrationConfigType,
client: IClusterClient,
migrationsRetryDelay?: number
- ): KibanaMigrator {
+ ): IKibanaMigrator {
return new KibanaMigrator({
typeRegistry: this.typeRegistry,
logger: this.logger,
kibanaVersion: this.coreContext.env.packageInfo.version,
savedObjectsConfig,
- savedObjectValidations: this.validations,
kibanaConfig,
client: createMigrationEsClient(client.asInternalUser, this.logger, migrationsRetryDelay),
});
diff --git a/src/core/server/saved_objects/schema/schema.test.ts b/src/core/server/saved_objects/schema/schema.test.ts
deleted file mode 100644
index f2daa13e43fce..0000000000000
--- a/src/core/server/saved_objects/schema/schema.test.ts
+++ /dev/null
@@ -1,106 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { SavedObjectsSchema, SavedObjectsSchemaDefinition } from './schema';
-
-describe('#isNamespaceAgnostic', () => {
- const expectResult = (expected: boolean, schemaDefinition?: SavedObjectsSchemaDefinition) => {
- const schema = new SavedObjectsSchema(schemaDefinition);
- const result = schema.isNamespaceAgnostic('foo');
- expect(result).toBe(expected);
- };
-
- it(`returns false when no schema is defined`, () => {
- expectResult(false);
- });
-
- it(`returns false for unknown types`, () => {
- expectResult(false, { bar: {} });
- });
-
- it(`returns false for non-namespace-agnostic type`, () => {
- expectResult(false, { foo: { isNamespaceAgnostic: false } });
- expectResult(false, { foo: { isNamespaceAgnostic: undefined } });
- });
-
- it(`returns true for explicitly namespace-agnostic type`, () => {
- expectResult(true, { foo: { isNamespaceAgnostic: true } });
- });
-});
-
-describe('#isSingleNamespace', () => {
- const expectResult = (expected: boolean, schemaDefinition?: SavedObjectsSchemaDefinition) => {
- const schema = new SavedObjectsSchema(schemaDefinition);
- const result = schema.isSingleNamespace('foo');
- expect(result).toBe(expected);
- };
-
- it(`returns true when no schema is defined`, () => {
- expectResult(true);
- });
-
- it(`returns true for unknown types`, () => {
- expectResult(true, { bar: {} });
- });
-
- it(`returns false for explicitly namespace-agnostic type`, () => {
- expectResult(false, { foo: { isNamespaceAgnostic: true } });
- });
-
- it(`returns false for explicitly multi-namespace type`, () => {
- expectResult(false, { foo: { multiNamespace: true } });
- });
-
- it(`returns true for non-namespace-agnostic and non-multi-namespace type`, () => {
- expectResult(true, { foo: { isNamespaceAgnostic: false, multiNamespace: false } });
- expectResult(true, { foo: { isNamespaceAgnostic: false, multiNamespace: undefined } });
- expectResult(true, { foo: { isNamespaceAgnostic: undefined, multiNamespace: false } });
- expectResult(true, { foo: { isNamespaceAgnostic: undefined, multiNamespace: undefined } });
- });
-});
-
-describe('#isMultiNamespace', () => {
- const expectResult = (expected: boolean, schemaDefinition?: SavedObjectsSchemaDefinition) => {
- const schema = new SavedObjectsSchema(schemaDefinition);
- const result = schema.isMultiNamespace('foo');
- expect(result).toBe(expected);
- };
-
- it(`returns false when no schema is defined`, () => {
- expectResult(false);
- });
-
- it(`returns false for unknown types`, () => {
- expectResult(false, { bar: {} });
- });
-
- it(`returns false for explicitly namespace-agnostic type`, () => {
- expectResult(false, { foo: { isNamespaceAgnostic: true } });
- });
-
- it(`returns false for non-multi-namespace type`, () => {
- expectResult(false, { foo: { multiNamespace: false } });
- expectResult(false, { foo: { multiNamespace: undefined } });
- });
-
- it(`returns true for non-namespace-agnostic and explicitly multi-namespace type`, () => {
- expectResult(true, { foo: { isNamespaceAgnostic: false, multiNamespace: true } });
- expectResult(true, { foo: { isNamespaceAgnostic: undefined, multiNamespace: true } });
- });
-});
diff --git a/src/core/server/saved_objects/schema/schema.ts b/src/core/server/saved_objects/schema/schema.ts
deleted file mode 100644
index ba1905158e822..0000000000000
--- a/src/core/server/saved_objects/schema/schema.ts
+++ /dev/null
@@ -1,116 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { LegacyConfig } from '../../legacy';
-
-/**
- * @deprecated
- * @internal
- **/
-interface SavedObjectsSchemaTypeDefinition {
- isNamespaceAgnostic?: boolean;
- multiNamespace?: boolean;
- hidden?: boolean;
- indexPattern?: ((config: LegacyConfig) => string) | string;
- convertToAliasScript?: string;
-}
-
-/**
- * @deprecated
- * @internal
- **/
-export interface SavedObjectsSchemaDefinition {
- [type: string]: SavedObjectsSchemaTypeDefinition;
-}
-
-/**
- * @deprecated This is only used by the {@link SavedObjectsLegacyService | legacy savedObjects service}
- * @internal
- **/
-export class SavedObjectsSchema {
- private readonly definition?: SavedObjectsSchemaDefinition;
- constructor(schemaDefinition?: SavedObjectsSchemaDefinition) {
- this.definition = schemaDefinition;
- }
-
- public isHiddenType(type: string) {
- if (this.definition && this.definition.hasOwnProperty(type)) {
- return Boolean(this.definition[type].hidden);
- }
-
- return false;
- }
-
- public getIndexForType(config: LegacyConfig, type: string): string | undefined {
- if (this.definition != null && this.definition.hasOwnProperty(type)) {
- const { indexPattern } = this.definition[type];
- return typeof indexPattern === 'function' ? indexPattern(config) : indexPattern;
- } else {
- return undefined;
- }
- }
-
- public getConvertToAliasScript(type: string): string | undefined {
- if (this.definition != null && this.definition.hasOwnProperty(type)) {
- return this.definition[type].convertToAliasScript;
- }
- }
-
- public isNamespaceAgnostic(type: string) {
- // if no plugins have registered a Saved Objects Schema,
- // this.schema will be undefined, and no types are namespace agnostic
- if (!this.definition) {
- return false;
- }
-
- const typeSchema = this.definition[type];
- if (!typeSchema) {
- return false;
- }
- return Boolean(typeSchema.isNamespaceAgnostic);
- }
-
- public isSingleNamespace(type: string) {
- // if no plugins have registered a Saved Objects Schema,
- // this.schema will be undefined, and all types are namespace isolated
- if (!this.definition) {
- return true;
- }
-
- const typeSchema = this.definition[type];
- if (!typeSchema) {
- return true;
- }
- return !Boolean(typeSchema.isNamespaceAgnostic) && !Boolean(typeSchema.multiNamespace);
- }
-
- public isMultiNamespace(type: string) {
- // if no plugins have registered a Saved Objects Schema,
- // this.schema will be undefined, and no types are multi-namespace
- if (!this.definition) {
- return false;
- }
-
- const typeSchema = this.definition[type];
- if (!typeSchema) {
- return false;
- }
- return !Boolean(typeSchema.isNamespaceAgnostic) && Boolean(typeSchema.multiNamespace);
- }
-}
diff --git a/src/core/server/saved_objects/service/index.ts b/src/core/server/saved_objects/service/index.ts
index 9f625b4732e26..271d4dd67d43e 100644
--- a/src/core/server/saved_objects/service/index.ts
+++ b/src/core/server/saved_objects/service/index.ts
@@ -17,37 +17,6 @@
* under the License.
*/
-import { Readable } from 'stream';
-import { SavedObjectsClientProvider } from './lib';
-import { SavedObjectsClient } from './saved_objects_client';
-import { SavedObjectsExportOptions } from '../export';
-import { SavedObjectsImportOptions, SavedObjectsImportResponse } from '../import';
-import { SavedObjectsSchema } from '../schema';
-import { SavedObjectsResolveImportErrorsOptions } from '../import/types';
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectsLegacyService {
- // ATTENTION: these types are incomplete
- addScopedSavedObjectsClientWrapperFactory: SavedObjectsClientProvider['addClientWrapperFactory'];
- setScopedSavedObjectsClientFactory: SavedObjectsClientProvider['setClientFactory'];
- getScopedSavedObjectsClient: SavedObjectsClientProvider['getClient'];
- SavedObjectsClient: typeof SavedObjectsClient;
- types: string[];
- schema: SavedObjectsSchema;
- getSavedObjectsRepository(...rest: any[]): any;
- importExport: {
- objectLimit: number;
- importSavedObjects(options: SavedObjectsImportOptions): Promise;
- resolveImportErrors(
- options: SavedObjectsResolveImportErrorsOptions
- ): Promise;
- getSortedObjectsForExport(options: SavedObjectsExportOptions): Promise;
- };
-}
-
export {
SavedObjectsRepository,
SavedObjectsClientProvider,
diff --git a/src/core/server/saved_objects/service/lib/repository.test.js b/src/core/server/saved_objects/service/lib/repository.test.js
index b1d6028465713..f2e3b3e633cd6 100644
--- a/src/core/server/saved_objects/service/lib/repository.test.js
+++ b/src/core/server/saved_objects/service/lib/repository.test.js
@@ -153,7 +153,6 @@ describe('SavedObjectsRepository', () => {
typeRegistry: registry,
kibanaVersion: '2.0.0',
log: {},
- validateDoc: jest.fn(),
});
const getMockGetResponse = ({ type, id, references, namespace, originId }) => ({
diff --git a/src/core/server/saved_objects/service/lib/repository.ts b/src/core/server/saved_objects/service/lib/repository.ts
index dd25989725f3e..e3fb7d2306469 100644
--- a/src/core/server/saved_objects/service/lib/repository.ts
+++ b/src/core/server/saved_objects/service/lib/repository.ts
@@ -31,7 +31,7 @@ import { getSearchDsl } from './search_dsl';
import { includedFields } from './included_fields';
import { SavedObjectsErrorHelpers, DecoratedError } from './errors';
import { decodeRequestVersion, encodeVersion, encodeHitVersion } from '../../version';
-import { KibanaMigrator } from '../../migrations';
+import { IKibanaMigrator } from '../../migrations';
import {
SavedObjectsSerializer,
SavedObjectSanitizedDoc,
@@ -85,7 +85,7 @@ export interface SavedObjectsRepositoryOptions {
client: ElasticsearchClient;
typeRegistry: SavedObjectTypeRegistry;
serializer: SavedObjectsSerializer;
- migrator: KibanaMigrator;
+ migrator: IKibanaMigrator;
allowedTypes: string[];
}
@@ -120,7 +120,7 @@ export type ISavedObjectsRepository = Pick) => { path: string; uiCapabilitiesPath: string };
}
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectsLegacyUiExports {
- savedObjectMappings: SavedObjectsLegacyMapping[];
- savedObjectMigrations: SavedObjectsLegacyMigrationDefinitions;
- savedObjectSchemas: SavedObjectsLegacySchemaDefinitions;
- savedObjectValidations: PropertyValidators;
- savedObjectsManagement: SavedObjectsLegacyManagementDefinition;
-}
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectsLegacyMapping {
- pluginId: string;
- properties: SavedObjectsTypeMappingDefinitions;
-}
-
-/**
- * @internal
- * @deprecated Use {@link SavedObjectsTypeManagementDefinition | management definition} when registering
- * from new platform plugins
- */
-export interface SavedObjectsLegacyManagementDefinition {
- [key: string]: SavedObjectsLegacyManagementTypeDefinition;
-}
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectsLegacyManagementTypeDefinition {
- isImportableAndExportable?: boolean;
- defaultSearchField?: string;
- icon?: string;
- getTitle?: (savedObject: SavedObject) => string;
- getEditUrl?: (savedObject: SavedObject) => string;
- getInAppUrl?: (savedObject: SavedObject) => { path: string; uiCapabilitiesPath: string };
-}
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectsLegacyMigrationDefinitions {
- [type: string]: SavedObjectLegacyMigrationMap;
-}
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectLegacyMigrationMap {
- [version: string]: SavedObjectLegacyMigrationFn;
-}
-
-/**
- * @internal
- * @deprecated
- */
-export type SavedObjectLegacyMigrationFn = (
- doc: SavedObjectUnsanitizedDoc,
- log: SavedObjectsMigrationLogger
-) => SavedObjectUnsanitizedDoc;
-
-/**
- * @internal
- * @deprecated
- */
-interface SavedObjectsLegacyTypeSchema {
- isNamespaceAgnostic?: boolean;
- /** Cannot be used in conjunction with `isNamespaceAgnostic` */
- multiNamespace?: boolean;
- hidden?: boolean;
- indexPattern?: ((config: LegacyConfig) => string) | string;
- convertToAliasScript?: string;
-}
-
-/**
- * @internal
- * @deprecated
- */
-export interface SavedObjectsLegacySchemaDefinitions {
- [type: string]: SavedObjectsLegacyTypeSchema;
-}
diff --git a/src/core/server/saved_objects/utils.test.ts b/src/core/server/saved_objects/utils.test.ts
deleted file mode 100644
index 21229bee489c2..0000000000000
--- a/src/core/server/saved_objects/utils.test.ts
+++ /dev/null
@@ -1,445 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { legacyServiceMock } from '../legacy/legacy_service.mock';
-import { convertLegacyTypes, convertTypesToLegacySchema } from './utils';
-import { SavedObjectsLegacyUiExports, SavedObjectsType } from './types';
-import { LegacyConfig, SavedObjectMigrationContext } from 'kibana/server';
-import { SavedObjectUnsanitizedDoc } from './serialization';
-
-describe('convertLegacyTypes', () => {
- let legacyConfig: ReturnType;
-
- beforeEach(() => {
- legacyConfig = legacyServiceMock.createLegacyConfig();
- });
-
- it('converts the legacy mappings using default values if no schemas are specified', () => {
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- typeB: {
- properties: {
- fieldB: { type: 'text' },
- },
- },
- },
- },
- {
- pluginId: 'pluginB',
- properties: {
- typeC: {
- properties: {
- fieldC: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectMigrations: {},
- savedObjectSchemas: {},
- savedObjectValidations: {},
- savedObjectsManagement: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
- expect(converted).toMatchSnapshot();
- });
-
- it('merges the mappings and the schema to create the type when schema exists for the type', () => {
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- },
- },
- {
- pluginId: 'pluginB',
- properties: {
- typeB: {
- properties: {
- fieldB: { type: 'text' },
- },
- },
- },
- },
- {
- pluginId: 'pluginC',
- properties: {
- typeC: {
- properties: {
- fieldC: { type: 'text' },
- },
- },
- },
- },
- {
- pluginId: 'pluginD',
- properties: {
- typeD: {
- properties: {
- fieldD: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectMigrations: {},
- savedObjectSchemas: {
- typeA: {
- indexPattern: 'fooBar',
- hidden: true,
- isNamespaceAgnostic: true,
- },
- typeB: {
- indexPattern: 'barBaz',
- hidden: false,
- multiNamespace: true,
- },
- typeD: {
- indexPattern: 'bazQux',
- hidden: false,
- // if both isNamespaceAgnostic and multiNamespace are true, the resulting namespaceType is 'agnostic'
- isNamespaceAgnostic: true,
- multiNamespace: true,
- },
- },
- savedObjectValidations: {},
- savedObjectsManagement: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
- expect(converted).toMatchSnapshot();
- });
-
- it('invokes indexPattern to retrieve the index when it is a function', () => {
- const indexPatternAccessor: (config: LegacyConfig) => string = jest.fn((config) => {
- config.get('foo.bar');
- return 'myIndex';
- });
-
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectMigrations: {},
- savedObjectSchemas: {
- typeA: {
- indexPattern: indexPatternAccessor,
- hidden: true,
- isNamespaceAgnostic: true,
- },
- },
- savedObjectValidations: {},
- savedObjectsManagement: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
-
- expect(indexPatternAccessor).toHaveBeenCalledWith(legacyConfig);
- expect(legacyConfig.get).toHaveBeenCalledWith('foo.bar');
- expect(converted.length).toEqual(1);
- expect(converted[0].indexPattern).toEqual('myIndex');
- });
-
- it('import migrations from the uiExports', () => {
- const migrationsA = {
- '1.0.0': jest.fn(),
- '2.0.4': jest.fn(),
- };
- const migrationsB = {
- '1.5.3': jest.fn(),
- };
-
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- },
- },
- {
- pluginId: 'pluginB',
- properties: {
- typeB: {
- properties: {
- fieldC: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectMigrations: {
- typeA: migrationsA,
- typeB: migrationsB,
- },
- savedObjectSchemas: {},
- savedObjectValidations: {},
- savedObjectsManagement: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
- expect(converted.length).toEqual(2);
- expect(Object.keys(converted[0]!.migrations!)).toEqual(Object.keys(migrationsA));
- expect(Object.keys(converted[1]!.migrations!)).toEqual(Object.keys(migrationsB));
- });
-
- it('converts the migration to the new format', () => {
- const legacyMigration = jest.fn();
- const migrationsA = {
- '1.0.0': legacyMigration,
- };
-
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectMigrations: {
- typeA: migrationsA,
- },
- savedObjectSchemas: {},
- savedObjectValidations: {},
- savedObjectsManagement: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
- expect(Object.keys(converted[0]!.migrations!)).toEqual(['1.0.0']);
-
- const migration = converted[0]!.migrations!['1.0.0']!;
-
- const doc = {} as SavedObjectUnsanitizedDoc;
- const context = { log: {} } as SavedObjectMigrationContext;
- migration(doc, context);
-
- expect(legacyMigration).toHaveBeenCalledTimes(1);
- expect(legacyMigration).toHaveBeenCalledWith(doc, context.log);
- });
-
- it('imports type management information', () => {
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- },
- },
- {
- pluginId: 'pluginB',
- properties: {
- typeB: {
- properties: {
- fieldB: { type: 'text' },
- },
- },
- typeC: {
- properties: {
- fieldC: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectsManagement: {
- typeA: {
- isImportableAndExportable: true,
- icon: 'iconA',
- defaultSearchField: 'searchFieldA',
- getTitle: (savedObject) => savedObject.id,
- },
- typeB: {
- isImportableAndExportable: false,
- icon: 'iconB',
- getEditUrl: (savedObject) => `/some-url/${savedObject.id}`,
- getInAppUrl: (savedObject) => ({ path: 'path', uiCapabilitiesPath: 'ui-path' }),
- },
- },
- savedObjectMigrations: {},
- savedObjectSchemas: {},
- savedObjectValidations: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
- expect(converted.length).toEqual(3);
- const [typeA, typeB, typeC] = converted;
-
- expect(typeA.management).toEqual({
- importableAndExportable: true,
- icon: 'iconA',
- defaultSearchField: 'searchFieldA',
- getTitle: uiExports.savedObjectsManagement.typeA.getTitle,
- });
-
- expect(typeB.management).toEqual({
- importableAndExportable: false,
- icon: 'iconB',
- getEditUrl: uiExports.savedObjectsManagement.typeB.getEditUrl,
- getInAppUrl: uiExports.savedObjectsManagement.typeB.getInAppUrl,
- });
-
- expect(typeC.management).toBeUndefined();
- });
-
- it('merges everything when all are present', () => {
- const uiExports: SavedObjectsLegacyUiExports = {
- savedObjectMappings: [
- {
- pluginId: 'pluginA',
- properties: {
- typeA: {
- properties: {
- fieldA: { type: 'text' },
- },
- },
- typeB: {
- properties: {
- fieldB: { type: 'text' },
- anotherFieldB: { type: 'boolean' },
- },
- },
- },
- },
- {
- pluginId: 'pluginB',
- properties: {
- typeC: {
- properties: {
- fieldC: { type: 'text' },
- },
- },
- },
- },
- ],
- savedObjectMigrations: {
- typeA: {
- '1.0.0': jest.fn(),
- '2.0.4': jest.fn(),
- },
- typeC: {
- '1.5.3': jest.fn(),
- },
- },
- savedObjectSchemas: {
- typeA: {
- indexPattern: jest.fn((config) => {
- config.get('foo.bar');
- return 'myIndex';
- }),
- hidden: true,
- isNamespaceAgnostic: true,
- },
- typeB: {
- convertToAliasScript: 'some alias script',
- hidden: false,
- },
- },
- savedObjectValidations: {},
- savedObjectsManagement: {},
- };
-
- const converted = convertLegacyTypes(uiExports, legacyConfig);
- expect(converted).toMatchSnapshot();
- });
-});
-
-describe('convertTypesToLegacySchema', () => {
- it('converts types to the legacy schema format', () => {
- const types: SavedObjectsType[] = [
- {
- name: 'typeA',
- hidden: false,
- namespaceType: 'agnostic',
- mappings: { properties: {} },
- convertToAliasScript: 'some script',
- },
- {
- name: 'typeB',
- hidden: true,
- namespaceType: 'single',
- indexPattern: 'myIndex',
- mappings: { properties: {} },
- },
- {
- name: 'typeC',
- hidden: false,
- namespaceType: 'multiple',
- mappings: { properties: {} },
- },
- ];
- expect(convertTypesToLegacySchema(types)).toEqual({
- typeA: {
- hidden: false,
- isNamespaceAgnostic: true,
- multiNamespace: false,
- convertToAliasScript: 'some script',
- },
- typeB: {
- hidden: true,
- isNamespaceAgnostic: false,
- multiNamespace: false,
- indexPattern: 'myIndex',
- },
- typeC: {
- hidden: false,
- isNamespaceAgnostic: false,
- multiNamespace: true,
- },
- });
- });
-});
diff --git a/src/core/server/saved_objects/utils.ts b/src/core/server/saved_objects/utils.ts
deleted file mode 100644
index af7c08d1fbfcc..0000000000000
--- a/src/core/server/saved_objects/utils.ts
+++ /dev/null
@@ -1,117 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { LegacyConfig } from '../legacy';
-import { SavedObjectMigrationMap } from './migrations';
-import {
- SavedObjectsNamespaceType,
- SavedObjectsType,
- SavedObjectsLegacyUiExports,
- SavedObjectLegacyMigrationMap,
- SavedObjectsLegacyManagementTypeDefinition,
- SavedObjectsTypeManagementDefinition,
-} from './types';
-import { SavedObjectsSchemaDefinition } from './schema';
-
-/**
- * Converts the legacy savedObjects mappings, schema, and migrations
- * to actual {@link SavedObjectsType | saved object types}
- */
-export const convertLegacyTypes = (
- {
- savedObjectMappings = [],
- savedObjectMigrations = {},
- savedObjectSchemas = {},
- savedObjectsManagement = {},
- }: SavedObjectsLegacyUiExports,
- legacyConfig: LegacyConfig
-): SavedObjectsType[] => {
- return savedObjectMappings.reduce((types, { properties }) => {
- return [
- ...types,
- ...Object.entries(properties).map(([type, mappings]) => {
- const schema = savedObjectSchemas[type];
- const migrations = savedObjectMigrations[type];
- const management = savedObjectsManagement[type];
- const namespaceType = (schema?.isNamespaceAgnostic
- ? 'agnostic'
- : schema?.multiNamespace
- ? 'multiple'
- : 'single') as SavedObjectsNamespaceType;
- return {
- name: type,
- hidden: schema?.hidden ?? false,
- namespaceType,
- mappings,
- indexPattern:
- typeof schema?.indexPattern === 'function'
- ? schema.indexPattern(legacyConfig)
- : schema?.indexPattern,
- convertToAliasScript: schema?.convertToAliasScript,
- migrations: convertLegacyMigrations(migrations ?? {}),
- management: management ? convertLegacyTypeManagement(management) : undefined,
- };
- }),
- ];
- }, [] as SavedObjectsType[]);
-};
-
-/**
- * Convert {@link SavedObjectsType | saved object types} to the legacy {@link SavedObjectsSchemaDefinition | schema} format
- */
-export const convertTypesToLegacySchema = (
- types: SavedObjectsType[]
-): SavedObjectsSchemaDefinition => {
- return types.reduce((schema, type) => {
- return {
- ...schema,
- [type.name]: {
- isNamespaceAgnostic: type.namespaceType === 'agnostic',
- multiNamespace: type.namespaceType === 'multiple',
- hidden: type.hidden,
- indexPattern: type.indexPattern,
- convertToAliasScript: type.convertToAliasScript,
- },
- };
- }, {} as SavedObjectsSchemaDefinition);
-};
-
-const convertLegacyMigrations = (
- legacyMigrations: SavedObjectLegacyMigrationMap
-): SavedObjectMigrationMap => {
- return Object.entries(legacyMigrations).reduce((migrated, [version, migrationFn]) => {
- return {
- ...migrated,
- [version]: (doc, context) => migrationFn(doc, context.log),
- };
- }, {} as SavedObjectMigrationMap);
-};
-
-const convertLegacyTypeManagement = (
- legacyTypeManagement: SavedObjectsLegacyManagementTypeDefinition
-): SavedObjectsTypeManagementDefinition => {
- return {
- importableAndExportable: legacyTypeManagement.isImportableAndExportable,
- defaultSearchField: legacyTypeManagement.defaultSearchField,
- icon: legacyTypeManagement.icon,
- getTitle: legacyTypeManagement.getTitle,
- getEditUrl: legacyTypeManagement.getEditUrl,
- getInAppUrl: legacyTypeManagement.getInAppUrl,
- };
-};
diff --git a/src/core/server/saved_objects/validation/index.ts b/src/core/server/saved_objects/validation/index.ts
deleted file mode 100644
index b1b33f91d3fd4..0000000000000
--- a/src/core/server/saved_objects/validation/index.ts
+++ /dev/null
@@ -1,67 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-/*
- * This is the core logic for validating saved object properties. The saved object client
- * and migrations consume this in order to validate saved object documents prior to
- * persisting them.
- */
-
-interface SavedObjectDoc {
- type: string;
- [prop: string]: any;
-}
-
-/**
- * A dictionary of property name -> validation function. The property name
- * is generally the document's type (e.g. "dashboard"), but will also
- * match other properties.
- *
- * For example, the "acl" and "dashboard" validators both apply to the
- * following saved object: { type: "dashboard", attributes: {}, acl: "sdlaj3w" }
- *
- * @export
- * @interface Validators
- */
-export interface PropertyValidators {
- [prop: string]: ValidateDoc;
-}
-
-export type ValidateDoc = (doc: SavedObjectDoc) => void;
-
-/**
- * Creates a function which uses a dictionary of property validators to validate
- * individual saved object documents.
- *
- * @export
- * @param {Validators} validators
- * @param {SavedObjectDoc} doc
- */
-export function docValidator(validators: PropertyValidators = {}): ValidateDoc {
- return function validateDoc(doc: SavedObjectDoc) {
- Object.keys(doc)
- .concat(doc.type)
- .forEach((prop) => {
- const validator = validators[prop];
- if (validator) {
- validator(doc);
- }
- });
- };
-}
diff --git a/src/core/server/saved_objects/validation/readme.md b/src/core/server/saved_objects/validation/readme.md
deleted file mode 100644
index 3b9f17c37fd0b..0000000000000
--- a/src/core/server/saved_objects/validation/readme.md
+++ /dev/null
@@ -1,63 +0,0 @@
-# Saved Object Validations
-
-The saved object client supports validation of documents during create / bulkCreate operations.
-
-This allows us tighter control over what documents get written to the saved object index, and helps us keep the index in a healthy state.
-
-## Creating validations
-
-Plugin authors can write their own validations by adding a `validations` property to their uiExports. A validation is nothing more than a dictionary of `{[prop: string]: validationFunction}` where:
-
-* `prop` - a root-property on a saved object document
-* `validationFunction` - a function that takes a document and throws an error if it does not meet expectations.
-
-## Example
-
-```js
-// In myFanciPlugin...
-uiExports: {
- validations: {
- myProperty(doc) {
- if (doc.attributes.someField === undefined) {
- throw new Error(`Document ${doc.id} did not define "someField"`);
- }
- },
-
- someOtherProp(doc) {
- if (doc.attributes.counter < 0) {
- throw new Error(`Document ${doc.id} cannot have a negative counter.`);
- }
- },
- },
-},
-```
-
-In this example, `myFanciPlugin` defines validations for two properties: `myProperty` and `someOtherProp`.
-
-This means that no other plugin can define validations for myProperty or someOtherProp.
-
-The `myProperty` validation would run for any doc that has a `type="myProperty"` or for any doc that has a root-level property of `myProperty`. e.g. it would apply to all documents in the following array:
-
-```js
-[
- {
- type: 'foo',
- attributes: { stuff: 'here' },
- myProperty: 'shazm!',
- },
- {
- type: 'myProperty',
- attributes: { shazm: true },
- },
-];
-```
-
-Validating properties other than just 'type' allows us to support potential future saved object scenarios in which plugins might want to annotate other plugin documents, such as a security plugin adding an acl to another document:
-
-```js
-{
- type: 'dashboard',
- attributes: { stuff: 'here' },
- acl: '342343',
-}
-```
diff --git a/src/core/server/saved_objects/validation/validation.test.ts b/src/core/server/saved_objects/validation/validation.test.ts
deleted file mode 100644
index 71e220280ba5f..0000000000000
--- a/src/core/server/saved_objects/validation/validation.test.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { docValidator } from './index';
-
-describe('docValidator', () => {
- test('does not run validators that have no application to the doc', () => {
- const validators = {
- foo: () => {
- throw new Error('Boom!');
- },
- };
- expect(() => docValidator(validators)({ type: 'shoo', bar: 'hi' })).not.toThrow();
- });
-
- test('validates the doc type', () => {
- const validators = {
- foo: () => {
- throw new Error('Boom!');
- },
- };
- expect(() => docValidator(validators)({ type: 'foo' })).toThrow(/Boom!/);
- });
-
- test('validates various props', () => {
- const validators = {
- a: jest.fn(),
- b: jest.fn(),
- c: jest.fn(),
- };
- docValidator(validators)({ type: 'a', b: 'foo' });
-
- expect(validators.c).not.toHaveBeenCalled();
-
- expect(validators.a.mock.calls).toEqual([[{ type: 'a', b: 'foo' }]]);
- expect(validators.b.mock.calls).toEqual([[{ type: 'a', b: 'foo' }]]);
- });
-});
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
index 081554cd17f25..aef1bda9ccf4e 100644
--- a/src/core/server/server.api.md
+++ b/src/core/server/server.api.md
@@ -1411,19 +1411,30 @@ export interface LegacyServiceStartDeps {
plugins: Record;
}
-// Warning: (ae-forgotten-export) The symbol "SavedObjectsLegacyUiExports" needs to be exported by the entry point index.d.ts
-//
// @internal @deprecated (undocumented)
-export type LegacyUiExports = SavedObjectsLegacyUiExports & {
+export interface LegacyUiExports {
+ // Warning: (ae-forgotten-export) The symbol "VarsProvider" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
defaultInjectedVarProviders?: VarsProvider[];
+ // Warning: (ae-forgotten-export) The symbol "VarsReplacer" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
injectedVarsReplacers?: VarsReplacer[];
+ // Warning: (ae-forgotten-export) The symbol "LegacyNavLinkSpec" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
navLinkSpecs?: LegacyNavLinkSpec[] | null;
+ // Warning: (ae-forgotten-export) The symbol "LegacyAppSpec" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
uiAppSpecs?: Array;
+ // (undocumented)
unknown?: [{
pluginSpec: LegacyPluginSpec;
type: unknown;
}];
-};
+}
// Warning: (ae-forgotten-export) The symbol "lifecycleResponseFactory" needs to be exported by the entry point index.d.ts
//
@@ -1520,10 +1531,10 @@ export interface LogRecord {
timestamp: Date;
}
-// Warning: (ae-missing-release-tag) "MetricsServiceSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
export interface MetricsServiceSetup {
+ readonly collectionInterval: number;
+ getOpsMetrics$: () => Observable;
}
// @public @deprecated (undocumented)
@@ -1610,6 +1621,7 @@ export interface OnPreRoutingToolkit {
// @public
export interface OpsMetrics {
+ collected_at: Date;
concurrent_connections: OpsServerMetrics['concurrent_connections'];
os: OpsOsMetrics;
process: OpsProcessMetrics;
@@ -1619,6 +1631,20 @@ export interface OpsMetrics {
// @public
export interface OpsOsMetrics {
+ cpu?: {
+ control_group: string;
+ cfs_period_micros: number;
+ cfs_quota_micros: number;
+ stat: {
+ number_of_elapsed_periods: number;
+ number_of_times_throttled: number;
+ time_throttled_nanos: number;
+ };
+ };
+ cpuacct?: {
+ control_group: string;
+ usage_nanos: number;
+ };
distro?: string;
distroRelease?: string;
load: {
@@ -2437,33 +2463,6 @@ export interface SavedObjectsIncrementCounterOptions extends SavedObjectsBaseOpt
refresh?: MutatingOperationRefreshSetting;
}
-// @internal @deprecated (undocumented)
-export interface SavedObjectsLegacyService {
- // Warning: (ae-forgotten-export) The symbol "SavedObjectsClientProvider" needs to be exported by the entry point index.d.ts
- //
- // (undocumented)
- addScopedSavedObjectsClientWrapperFactory: SavedObjectsClientProvider['addClientWrapperFactory'];
- // (undocumented)
- getSavedObjectsRepository(...rest: any[]): any;
- // (undocumented)
- getScopedSavedObjectsClient: SavedObjectsClientProvider['getClient'];
- // (undocumented)
- importExport: {
- objectLimit: number;
- importSavedObjects(options: SavedObjectsImportOptions): Promise;
- resolveImportErrors(options: SavedObjectsResolveImportErrorsOptions): Promise;
- getSortedObjectsForExport(options: SavedObjectsExportOptions): Promise;
- };
- // (undocumented)
- SavedObjectsClient: typeof SavedObjectsClient;
- // (undocumented)
- schema: SavedObjectsSchema;
- // (undocumented)
- setScopedSavedObjectsClientFactory: SavedObjectsClientProvider['setClientFactory'];
- // (undocumented)
- types: string[];
-}
-
// @public
export interface SavedObjectsMappingProperties {
// (undocumented)
@@ -2517,10 +2516,10 @@ export class SavedObjectsRepository {
bulkUpdate(objects: Array>, options?: SavedObjectsBulkUpdateOptions): Promise>;
checkConflicts(objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions): Promise;
create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>;
- // Warning: (ae-forgotten-export) The symbol "KibanaMigrator" needs to be exported by the entry point index.d.ts
+ // Warning: (ae-forgotten-export) The symbol "IKibanaMigrator" needs to be exported by the entry point index.d.ts
//
// @internal
- static createRepository(migrator: KibanaMigrator, typeRegistry: SavedObjectTypeRegistry, indexName: string, client: ElasticsearchClient, includedHiddenTypes?: string[], injectedConstructor?: any): ISavedObjectsRepository;
+ static createRepository(migrator: IKibanaMigrator, typeRegistry: SavedObjectTypeRegistry, indexName: string, client: ElasticsearchClient, includedHiddenTypes?: string[], injectedConstructor?: any): ISavedObjectsRepository;
delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>;
deleteByNamespace(namespace: string, options?: SavedObjectsDeleteByNamespaceOptions): Promise;
deleteFromNamespaces(type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions): Promise;
@@ -2548,24 +2547,6 @@ export interface SavedObjectsResolveImportErrorsOptions {
typeRegistry: ISavedObjectTypeRegistry;
}
-// @internal @deprecated (undocumented)
-export class SavedObjectsSchema {
- // Warning: (ae-forgotten-export) The symbol "SavedObjectsSchemaDefinition" needs to be exported by the entry point index.d.ts
- constructor(schemaDefinition?: SavedObjectsSchemaDefinition);
- // (undocumented)
- getConvertToAliasScript(type: string): string | undefined;
- // (undocumented)
- getIndexForType(config: LegacyConfig, type: string): string | undefined;
- // (undocumented)
- isHiddenType(type: string): boolean;
- // (undocumented)
- isMultiNamespace(type: string): boolean;
- // (undocumented)
- isNamespaceAgnostic(type: string): boolean;
- // (undocumented)
- isSingleNamespace(type: string): boolean;
-}
-
// @public
export class SavedObjectsSerializer {
// @internal
@@ -2797,10 +2778,17 @@ export type SharedGlobalConfig = RecursiveReadonly<{
// @public
export type StartServicesAccessor = () => Promise<[CoreStart, TPluginsStart, TStart]>;
+// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "ServiceStatusSetup"
+// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "ServiceStatusSetup"
+//
// @public
export interface StatusServiceSetup {
core$: Observable;
+ dependencies$: Observable>;
+ // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "StatusSetup"
+ derivedStatus$: Observable;
overall$: Observable;
+ set(status$: Observable): void;
}
// @public
@@ -2888,13 +2876,9 @@ export const validBodyOutput: readonly ["data", "stream"];
// Warnings were encountered during analysis:
//
// src/core/server/http/router/response.ts:316:3 - (ae-forgotten-export) The symbol "KibanaResponse" needs to be exported by the entry point index.d.ts
-// src/core/server/legacy/types.ts:132:3 - (ae-forgotten-export) The symbol "VarsProvider" needs to be exported by the entry point index.d.ts
-// src/core/server/legacy/types.ts:133:3 - (ae-forgotten-export) The symbol "VarsReplacer" needs to be exported by the entry point index.d.ts
-// src/core/server/legacy/types.ts:134:3 - (ae-forgotten-export) The symbol "LegacyNavLinkSpec" needs to be exported by the entry point index.d.ts
-// src/core/server/legacy/types.ts:135:3 - (ae-forgotten-export) The symbol "LegacyAppSpec" needs to be exported by the entry point index.d.ts
-// src/core/server/legacy/types.ts:136:16 - (ae-forgotten-export) The symbol "LegacyPluginSpec" needs to be exported by the entry point index.d.ts
-// src/core/server/plugins/types.ts:266:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts
-// src/core/server/plugins/types.ts:266:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts
-// src/core/server/plugins/types.ts:268:3 - (ae-forgotten-export) The symbol "PathConfigType" needs to be exported by the entry point index.d.ts
+// src/core/server/legacy/types.ts:135:16 - (ae-forgotten-export) The symbol "LegacyPluginSpec" needs to be exported by the entry point index.d.ts
+// src/core/server/plugins/types.ts:272:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts
+// src/core/server/plugins/types.ts:272:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts
+// src/core/server/plugins/types.ts:274:3 - (ae-forgotten-export) The symbol "PathConfigType" needs to be exported by the entry point index.d.ts
```
diff --git a/src/core/server/server.test.ts b/src/core/server/server.test.ts
index 417f66a2988c2..8bf16d9130ef5 100644
--- a/src/core/server/server.test.ts
+++ b/src/core/server/server.test.ts
@@ -49,7 +49,7 @@ const rawConfigService = rawConfigServiceMock.create({});
beforeEach(() => {
mockConfigService.atPath.mockReturnValue(new BehaviorSubject({ autoListen: true }));
mockPluginsService.discover.mockResolvedValue({
- pluginTree: new Map(),
+ pluginTree: { asOpaqueIds: new Map(), asNames: new Map() },
uiPlugins: { internal: new Map(), public: new Map(), browserConfigs: new Map() },
});
});
@@ -98,7 +98,7 @@ test('injects legacy dependency to context#setup()', async () => {
[pluginB, [pluginA]],
]);
mockPluginsService.discover.mockResolvedValue({
- pluginTree: pluginDependencies,
+ pluginTree: { asOpaqueIds: pluginDependencies, asNames: new Map() },
uiPlugins: { internal: new Map(), public: new Map(), browserConfigs: new Map() },
});
diff --git a/src/core/server/server.ts b/src/core/server/server.ts
index cc6d8171e7a03..a02b0f51b559f 100644
--- a/src/core/server/server.ts
+++ b/src/core/server/server.ts
@@ -121,10 +121,13 @@ export class Server {
const contextServiceSetup = this.context.setup({
// We inject a fake "legacy plugin" with dependencies on every plugin so that legacy plugins:
- // 1) Can access context from any NP plugin
+ // 1) Can access context from any KP plugin
// 2) Can register context providers that will only be available to other legacy plugins and will not leak into
// New Platform plugins.
- pluginDependencies: new Map([...pluginTree, [this.legacy.legacyId, [...pluginTree.keys()]]]),
+ pluginDependencies: new Map([
+ ...pluginTree.asOpaqueIds,
+ [this.legacy.legacyId, [...pluginTree.asOpaqueIds.keys()]],
+ ]),
});
const auditTrailSetup = this.auditTrail.setup();
@@ -142,7 +145,6 @@ export class Server {
const savedObjectsSetup = await this.savedObjects.setup({
http: httpSetup,
elasticsearch: elasticsearchServiceSetup,
- legacyPlugins,
});
const uiSettingsSetup = await this.uiSettings.setup({
@@ -154,6 +156,7 @@ export class Server {
const statusSetup = await this.status.setup({
elasticsearch: elasticsearchServiceSetup,
+ pluginDependencies: pluginTree.asNames,
savedObjects: savedObjectsSetup,
});
diff --git a/src/core/server/status/get_summary_status.test.ts b/src/core/server/status/get_summary_status.test.ts
index 7516e82ee784d..d97083162b502 100644
--- a/src/core/server/status/get_summary_status.test.ts
+++ b/src/core/server/status/get_summary_status.test.ts
@@ -94,6 +94,38 @@ describe('getSummaryStatus', () => {
describe('summary', () => {
describe('when a single service is at highest level', () => {
it('returns all information about that single service', () => {
+ expect(
+ getSummaryStatus(
+ Object.entries({
+ s1: degraded,
+ s2: {
+ level: ServiceStatusLevels.unavailable,
+ summary: 'Lorem ipsum',
+ meta: {
+ custom: { data: 'here' },
+ },
+ },
+ })
+ )
+ ).toEqual({
+ level: ServiceStatusLevels.unavailable,
+ summary: '[s2]: Lorem ipsum',
+ detail: 'See the status page for more information',
+ meta: {
+ affectedServices: {
+ s2: {
+ level: ServiceStatusLevels.unavailable,
+ summary: 'Lorem ipsum',
+ meta: {
+ custom: { data: 'here' },
+ },
+ },
+ },
+ },
+ });
+ });
+
+ it('allows the single service to override the detail and documentationUrl fields', () => {
expect(
getSummaryStatus(
Object.entries({
@@ -115,7 +147,17 @@ describe('getSummaryStatus', () => {
detail: 'Vivamus pulvinar sem ac luctus ultrices.',
documentationUrl: 'http://helpmenow.com/problem1',
meta: {
- custom: { data: 'here' },
+ affectedServices: {
+ s2: {
+ level: ServiceStatusLevels.unavailable,
+ summary: 'Lorem ipsum',
+ detail: 'Vivamus pulvinar sem ac luctus ultrices.',
+ documentationUrl: 'http://helpmenow.com/problem1',
+ meta: {
+ custom: { data: 'here' },
+ },
+ },
+ },
},
});
});
diff --git a/src/core/server/status/get_summary_status.ts b/src/core/server/status/get_summary_status.ts
index 748a54f0bf8bb..8d97cdbd9b15b 100644
--- a/src/core/server/status/get_summary_status.ts
+++ b/src/core/server/status/get_summary_status.ts
@@ -23,62 +23,60 @@ import { ServiceStatus, ServiceStatusLevels, ServiceStatusLevel } from './types'
* Returns a single {@link ServiceStatus} that summarizes the most severe status level from a group of statuses.
* @param statuses
*/
-export const getSummaryStatus = (statuses: Array<[string, ServiceStatus]>): ServiceStatus => {
- const grouped = groupByLevel(statuses);
- const highestSeverityLevel = getHighestSeverityLevel(grouped.keys());
- const highestSeverityGroup = grouped.get(highestSeverityLevel)!;
+export const getSummaryStatus = (
+ statuses: Array<[string, ServiceStatus]>,
+ { allAvailableSummary = `All services are available` }: { allAvailableSummary?: string } = {}
+): ServiceStatus => {
+ const { highestLevel, highestStatuses } = highestLevelSummary(statuses);
- if (highestSeverityLevel === ServiceStatusLevels.available) {
+ if (highestLevel === ServiceStatusLevels.available) {
return {
level: ServiceStatusLevels.available,
- summary: `All services are available`,
+ summary: allAvailableSummary,
};
- } else if (highestSeverityGroup.size === 1) {
- const [serviceName, status] = [...highestSeverityGroup.entries()][0];
+ } else if (highestStatuses.length === 1) {
+ const [serviceName, status] = highestStatuses[0]! as [string, ServiceStatus];
return {
...status,
summary: `[${serviceName}]: ${status.summary!}`,
+ // TODO: include URL to status page
+ detail: status.detail ?? `See the status page for more information`,
+ meta: {
+ affectedServices: { [serviceName]: status },
+ },
};
} else {
return {
- level: highestSeverityLevel,
- summary: `[${highestSeverityGroup.size}] services are ${highestSeverityLevel.toString()}`,
+ level: highestLevel,
+ summary: `[${highestStatuses.length}] services are ${highestLevel.toString()}`,
// TODO: include URL to status page
detail: `See the status page for more information`,
meta: {
- affectedServices: Object.fromEntries([...highestSeverityGroup]),
+ affectedServices: Object.fromEntries(highestStatuses),
},
};
}
};
-const groupByLevel = (
- statuses: Array<[string, ServiceStatus]>
-): Map> => {
- const byLevel = new Map>();
+type StatusPair = [string, ServiceStatus];
- for (const [serviceName, status] of statuses) {
- let levelMap = byLevel.get(status.level);
- if (!levelMap) {
- levelMap = new Map();
- byLevel.set(status.level, levelMap);
- }
+const highestLevelSummary = (
+ statuses: StatusPair[]
+): { highestLevel: ServiceStatusLevel; highestStatuses: StatusPair[] } => {
+ let highestLevel: ServiceStatusLevel = ServiceStatusLevels.available;
+ let highestStatuses: StatusPair[] = [];
- levelMap.set(serviceName, status);
+ for (const pair of statuses) {
+ if (pair[1].level === highestLevel) {
+ highestStatuses.push(pair);
+ } else if (pair[1].level > highestLevel) {
+ highestLevel = pair[1].level;
+ highestStatuses = [pair];
+ }
}
- return byLevel;
-};
-
-const getHighestSeverityLevel = (levels: Iterable): ServiceStatusLevel => {
- const sorted = [...levels].sort((a, b) => {
- if (a < b) {
- return -1;
- } else if (a > b) {
- return 1;
- } else {
- return 0;
- }
- });
- return sorted[sorted.length - 1] ?? ServiceStatusLevels.available;
+ return {
+ highestLevel,
+ highestStatuses,
+ };
};
diff --git a/src/core/server/status/plugins_status.test.ts b/src/core/server/status/plugins_status.test.ts
new file mode 100644
index 0000000000000..a75dc8c283698
--- /dev/null
+++ b/src/core/server/status/plugins_status.test.ts
@@ -0,0 +1,338 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { PluginName } from '../plugins';
+import { PluginsStatusService } from './plugins_status';
+import { of, Observable, BehaviorSubject } from 'rxjs';
+import { ServiceStatusLevels, CoreStatus, ServiceStatus } from './types';
+import { first } from 'rxjs/operators';
+import { ServiceStatusLevelSnapshotSerializer } from './test_utils';
+
+expect.addSnapshotSerializer(ServiceStatusLevelSnapshotSerializer);
+
+describe('PluginStatusService', () => {
+ const coreAllAvailable$: Observable = of({
+ elasticsearch: { level: ServiceStatusLevels.available, summary: 'elasticsearch avail' },
+ savedObjects: { level: ServiceStatusLevels.available, summary: 'savedObjects avail' },
+ });
+ const coreOneDegraded$: Observable = of({
+ elasticsearch: { level: ServiceStatusLevels.available, summary: 'elasticsearch avail' },
+ savedObjects: { level: ServiceStatusLevels.degraded, summary: 'savedObjects degraded' },
+ });
+ const coreOneCriticalOneDegraded$: Observable = of({
+ elasticsearch: { level: ServiceStatusLevels.critical, summary: 'elasticsearch critical' },
+ savedObjects: { level: ServiceStatusLevels.degraded, summary: 'savedObjects degraded' },
+ });
+ const pluginDependencies: Map = new Map([
+ ['a', []],
+ ['b', ['a']],
+ ['c', ['a', 'b']],
+ ]);
+
+ describe('getDerivedStatus$', () => {
+ it(`defaults to core's most severe status`, async () => {
+ const serviceAvailable = new PluginsStatusService({
+ core$: coreAllAvailable$,
+ pluginDependencies,
+ });
+ expect(await serviceAvailable.getDerivedStatus$('a').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.available,
+ summary: 'All dependencies are available',
+ });
+
+ const serviceDegraded = new PluginsStatusService({
+ core$: coreOneDegraded$,
+ pluginDependencies,
+ });
+ expect(await serviceDegraded.getDerivedStatus$('a').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.degraded,
+ summary: '[savedObjects]: savedObjects degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ });
+
+ const serviceCritical = new PluginsStatusService({
+ core$: coreOneCriticalOneDegraded$,
+ pluginDependencies,
+ });
+ expect(await serviceCritical.getDerivedStatus$('a').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.critical,
+ summary: '[elasticsearch]: elasticsearch critical',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ });
+ });
+
+ it(`provides a summary status when core and dependencies are at same severity level`, async () => {
+ const service = new PluginsStatusService({ core$: coreOneDegraded$, pluginDependencies });
+ service.set('a', of({ level: ServiceStatusLevels.degraded, summary: 'a is degraded' }));
+ expect(await service.getDerivedStatus$('b').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.degraded,
+ summary: '[2] services are degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ });
+ });
+
+ it(`allows dependencies status to take precedence over lower severity core statuses`, async () => {
+ const service = new PluginsStatusService({ core$: coreOneDegraded$, pluginDependencies });
+ service.set('a', of({ level: ServiceStatusLevels.unavailable, summary: 'a is not working' }));
+ expect(await service.getDerivedStatus$('b').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.unavailable,
+ summary: '[a]: a is not working',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ });
+ });
+
+ it(`allows core status to take precedence over lower severity dependencies statuses`, async () => {
+ const service = new PluginsStatusService({
+ core$: coreOneCriticalOneDegraded$,
+ pluginDependencies,
+ });
+ service.set('a', of({ level: ServiceStatusLevels.unavailable, summary: 'a is not working' }));
+ expect(await service.getDerivedStatus$('b').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.critical,
+ summary: '[elasticsearch]: elasticsearch critical',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ });
+ });
+
+ it(`allows a severe dependency status to take precedence over a less severe dependency status`, async () => {
+ const service = new PluginsStatusService({ core$: coreOneDegraded$, pluginDependencies });
+ service.set('a', of({ level: ServiceStatusLevels.degraded, summary: 'a is degraded' }));
+ service.set('b', of({ level: ServiceStatusLevels.unavailable, summary: 'b is not working' }));
+ expect(await service.getDerivedStatus$('c').pipe(first()).toPromise()).toEqual({
+ level: ServiceStatusLevels.unavailable,
+ summary: '[b]: b is not working',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ });
+ });
+ });
+
+ describe('getAll$', () => {
+ it('defaults to empty record if no plugins', async () => {
+ const service = new PluginsStatusService({
+ core$: coreAllAvailable$,
+ pluginDependencies: new Map(),
+ });
+ expect(await service.getAll$().pipe(first()).toPromise()).toEqual({});
+ });
+
+ it('defaults to core status when no plugin statuses are set', async () => {
+ const serviceAvailable = new PluginsStatusService({
+ core$: coreAllAvailable$,
+ pluginDependencies,
+ });
+ expect(await serviceAvailable.getAll$().pipe(first()).toPromise()).toEqual({
+ a: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' },
+ b: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' },
+ c: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' },
+ });
+
+ const serviceDegraded = new PluginsStatusService({
+ core$: coreOneDegraded$,
+ pluginDependencies,
+ });
+ expect(await serviceDegraded.getAll$().pipe(first()).toPromise()).toEqual({
+ a: {
+ level: ServiceStatusLevels.degraded,
+ summary: '[savedObjects]: savedObjects degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ b: {
+ level: ServiceStatusLevels.degraded,
+ summary: '[2] services are degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ c: {
+ level: ServiceStatusLevels.degraded,
+ summary: '[3] services are degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ });
+
+ const serviceCritical = new PluginsStatusService({
+ core$: coreOneCriticalOneDegraded$,
+ pluginDependencies,
+ });
+ expect(await serviceCritical.getAll$().pipe(first()).toPromise()).toEqual({
+ a: {
+ level: ServiceStatusLevels.critical,
+ summary: '[elasticsearch]: elasticsearch critical',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ b: {
+ level: ServiceStatusLevels.critical,
+ summary: '[2] services are critical',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ c: {
+ level: ServiceStatusLevels.critical,
+ summary: '[3] services are critical',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ });
+ });
+
+ it('uses the manually set status level if plugin specifies one', async () => {
+ const service = new PluginsStatusService({ core$: coreOneDegraded$, pluginDependencies });
+ service.set('a', of({ level: ServiceStatusLevels.available, summary: 'a status' }));
+
+ expect(await service.getAll$().pipe(first()).toPromise()).toEqual({
+ a: { level: ServiceStatusLevels.available, summary: 'a status' }, // a is available depsite savedObjects being degraded
+ b: {
+ level: ServiceStatusLevels.degraded,
+ summary: '[savedObjects]: savedObjects degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ c: {
+ level: ServiceStatusLevels.degraded,
+ summary: '[2] services are degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ });
+ });
+
+ it('updates when a new plugin status observable is set', async () => {
+ const service = new PluginsStatusService({
+ core$: coreAllAvailable$,
+ pluginDependencies: new Map([['a', []]]),
+ });
+ const statusUpdates: Array> = [];
+ const subscription = service
+ .getAll$()
+ .subscribe((pluginStatuses) => statusUpdates.push(pluginStatuses));
+
+ service.set('a', of({ level: ServiceStatusLevels.degraded, summary: 'a degraded' }));
+ service.set('a', of({ level: ServiceStatusLevels.unavailable, summary: 'a unavailable' }));
+ service.set('a', of({ level: ServiceStatusLevels.available, summary: 'a available' }));
+ subscription.unsubscribe();
+
+ expect(statusUpdates).toEqual([
+ { a: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' } },
+ { a: { level: ServiceStatusLevels.degraded, summary: 'a degraded' } },
+ { a: { level: ServiceStatusLevels.unavailable, summary: 'a unavailable' } },
+ { a: { level: ServiceStatusLevels.available, summary: 'a available' } },
+ ]);
+ });
+ });
+
+ describe('getDependenciesStatus$', () => {
+ it('only includes dependencies of specified plugin', async () => {
+ const service = new PluginsStatusService({
+ core$: coreAllAvailable$,
+ pluginDependencies,
+ });
+ expect(await service.getDependenciesStatus$('a').pipe(first()).toPromise()).toEqual({});
+ expect(await service.getDependenciesStatus$('b').pipe(first()).toPromise()).toEqual({
+ a: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' },
+ });
+ expect(await service.getDependenciesStatus$('c').pipe(first()).toPromise()).toEqual({
+ a: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' },
+ b: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' },
+ });
+ });
+
+ it('uses the manually set status level if plugin specifies one', async () => {
+ const service = new PluginsStatusService({ core$: coreOneDegraded$, pluginDependencies });
+ service.set('a', of({ level: ServiceStatusLevels.available, summary: 'a status' }));
+
+ expect(await service.getDependenciesStatus$('c').pipe(first()).toPromise()).toEqual({
+ a: { level: ServiceStatusLevels.available, summary: 'a status' }, // a is available depsite savedObjects being degraded
+ b: {
+ level: ServiceStatusLevels.degraded,
+ summary: '[savedObjects]: savedObjects degraded',
+ detail: 'See the status page for more information',
+ meta: expect.any(Object),
+ },
+ });
+ });
+
+ it('throws error if unknown plugin passed', () => {
+ const service = new PluginsStatusService({ core$: coreAllAvailable$, pluginDependencies });
+ expect(() => {
+ service.getDependenciesStatus$('dont-exist');
+ }).toThrowError();
+ });
+
+ it('debounces events in quick succession', async () => {
+ const service = new PluginsStatusService({
+ core$: coreAllAvailable$,
+ pluginDependencies,
+ });
+ const available: ServiceStatus = {
+ level: ServiceStatusLevels.available,
+ summary: 'a available',
+ };
+ const degraded: ServiceStatus = {
+ level: ServiceStatusLevels.degraded,
+ summary: 'a degraded',
+ };
+ const pluginA$ = new BehaviorSubject(available);
+ service.set('a', pluginA$);
+
+ const statusUpdates: Array> = [];
+ const subscription = service
+ .getDependenciesStatus$('b')
+ .subscribe((status) => statusUpdates.push(status));
+ const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
+
+ pluginA$.next(degraded);
+ pluginA$.next(available);
+ pluginA$.next(degraded);
+ pluginA$.next(available);
+ pluginA$.next(degraded);
+ pluginA$.next(available);
+ pluginA$.next(degraded);
+ // Waiting for the debounce timeout should cut a new update
+ await delay(500);
+ pluginA$.next(available);
+ await delay(500);
+ subscription.unsubscribe();
+
+ expect(statusUpdates).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "a": Object {
+ "level": degraded,
+ "summary": "a degraded",
+ },
+ },
+ Object {
+ "a": Object {
+ "level": available,
+ "summary": "a available",
+ },
+ },
+ ]
+ `);
+ });
+ });
+});
diff --git a/src/core/server/status/plugins_status.ts b/src/core/server/status/plugins_status.ts
new file mode 100644
index 0000000000000..113d59b327c11
--- /dev/null
+++ b/src/core/server/status/plugins_status.ts
@@ -0,0 +1,98 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { BehaviorSubject, Observable, combineLatest, of } from 'rxjs';
+import { map, distinctUntilChanged, switchMap, debounceTime } from 'rxjs/operators';
+import { isDeepStrictEqual } from 'util';
+
+import { PluginName } from '../plugins';
+import { ServiceStatus, CoreStatus } from './types';
+import { getSummaryStatus } from './get_summary_status';
+
+interface Deps {
+ core$: Observable;
+ pluginDependencies: ReadonlyMap;
+}
+
+export class PluginsStatusService {
+ private readonly pluginStatuses = new Map>();
+ private readonly update$ = new BehaviorSubject(true);
+ constructor(private readonly deps: Deps) {}
+
+ public set(plugin: PluginName, status$: Observable) {
+ this.pluginStatuses.set(plugin, status$);
+ this.update$.next(true); // trigger all existing Observables to update from the new source Observable
+ }
+
+ public getAll$(): Observable> {
+ return this.getPluginStatuses$([...this.deps.pluginDependencies.keys()]);
+ }
+
+ public getDependenciesStatus$(plugin: PluginName): Observable> {
+ const dependencies = this.deps.pluginDependencies.get(plugin);
+ if (!dependencies) {
+ throw new Error(`Unknown plugin: ${plugin}`);
+ }
+
+ return this.getPluginStatuses$(dependencies).pipe(
+ // Prevent many emissions at once from dependency status resolution from making this too noisy
+ debounceTime(500)
+ );
+ }
+
+ public getDerivedStatus$(plugin: PluginName): Observable {
+ return combineLatest([this.deps.core$, this.getDependenciesStatus$(plugin)]).pipe(
+ map(([coreStatus, pluginStatuses]) => {
+ return getSummaryStatus(
+ [...Object.entries(coreStatus), ...Object.entries(pluginStatuses)],
+ {
+ allAvailableSummary: `All dependencies are available`,
+ }
+ );
+ })
+ );
+ }
+
+ private getPluginStatuses$(plugins: PluginName[]): Observable> {
+ if (plugins.length === 0) {
+ return of({});
+ }
+
+ return this.update$.pipe(
+ switchMap(() => {
+ const pluginStatuses = plugins
+ .map(
+ (depName) =>
+ [depName, this.pluginStatuses.get(depName) ?? this.getDerivedStatus$(depName)] as [
+ PluginName,
+ Observable
+ ]
+ )
+ .map(([pName, status$]) =>
+ status$.pipe(map((status) => [pName, status] as [PluginName, ServiceStatus]))
+ );
+
+ return combineLatest(pluginStatuses).pipe(
+ map((statuses) => Object.fromEntries(statuses)),
+ distinctUntilChanged(isDeepStrictEqual)
+ );
+ })
+ );
+ }
+}
diff --git a/src/core/server/status/status_service.mock.ts b/src/core/server/status/status_service.mock.ts
index 47ef8659b4079..42b3eecdca310 100644
--- a/src/core/server/status/status_service.mock.ts
+++ b/src/core/server/status/status_service.mock.ts
@@ -40,6 +40,9 @@ const createSetupContractMock = () => {
const setupContract: jest.Mocked = {
core$: new BehaviorSubject(availableCoreStatus),
overall$: new BehaviorSubject(available),
+ set: jest.fn(),
+ dependencies$: new BehaviorSubject({}),
+ derivedStatus$: new BehaviorSubject(available),
};
return setupContract;
@@ -50,6 +53,11 @@ const createInternalSetupContractMock = () => {
core$: new BehaviorSubject(availableCoreStatus),
overall$: new BehaviorSubject(available),
isStatusPageAnonymous: jest.fn().mockReturnValue(false),
+ plugins: {
+ set: jest.fn(),
+ getDependenciesStatus$: jest.fn(),
+ getDerivedStatus$: jest.fn(),
+ },
};
return setupContract;
diff --git a/src/core/server/status/status_service.test.ts b/src/core/server/status/status_service.test.ts
index 863fe34e8ecea..dcb1e0a559f5d 100644
--- a/src/core/server/status/status_service.test.ts
+++ b/src/core/server/status/status_service.test.ts
@@ -34,6 +34,7 @@ describe('StatusService', () => {
service = new StatusService(mockCoreContext.create());
});
+ const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
const available: ServiceStatus = {
level: ServiceStatusLevels.available,
summary: 'Available',
@@ -53,6 +54,7 @@ describe('StatusService', () => {
savedObjects: {
status$: of(degraded),
},
+ pluginDependencies: new Map(),
});
expect(await setup.core$.pipe(first()).toPromise()).toEqual({
elasticsearch: available,
@@ -68,6 +70,7 @@ describe('StatusService', () => {
savedObjects: {
status$: of(degraded),
},
+ pluginDependencies: new Map(),
});
const subResult1 = await setup.core$.pipe(first()).toPromise();
const subResult2 = await setup.core$.pipe(first()).toPromise();
@@ -96,6 +99,7 @@ describe('StatusService', () => {
savedObjects: {
status$: savedObjects$,
},
+ pluginDependencies: new Map(),
});
const statusUpdates: CoreStatus[] = [];
@@ -158,6 +162,7 @@ describe('StatusService', () => {
savedObjects: {
status$: of(degraded),
},
+ pluginDependencies: new Map(),
});
expect(await setup.overall$.pipe(first()).toPromise()).toMatchObject({
level: ServiceStatusLevels.degraded,
@@ -173,6 +178,7 @@ describe('StatusService', () => {
savedObjects: {
status$: of(degraded),
},
+ pluginDependencies: new Map(),
});
const subResult1 = await setup.overall$.pipe(first()).toPromise();
const subResult2 = await setup.overall$.pipe(first()).toPromise();
@@ -201,26 +207,95 @@ describe('StatusService', () => {
savedObjects: {
status$: savedObjects$,
},
+ pluginDependencies: new Map(),
});
const statusUpdates: ServiceStatus[] = [];
const subscription = setup.overall$.subscribe((status) => statusUpdates.push(status));
+ // Wait for timers to ensure that duplicate events are still filtered out regardless of debouncing.
elasticsearch$.next(available);
+ await delay(500);
elasticsearch$.next(available);
+ await delay(500);
elasticsearch$.next({
level: ServiceStatusLevels.available,
summary: `Wow another summary`,
});
+ await delay(500);
savedObjects$.next(degraded);
+ await delay(500);
savedObjects$.next(available);
+ await delay(500);
savedObjects$.next(available);
+ await delay(500);
subscription.unsubscribe();
expect(statusUpdates).toMatchInlineSnapshot(`
Array [
Object {
+ "detail": "See the status page for more information",
"level": degraded,
+ "meta": Object {
+ "affectedServices": Object {
+ "savedObjects": Object {
+ "level": degraded,
+ "summary": "This is degraded!",
+ },
+ },
+ },
+ "summary": "[savedObjects]: This is degraded!",
+ },
+ Object {
+ "level": available,
+ "summary": "All services are available",
+ },
+ ]
+ `);
+ });
+
+ it('debounces events in quick succession', async () => {
+ const savedObjects$ = new BehaviorSubject(available);
+ const setup = await service.setup({
+ elasticsearch: {
+ status$: new BehaviorSubject(available),
+ },
+ savedObjects: {
+ status$: savedObjects$,
+ },
+ pluginDependencies: new Map(),
+ });
+
+ const statusUpdates: ServiceStatus[] = [];
+ const subscription = setup.overall$.subscribe((status) => statusUpdates.push(status));
+
+ // All of these should debounced into a single `available` status
+ savedObjects$.next(degraded);
+ savedObjects$.next(available);
+ savedObjects$.next(degraded);
+ savedObjects$.next(available);
+ savedObjects$.next(degraded);
+ savedObjects$.next(available);
+ savedObjects$.next(degraded);
+ // Waiting for the debounce timeout should cut a new update
+ await delay(500);
+ savedObjects$.next(available);
+ await delay(500);
+ subscription.unsubscribe();
+
+ expect(statusUpdates).toMatchInlineSnapshot(`
+ Array [
+ Object {
+ "detail": "See the status page for more information",
+ "level": degraded,
+ "meta": Object {
+ "affectedServices": Object {
+ "savedObjects": Object {
+ "level": degraded,
+ "summary": "This is degraded!",
+ },
+ },
+ },
"summary": "[savedObjects]: This is degraded!",
},
Object {
diff --git a/src/core/server/status/status_service.ts b/src/core/server/status/status_service.ts
index aea335e64babf..8fe65eddb61d3 100644
--- a/src/core/server/status/status_service.ts
+++ b/src/core/server/status/status_service.ts
@@ -18,7 +18,7 @@
*/
import { Observable, combineLatest } from 'rxjs';
-import { map, distinctUntilChanged, shareReplay, take } from 'rxjs/operators';
+import { map, distinctUntilChanged, shareReplay, take, debounceTime } from 'rxjs/operators';
import { isDeepStrictEqual } from 'util';
import { CoreService } from '../../types';
@@ -26,13 +26,16 @@ import { CoreContext } from '../core_context';
import { Logger } from '../logging';
import { InternalElasticsearchServiceSetup } from '../elasticsearch';
import { InternalSavedObjectsServiceSetup } from '../saved_objects';
+import { PluginName } from '../plugins';
import { config, StatusConfigType } from './status_config';
import { ServiceStatus, CoreStatus, InternalStatusServiceSetup } from './types';
import { getSummaryStatus } from './get_summary_status';
+import { PluginsStatusService } from './plugins_status';
interface SetupDeps {
elasticsearch: Pick;
+ pluginDependencies: ReadonlyMap;
savedObjects: Pick;
}
@@ -40,26 +43,44 @@ export class StatusService implements CoreService {
private readonly logger: Logger;
private readonly config$: Observable;
+ private pluginsStatus?: PluginsStatusService;
+
constructor(coreContext: CoreContext) {
this.logger = coreContext.logger.get('status');
this.config$ = coreContext.configService.atPath(config.path);
}
- public async setup(core: SetupDeps) {
+ public async setup({ elasticsearch, pluginDependencies, savedObjects }: SetupDeps) {
const statusConfig = await this.config$.pipe(take(1)).toPromise();
- const core$ = this.setupCoreStatus(core);
- const overall$: Observable = core$.pipe(
- map((coreStatus) => {
- const summary = getSummaryStatus(Object.entries(coreStatus));
+ const core$ = this.setupCoreStatus({ elasticsearch, savedObjects });
+ this.pluginsStatus = new PluginsStatusService({ core$, pluginDependencies });
+
+ const overall$: Observable = combineLatest(
+ core$,
+ this.pluginsStatus.getAll$()
+ ).pipe(
+ // Prevent many emissions at once from dependency status resolution from making this too noisy
+ debounceTime(500),
+ map(([coreStatus, pluginsStatus]) => {
+ const summary = getSummaryStatus([
+ ...Object.entries(coreStatus),
+ ...Object.entries(pluginsStatus),
+ ]);
this.logger.debug(`Recalculated overall status`, { status: summary });
return summary;
}),
- distinctUntilChanged(isDeepStrictEqual)
+ distinctUntilChanged(isDeepStrictEqual),
+ shareReplay(1)
);
return {
core$,
overall$,
+ plugins: {
+ set: this.pluginsStatus.set.bind(this.pluginsStatus),
+ getDependenciesStatus$: this.pluginsStatus.getDependenciesStatus$.bind(this.pluginsStatus),
+ getDerivedStatus$: this.pluginsStatus.getDerivedStatus$.bind(this.pluginsStatus),
+ },
isStatusPageAnonymous: () => statusConfig.allowAnonymous,
};
}
@@ -68,7 +89,10 @@ export class StatusService implements CoreService {
public stop() {}
- private setupCoreStatus({ elasticsearch, savedObjects }: SetupDeps): Observable {
+ private setupCoreStatus({
+ elasticsearch,
+ savedObjects,
+ }: Pick): Observable {
return combineLatest([elasticsearch.status$, savedObjects.status$]).pipe(
map(([elasticsearchStatus, savedObjectsStatus]) => ({
elasticsearch: elasticsearchStatus,
diff --git a/src/core/server/status/types.ts b/src/core/server/status/types.ts
index 2ecf11deb2960..f884b80316fa8 100644
--- a/src/core/server/status/types.ts
+++ b/src/core/server/status/types.ts
@@ -19,6 +19,7 @@
import { Observable } from 'rxjs';
import { deepFreeze } from '../../utils';
+import { PluginName } from '../plugins';
/**
* The current status of a service at a point in time.
@@ -116,6 +117,60 @@ export interface CoreStatus {
/**
* API for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.
+ *
+ * @remarks
+ * By default, a plugin inherits it's current status from the most severe status level of any Core services and any
+ * plugins that it depends on. This default status is available on the
+ * {@link ServiceStatusSetup.derivedStatus$ | core.status.derviedStatus$} API.
+ *
+ * Plugins may customize their status calculation by calling the {@link ServiceStatusSetup.set | core.status.set} API
+ * with an Observable. Within this Observable, a plugin may choose to only depend on the status of some of its
+ * dependencies, to ignore severe status levels of particular Core services they are not concerned with, or to make its
+ * status dependent on other external services.
+ *
+ * @example
+ * Customize a plugin's status to only depend on the status of SavedObjects:
+ * ```ts
+ * core.status.set(
+ * core.status.core$.pipe(
+ * . map((coreStatus) => {
+ * return coreStatus.savedObjects;
+ * }) ;
+ * );
+ * );
+ * ```
+ *
+ * @example
+ * Customize a plugin's status to include an external service:
+ * ```ts
+ * const externalStatus$ = interval(1000).pipe(
+ * switchMap(async () => {
+ * const resp = await fetch(`https://myexternaldep.com/_healthz`);
+ * const body = await resp.json();
+ * if (body.ok) {
+ * return of({ level: ServiceStatusLevels.available, summary: 'External Service is up'});
+ * } else {
+ * return of({ level: ServiceStatusLevels.available, summary: 'External Service is unavailable'});
+ * }
+ * }),
+ * catchError((error) => {
+ * of({ level: ServiceStatusLevels.unavailable, summary: `External Service is down`, meta: { error }})
+ * })
+ * );
+ *
+ * core.status.set(
+ * combineLatest([core.status.derivedStatus$, externalStatus$]).pipe(
+ * map(([derivedStatus, externalStatus]) => {
+ * if (externalStatus.level > derivedStatus) {
+ * return externalStatus;
+ * } else {
+ * return derivedStatus;
+ * }
+ * })
+ * )
+ * );
+ * ```
+ *
* @public
*/
export interface StatusServiceSetup {
@@ -134,9 +189,43 @@ export interface StatusServiceSetup {
* only depend on the statuses of {@link StatusServiceSetup.core$ | Core} or their dependencies.
*/
overall$: Observable;
+
+ /**
+ * Allows a plugin to specify a custom status dependent on its own criteria.
+ * Completely overrides the default inherited status.
+ *
+ * @remarks
+ * See the {@link StatusServiceSetup.derivedStatus$} API for leveraging the default status
+ * calculation that is provided by Core.
+ */
+ set(status$: Observable): void;
+
+ /**
+ * Current status for all plugins this plugin depends on.
+ * Each key of the `Record` is a plugin id.
+ */
+ dependencies$: Observable>;
+
+ /**
+ * The status of this plugin as derived from its dependencies.
+ *
+ * @remarks
+ * By default, plugins inherit this derived status from their dependencies.
+ * Calling {@link StatusSetup.set} overrides this default status.
+ *
+ * This may emit multliple times for a single status change event as propagates
+ * through the dependency tree
+ */
+ derivedStatus$: Observable;
}
/** @internal */
-export interface InternalStatusServiceSetup extends StatusServiceSetup {
+export interface InternalStatusServiceSetup extends Pick {
isStatusPageAnonymous: () => boolean;
+ // Namespaced under `plugins` key to improve clarity that these are APIs for plugins specifically.
+ plugins: {
+ set(plugin: PluginName, status$: Observable): void;
+ getDependenciesStatus$(plugin: PluginName): Observable>;
+ getDerivedStatus$(plugin: PluginName): Observable;
+ };
}
diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts b/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts
index 61b71f8c5de07..c7d5413ecca56 100644
--- a/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts
+++ b/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts
@@ -36,8 +36,6 @@ describe('createOrUpgradeSavedConfig()', () => {
let esServer: TestElasticsearchUtils;
let kbn: TestKibanaUtils;
- let kbnServer: TestKibanaUtils['kbnServer'];
-
beforeAll(async function () {
servers = createTestServers({
adjustTimeout: (t) => {
@@ -46,10 +44,8 @@ describe('createOrUpgradeSavedConfig()', () => {
});
esServer = await servers.startES();
kbn = await servers.startKibana();
- kbnServer = kbn.kbnServer;
- const savedObjects = kbnServer.server.savedObjects;
- savedObjectsClient = savedObjects.getScopedSavedObjectsClient(
+ savedObjectsClient = kbn.coreStart.savedObjects.getScopedClient(
httpServerMock.createKibanaRequest()
);
diff --git a/src/core/server/ui_settings/integration_tests/lib/servers.ts b/src/core/server/ui_settings/integration_tests/lib/servers.ts
index 297deb0233c57..0bdc821f42581 100644
--- a/src/core/server/ui_settings/integration_tests/lib/servers.ts
+++ b/src/core/server/ui_settings/integration_tests/lib/servers.ts
@@ -68,8 +68,7 @@ export function getServices() {
const callCluster = esServer.es.getCallCluster();
- const savedObjects = kbnServer.server.savedObjects;
- const savedObjectsClient = savedObjects.getScopedSavedObjectsClient(
+ const savedObjectsClient = kbn.coreStart.savedObjects.getScopedClient(
httpServerMock.createKibanaRequest()
);
diff --git a/src/core/test_helpers/kbn_server.ts b/src/core/test_helpers/kbn_server.ts
index a494c6aa31d6f..488c4b919d3e4 100644
--- a/src/core/test_helpers/kbn_server.ts
+++ b/src/core/test_helpers/kbn_server.ts
@@ -32,6 +32,7 @@ import { resolve } from 'path';
import { BehaviorSubject } from 'rxjs';
import supertest from 'supertest';
+import { CoreStart } from 'src/core/server';
import { LegacyAPICaller } from '../server/elasticsearch';
import { CliArgs, Env } from '../server/config';
import { Root } from '../server/root';
@@ -170,6 +171,7 @@ export interface TestElasticsearchUtils {
export interface TestKibanaUtils {
root: Root;
+ coreStart: CoreStart;
kbnServer: KbnServer;
stop: () => Promise;
}
@@ -289,13 +291,14 @@ export function createTestServers({
const root = createRootWithCorePlugins(kbnSettings);
await root.setup();
- await root.start();
+ const coreStart = await root.start();
const kbnServer = getKbnServer(root);
return {
root,
kbnServer,
+ coreStart,
stop: async () => await root.shutdown(),
};
},
diff --git a/src/legacy/core_plugins/elasticsearch/index.js b/src/legacy/core_plugins/elasticsearch/index.js
index 599886788604b..f90f490d68035 100644
--- a/src/legacy/core_plugins/elasticsearch/index.js
+++ b/src/legacy/core_plugins/elasticsearch/index.js
@@ -16,18 +16,13 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { first } from 'rxjs/operators';
import { Cluster } from './server/lib/cluster';
import { createProxy } from './server/lib/create_proxy';
export default function (kibana) {
- let defaultVars;
-
return new kibana.Plugin({
require: [],
- uiExports: { injectDefaultVars: () => defaultVars },
-
async init(server) {
// All methods that ES plugin exposes are synchronous so we should get the first
// value from all observables here to be able to synchronously return and create
@@ -36,16 +31,6 @@ export default function (kibana) {
const adminCluster = new Cluster(client);
const dataCluster = new Cluster(client);
- const esConfig = await server.newPlatform.__internals.elasticsearch.legacy.config$
- .pipe(first())
- .toPromise();
-
- defaultVars = {
- esRequestTimeout: esConfig.requestTimeout.asMilliseconds(),
- esShardTimeout: esConfig.shardTimeout.asMilliseconds(),
- esApiVersion: esConfig.apiVersion,
- };
-
const clusters = new Map();
server.expose('getCluster', (name) => {
if (name === 'admin') {
diff --git a/src/legacy/plugin_discovery/plugin_spec/plugin_spec_options.d.ts b/src/legacy/plugin_discovery/plugin_spec/plugin_spec_options.d.ts
index e51a355cbc8d2..e1ed2f57375a4 100644
--- a/src/legacy/plugin_discovery/plugin_spec/plugin_spec_options.d.ts
+++ b/src/legacy/plugin_discovery/plugin_spec/plugin_spec_options.d.ts
@@ -18,14 +18,10 @@
*/
import { Server } from '../../server/kbn_server';
import { Capabilities } from '../../../core/server';
-// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { SavedObjectsLegacyManagementDefinition } from '../../../core/server/saved_objects/types';
export type InitPluginFunction = (server: Server) => void;
export interface UiExports {
injectDefaultVars?: (server: Server) => { [key: string]: any };
- savedObjectsManagement?: SavedObjectsLegacyManagementDefinition;
- mappings?: unknown;
}
export interface PluginSpecOptions {
diff --git a/src/legacy/plugin_discovery/types.ts b/src/legacy/plugin_discovery/types.ts
index 283806f69599a..700ca6fa68c95 100644
--- a/src/legacy/plugin_discovery/types.ts
+++ b/src/legacy/plugin_discovery/types.ts
@@ -19,11 +19,6 @@
import { Server } from '../server/kbn_server';
import { Capabilities } from '../../core/server';
-// Disable lint errors for imports from src/core/* until SavedObjects migration is complete
-// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { SavedObjectsSchemaDefinition } from '../../core/server/saved_objects/schema';
-// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { SavedObjectsLegacyManagementDefinition } from '../../core/server/saved_objects/types';
import { AppCategory } from '../../core/types';
/**
@@ -70,8 +65,6 @@ export interface LegacyPluginOptions {
home: string[];
mappings: any;
migrations: any;
- savedObjectSchemas: SavedObjectsSchemaDefinition;
- savedObjectsManagement: SavedObjectsLegacyManagementDefinition;
visTypes: string[];
embeddableActions?: string[];
embeddableFactories?: string[];
diff --git a/src/legacy/server/kbn_server.d.ts b/src/legacy/server/kbn_server.d.ts
index 69fb63fbbd87f..663542618375a 100644
--- a/src/legacy/server/kbn_server.d.ts
+++ b/src/legacy/server/kbn_server.d.ts
@@ -17,33 +17,24 @@
* under the License.
*/
-import { ResponseObject, Server } from 'hapi';
-import { UnwrapPromise } from '@kbn/utility-types';
+import { Server } from 'hapi';
import { TelemetryCollectionManagerPluginSetup } from 'src/plugins/telemetry_collection_manager/server';
import {
- ConfigService,
CoreSetup,
CoreStart,
- ElasticsearchServiceSetup,
EnvironmentMode,
LoggerFactory,
- SavedObjectsClientContract,
- SavedObjectsLegacyService,
- SavedObjectsClientProviderOptions,
- IUiSettingsClient,
PackageInfo,
- LegacyRequest,
LegacyServiceSetupDeps,
- LegacyServiceStartDeps,
LegacyServiceDiscoverPlugins,
} from '../../core/server';
// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { LegacyConfig, ILegacyService, ILegacyInternals } from '../../core/server/legacy';
+import { LegacyConfig, ILegacyInternals } from '../../core/server/legacy';
// eslint-disable-next-line @kbn/eslint/no-restricted-paths
import { UiPlugins } from '../../core/server/plugins';
-import { CallClusterWithRequest, ElasticsearchPlugin } from '../core_plugins/elasticsearch';
+import { ElasticsearchPlugin } from '../core_plugins/elasticsearch';
import { UsageCollectionSetup } from '../../plugins/usage_collection/server';
import { HomeServerPluginSetup } from '../../plugins/home/server';
@@ -61,16 +52,9 @@ declare module 'hapi' {
interface Server {
config: () => KibanaConfig;
- savedObjects: SavedObjectsLegacyService;
logWithMetadata: (tags: string[], message: string, meta: Record) => void;
newPlatform: KbnServer['newPlatform'];
}
-
- interface Request {
- getSavedObjectsClient(options?: SavedObjectsClientProviderOptions): SavedObjectsClientContract;
- getBasePath(): string;
- getUiSettingsService(): IUiSettingsClient;
- }
}
type KbnMixinFunc = (kbnServer: KbnServer, server: Server, config: any) => Promise | void;
@@ -86,11 +70,9 @@ export interface KibanaCore {
__internals: {
elasticsearch: LegacyServiceSetupDeps['core']['elasticsearch'];
hapiServer: LegacyServiceSetupDeps['core']['http']['server'];
- kibanaMigrator: LegacyServiceStartDeps['core']['savedObjects']['migrator'];
legacy: ILegacyInternals;
rendering: LegacyServiceSetupDeps['core']['rendering'];
uiPlugins: UiPlugins;
- savedObjectsClientProvider: LegacyServiceStartDeps['core']['savedObjects']['clientProvider'];
};
env: {
mode: Readonly;
@@ -149,6 +131,3 @@ export default class KbnServer {
// Re-export commonly used hapi types.
export { Server, Request, ResponseToolkit } from 'hapi';
-
-// Re-export commonly accessed api types.
-export { SavedObjectsLegacyService, SavedObjectsClient } from 'src/core/server';
diff --git a/src/legacy/server/kbn_server.js b/src/legacy/server/kbn_server.js
index 4692262d99bb5..a5eefd140c8fa 100644
--- a/src/legacy/server/kbn_server.js
+++ b/src/legacy/server/kbn_server.js
@@ -33,7 +33,6 @@ import pidMixin from './pid';
import configCompleteMixin from './config/complete';
import { optimizeMixin } from '../../optimize';
import * as Plugins from './plugins';
-import { savedObjectsMixin } from './saved_objects/saved_objects_mixin';
import { uiMixin } from '../ui';
import { i18nMixin } from './i18n';
@@ -108,9 +107,6 @@ export default class KbnServer {
uiMixin,
- // setup saved object routes
- savedObjectsMixin,
-
// setup routes that serve the @kbn/optimizer output
optimizeMixin,
diff --git a/src/legacy/server/saved_objects/saved_objects_mixin.js b/src/legacy/server/saved_objects/saved_objects_mixin.js
deleted file mode 100644
index 96cf2058839cf..0000000000000
--- a/src/legacy/server/saved_objects/saved_objects_mixin.js
+++ /dev/null
@@ -1,104 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-// Disable lint errors for imports from src/core/server/saved_objects until SavedObjects migration is complete
-/* eslint-disable @kbn/eslint/no-restricted-paths */
-import { SavedObjectsSchema } from '../../../core/server/saved_objects/schema';
-import {
- SavedObjectsClient,
- SavedObjectsRepository,
- exportSavedObjectsToStream,
- importSavedObjectsFromStream,
- resolveSavedObjectsImportErrors,
-} from '../../../core/server/saved_objects';
-import { convertTypesToLegacySchema } from '../../../core/server/saved_objects/utils';
-
-export function savedObjectsMixin(kbnServer, server) {
- const migrator = kbnServer.newPlatform.__internals.kibanaMigrator;
- const typeRegistry = kbnServer.newPlatform.start.core.savedObjects.getTypeRegistry();
- const mappings = migrator.getActiveMappings();
- const allTypes = typeRegistry.getAllTypes().map((t) => t.name);
- const visibleTypes = typeRegistry.getVisibleTypes().map((t) => t.name);
- const schema = new SavedObjectsSchema(convertTypesToLegacySchema(typeRegistry.getAllTypes()));
-
- server.decorate('server', 'kibanaMigrator', migrator);
-
- const serializer = kbnServer.newPlatform.start.core.savedObjects.createSerializer();
-
- const createRepository = (callCluster, includedHiddenTypes = []) => {
- if (typeof callCluster !== 'function') {
- throw new TypeError('Repository requires a "callCluster" function to be provided.');
- }
- // throw an exception if an extraType is not defined.
- includedHiddenTypes.forEach((type) => {
- if (!allTypes.includes(type)) {
- throw new Error(`Missing mappings for saved objects type '${type}'`);
- }
- });
- const combinedTypes = visibleTypes.concat(includedHiddenTypes);
- const allowedTypes = [...new Set(combinedTypes)];
-
- const config = server.config();
-
- return new SavedObjectsRepository({
- index: config.get('kibana.index'),
- migrator,
- mappings,
- typeRegistry,
- serializer,
- allowedTypes,
- callCluster,
- });
- };
-
- const provider = kbnServer.newPlatform.__internals.savedObjectsClientProvider;
-
- const service = {
- types: visibleTypes,
- SavedObjectsClient,
- SavedObjectsRepository,
- getSavedObjectsRepository: createRepository,
- getScopedSavedObjectsClient: (...args) => provider.getClient(...args),
- setScopedSavedObjectsClientFactory: (...args) => provider.setClientFactory(...args),
- addScopedSavedObjectsClientWrapperFactory: (...args) =>
- provider.addClientWrapperFactory(...args),
- importExport: {
- objectLimit: server.config().get('savedObjects.maxImportExportSize'),
- importSavedObjects: importSavedObjectsFromStream,
- resolveImportErrors: resolveSavedObjectsImportErrors,
- getSortedObjectsForExport: exportSavedObjectsToStream,
- },
- schema,
- };
- server.decorate('server', 'savedObjects', service);
-
- const savedObjectsClientCache = new WeakMap();
- server.decorate('request', 'getSavedObjectsClient', function (options) {
- const request = this;
-
- if (savedObjectsClientCache.has(request)) {
- return savedObjectsClientCache.get(request);
- }
-
- const savedObjectsClient = server.savedObjects.getScopedSavedObjectsClient(request, options);
-
- savedObjectsClientCache.set(request, savedObjectsClient);
- return savedObjectsClient;
- });
-}
diff --git a/src/legacy/server/saved_objects/saved_objects_mixin.test.js b/src/legacy/server/saved_objects/saved_objects_mixin.test.js
deleted file mode 100644
index d1d6c052ad589..0000000000000
--- a/src/legacy/server/saved_objects/saved_objects_mixin.test.js
+++ /dev/null
@@ -1,267 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { savedObjectsMixin } from './saved_objects_mixin';
-// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { mockKibanaMigrator } from '../../../core/server/saved_objects/migrations/kibana/kibana_migrator.mock';
-// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { savedObjectsClientProviderMock } from '../../../core/server/saved_objects/service/lib/scoped_client_provider.mock';
-// eslint-disable-next-line @kbn/eslint/no-restricted-paths
-import { convertLegacyTypes } from '../../../core/server/saved_objects/utils';
-import { SavedObjectTypeRegistry } from '../../../core/server';
-import { coreMock } from '../../../core/server/mocks';
-
-const mockConfig = {
- get: jest.fn().mockReturnValue('anything'),
-};
-
-const savedObjectMappings = [
- {
- pluginId: 'testtype',
- properties: {
- testtype: {
- properties: {
- name: { type: 'keyword' },
- },
- },
- },
- },
- {
- pluginId: 'testtype2',
- properties: {
- doc1: {
- properties: {
- name: { type: 'keyword' },
- },
- },
- doc2: {
- properties: {
- name: { type: 'keyword' },
- },
- },
- },
- },
- {
- pluginId: 'secretPlugin',
- properties: {
- hiddentype: {
- properties: {
- secret: { type: 'keyword' },
- },
- },
- },
- },
-];
-
-const savedObjectSchemas = {
- hiddentype: {
- hidden: true,
- },
- doc1: {
- indexPattern: 'other-index',
- },
-};
-
-const savedObjectTypes = convertLegacyTypes(
- {
- savedObjectMappings,
- savedObjectSchemas,
- savedObjectMigrations: {},
- },
- mockConfig
-);
-
-const typeRegistry = new SavedObjectTypeRegistry();
-savedObjectTypes.forEach((type) => typeRegistry.registerType(type));
-
-const migrator = mockKibanaMigrator.create({
- types: savedObjectTypes,
-});
-
-describe('Saved Objects Mixin', () => {
- let mockKbnServer;
- let mockServer;
- const mockCallCluster = jest.fn();
- const stubCallCluster = jest.fn();
- const config = {
- 'kibana.index': 'kibana.index',
- 'savedObjects.maxImportExportSize': 10000,
- };
- const stubConfig = jest.fn((key) => {
- return config[key];
- });
-
- beforeEach(() => {
- const clientProvider = savedObjectsClientProviderMock.create();
- mockServer = {
- log: jest.fn(),
- route: jest.fn(),
- decorate: jest.fn(),
- config: () => {
- return {
- get: stubConfig,
- };
- },
- plugins: {
- elasticsearch: {
- getCluster: () => {
- return {
- callWithRequest: mockCallCluster,
- callWithInternalUser: stubCallCluster,
- };
- },
- waitUntilReady: jest.fn(),
- },
- },
- };
-
- const coreStart = coreMock.createStart();
- coreStart.savedObjects.getTypeRegistry.mockReturnValue(typeRegistry);
-
- mockKbnServer = {
- newPlatform: {
- __internals: {
- kibanaMigrator: migrator,
- savedObjectsClientProvider: clientProvider,
- },
- setup: {
- core: coreMock.createSetup(),
- },
- start: {
- core: coreStart,
- },
- },
- server: mockServer,
- ready: () => {},
- pluginSpecs: {
- some: () => {
- return true;
- },
- },
- uiExports: {
- savedObjectMappings,
- savedObjectSchemas,
- },
- };
- });
-
- describe('Saved object service', () => {
- let service;
-
- beforeEach(async () => {
- await savedObjectsMixin(mockKbnServer, mockServer);
- const call = mockServer.decorate.mock.calls.filter(
- ([objName, methodName]) => objName === 'server' && methodName === 'savedObjects'
- );
- service = call[0][2];
- });
-
- it('should return all but hidden types', async () => {
- expect(service).toBeDefined();
- expect(service.types).toEqual(['testtype', 'doc1', 'doc2']);
- });
-
- const mockCallEs = jest.fn();
- describe('repository creation', () => {
- it('should not allow a repository with an undefined type', () => {
- expect(() => {
- service.getSavedObjectsRepository(mockCallEs, ['extraType']);
- }).toThrow(new Error("Missing mappings for saved objects type 'extraType'"));
- });
-
- it('should create a repository without hidden types', () => {
- const repository = service.getSavedObjectsRepository(mockCallEs);
- expect(repository).toBeDefined();
- expect(repository._allowedTypes).toEqual(['testtype', 'doc1', 'doc2']);
- });
-
- it('should create a repository with a unique list of allowed types', () => {
- const repository = service.getSavedObjectsRepository(mockCallEs, ['doc1', 'doc1', 'doc1']);
- expect(repository._allowedTypes).toEqual(['testtype', 'doc1', 'doc2']);
- });
-
- it('should create a repository with extraTypes minus duplicate', () => {
- const repository = service.getSavedObjectsRepository(mockCallEs, [
- 'hiddentype',
- 'hiddentype',
- ]);
- expect(repository._allowedTypes).toEqual(['testtype', 'doc1', 'doc2', 'hiddentype']);
- });
-
- it('should not allow a repository without a callCluster function', () => {
- expect(() => {
- service.getSavedObjectsRepository({});
- }).toThrow(new Error('Repository requires a "callCluster" function to be provided.'));
- });
- });
-
- describe('get client', () => {
- it('should have a method to get the client', () => {
- expect(service).toHaveProperty('getScopedSavedObjectsClient');
- });
-
- it('should have a method to set the client factory', () => {
- expect(service).toHaveProperty('setScopedSavedObjectsClientFactory');
- });
-
- it('should have a method to add a client wrapper factory', () => {
- expect(service).toHaveProperty('addScopedSavedObjectsClientWrapperFactory');
- });
-
- it('should allow you to set a scoped saved objects client factory', () => {
- expect(() => {
- service.setScopedSavedObjectsClientFactory({});
- }).not.toThrowError();
- });
-
- it('should allow you to add a scoped saved objects client wrapper factory', () => {
- expect(() => {
- service.addScopedSavedObjectsClientWrapperFactory({});
- }).not.toThrowError();
- });
- });
-
- describe('#getSavedObjectsClient', () => {
- let getSavedObjectsClient;
-
- beforeEach(() => {
- savedObjectsMixin(mockKbnServer, mockServer);
- const call = mockServer.decorate.mock.calls.filter(
- ([objName, methodName]) => objName === 'request' && methodName === 'getSavedObjectsClient'
- );
- getSavedObjectsClient = call[0][2];
- });
-
- it('should be callable', () => {
- mockServer.savedObjects = service;
- getSavedObjectsClient = getSavedObjectsClient.bind({});
- expect(() => {
- getSavedObjectsClient();
- }).not.toThrowError();
- });
-
- it('should use cached request object', () => {
- mockServer.savedObjects = service;
- getSavedObjectsClient = getSavedObjectsClient.bind({ _test: 'me' });
- const savedObjectsClient = getSavedObjectsClient();
- expect(getSavedObjectsClient()).toEqual(savedObjectsClient);
- });
- });
- });
-});
diff --git a/src/legacy/ui/ui_exports/__tests__/collect_ui_exports.js b/src/legacy/ui/ui_exports/__tests__/collect_ui_exports.js
deleted file mode 100644
index 5b2af9f82333c..0000000000000
--- a/src/legacy/ui/ui_exports/__tests__/collect_ui_exports.js
+++ /dev/null
@@ -1,117 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import expect from '@kbn/expect';
-
-import { PluginPack } from '../../../plugin_discovery';
-
-import { collectUiExports } from '../collect_ui_exports';
-
-const specs = new PluginPack({
- path: '/dev/null',
- pkg: {
- name: 'test',
- version: 'kibana',
- },
- provider({ Plugin }) {
- return [
- new Plugin({
- id: 'test',
- uiExports: {
- savedObjectSchemas: {
- foo: {
- isNamespaceAgnostic: true,
- },
- },
- },
- }),
- new Plugin({
- id: 'test2',
- uiExports: {
- savedObjectSchemas: {
- bar: {
- isNamespaceAgnostic: true,
- },
- },
- },
- }),
- ];
- },
-}).getPluginSpecs();
-
-describe('plugin discovery', () => {
- describe('collectUiExports()', () => {
- it('merges uiExports from all provided plugin specs', () => {
- const uiExports = collectUiExports(specs);
-
- expect(uiExports.savedObjectSchemas).to.eql({
- foo: {
- isNamespaceAgnostic: true,
- },
- bar: {
- isNamespaceAgnostic: true,
- },
- });
- });
-
- it(`throws an error when migrations and mappings aren't defined in the same plugin`, () => {
- const invalidSpecs = new PluginPack({
- path: '/dev/null',
- pkg: {
- name: 'test',
- version: 'kibana',
- },
- provider({ Plugin }) {
- return [
- new Plugin({
- id: 'test',
- uiExports: {
- mappings: {
- 'test-type': {
- properties: {},
- },
- },
- },
- }),
- new Plugin({
- id: 'test2',
- uiExports: {
- migrations: {
- 'test-type': {
- '1.2.3': (doc) => {
- return doc;
- },
- },
- },
- },
- }),
- ];
- },
- }).getPluginSpecs();
- expect(() => collectUiExports(invalidSpecs)).to.throwError((err) => {
- expect(err).to.be.a(Error);
- expect(err).to.have.property(
- 'message',
- 'Migrations and mappings must be defined together in the uiExports of a single plugin. ' +
- 'test2 defines migrations for types test-type but does not define their mappings.'
- );
- });
- });
- });
-});
diff --git a/src/legacy/ui/ui_render/ui_render_mixin.js b/src/legacy/ui/ui_render/ui_render_mixin.js
index cd8dcf5aff71d..e3b7c1e0c3ff9 100644
--- a/src/legacy/ui/ui_render/ui_render_mixin.js
+++ b/src/legacy/ui/ui_render/ui_render_mixin.js
@@ -193,13 +193,11 @@ export function uiRenderMixin(kbnServer, server, config) {
async function renderApp(h) {
const app = { getId: () => 'core' };
const { http } = kbnServer.newPlatform.setup.core;
- const {
- rendering,
- legacy,
- savedObjectsClientProvider: savedObjects,
- } = kbnServer.newPlatform.__internals;
+ const { savedObjects } = kbnServer.newPlatform.start.core;
+ const { rendering, legacy } = kbnServer.newPlatform.__internals;
+ const req = KibanaRequest.from(h.request);
const uiSettings = kbnServer.newPlatform.start.core.uiSettings.asScopedToClient(
- savedObjects.getClient(h.request)
+ savedObjects.getScopedClient(req)
);
const vars = await legacy.getVars(app.getId(), h.request, {
apmConfig: getApmConfig(h.request.path),
diff --git a/src/legacy/utils/index.js b/src/legacy/utils/index.js
index 529b1ddfd8a4d..e2e2331b3aea6 100644
--- a/src/legacy/utils/index.js
+++ b/src/legacy/utils/index.js
@@ -17,8 +17,6 @@
* under the License.
*/
-export { BinderBase } from './binder';
-export { BinderFor } from './binder_for';
export { deepCloneWithBuffers } from './deep_clone_with_buffers';
export { unset } from './unset';
export { IS_KIBANA_DISTRIBUTABLE } from './artifact_type';
diff --git a/src/plugins/dashboard/public/application/actions/open_replace_panel_flyout.tsx b/src/plugins/dashboard/public/application/actions/open_replace_panel_flyout.tsx
index c676ca052d687..54a294fd2f4ac 100644
--- a/src/plugins/dashboard/public/application/actions/open_replace_panel_flyout.tsx
+++ b/src/plugins/dashboard/public/application/actions/open_replace_panel_flyout.tsx
@@ -60,7 +60,8 @@ export async function openReplacePanelFlyout(options: {
/>
),
{
- 'data-test-subj': 'replacePanelFlyout',
+ 'data-test-subj': 'dashboardReplacePanel',
+ ownFocus: true,
}
);
}
diff --git a/src/plugins/dashboard/public/application/actions/replace_panel_flyout.tsx b/src/plugins/dashboard/public/application/actions/replace_panel_flyout.tsx
index 0000f63c48c2d..4e228bc1a7a06 100644
--- a/src/plugins/dashboard/public/application/actions/replace_panel_flyout.tsx
+++ b/src/plugins/dashboard/public/application/actions/replace_panel_flyout.tsx
@@ -19,16 +19,15 @@
import { i18n } from '@kbn/i18n';
import React from 'react';
-import _ from 'lodash';
-import { EuiFlyout, EuiFlyoutBody, EuiFlyoutHeader, EuiTitle } from '@elastic/eui';
+import { EuiFlyoutBody, EuiFlyoutHeader, EuiTitle } from '@elastic/eui';
import { NotificationsStart, Toast } from 'src/core/public';
import { DashboardPanelState } from '../embeddable';
import {
- IContainer,
- IEmbeddable,
EmbeddableInput,
EmbeddableOutput,
EmbeddableStart,
+ IContainer,
+ IEmbeddable,
SavedObjectEmbeddableInput,
} from '../../embeddable_plugin';
@@ -122,7 +121,7 @@ export class ReplacePanelFlyout extends React.Component {
const panelToReplace = 'Replace panel ' + this.props.panelToRemove.getTitle() + ' with:';
return (
-
+ <>
@@ -131,7 +130,7 @@ export class ReplacePanelFlyout extends React.Component {
{savedObjectsFinder}
-
+
);
}
}
diff --git a/src/plugins/data/common/constants.ts b/src/plugins/data/common/constants.ts
index 22db1552e4303..43120583bd3a4 100644
--- a/src/plugins/data/common/constants.ts
+++ b/src/plugins/data/common/constants.ts
@@ -32,6 +32,7 @@ export const UI_SETTINGS = {
COURIER_MAX_CONCURRENT_SHARD_REQUESTS: 'courier:maxConcurrentShardRequests',
COURIER_BATCH_SEARCHES: 'courier:batchSearches',
SEARCH_INCLUDE_FROZEN: 'search:includeFrozen',
+ SEARCH_TIMEOUT: 'search:timeout',
HISTOGRAM_BAR_TARGET: 'histogram:barTarget',
HISTOGRAM_MAX_BARS: 'histogram:maxBars',
HISTORY_LIMIT: 'history:limit',
diff --git a/src/plugins/data/common/field_formats/converters/duration.test.ts b/src/plugins/data/common/field_formats/converters/duration.test.ts
index d6205d54bd702..69163842f3498 100644
--- a/src/plugins/data/common/field_formats/converters/duration.test.ts
+++ b/src/plugins/data/common/field_formats/converters/duration.test.ts
@@ -24,11 +24,16 @@ describe('Duration Format', () => {
inputFormat: 'seconds',
outputFormat: 'humanize',
outputPrecision: undefined,
+ showSuffix: undefined,
fixtures: [
{
input: -60,
output: 'minus a minute',
},
+ {
+ input: 1,
+ output: 'a few seconds',
+ },
{
input: 60,
output: 'a minute',
@@ -44,6 +49,7 @@ describe('Duration Format', () => {
inputFormat: 'minutes',
outputFormat: 'humanize',
outputPrecision: undefined,
+ showSuffix: undefined,
fixtures: [
{
input: -60,
@@ -64,6 +70,7 @@ describe('Duration Format', () => {
inputFormat: 'minutes',
outputFormat: 'asHours',
outputPrecision: undefined,
+ showSuffix: undefined,
fixtures: [
{
input: -60,
@@ -84,6 +91,7 @@ describe('Duration Format', () => {
inputFormat: 'seconds',
outputFormat: 'asSeconds',
outputPrecision: 0,
+ showSuffix: undefined,
fixtures: [
{
input: -60,
@@ -104,6 +112,7 @@ describe('Duration Format', () => {
inputFormat: 'seconds',
outputFormat: 'asSeconds',
outputPrecision: 2,
+ showSuffix: undefined,
fixtures: [
{
input: -60,
@@ -124,15 +133,34 @@ describe('Duration Format', () => {
],
});
+ testCase({
+ inputFormat: 'seconds',
+ outputFormat: 'asSeconds',
+ outputPrecision: 0,
+ showSuffix: true,
+ fixtures: [
+ {
+ input: -60,
+ output: '-60 Seconds',
+ },
+ {
+ input: -32.333,
+ output: '-32 Seconds',
+ },
+ ],
+ });
+
function testCase({
inputFormat,
outputFormat,
outputPrecision,
+ showSuffix,
fixtures,
}: {
inputFormat: string;
outputFormat: string;
outputPrecision: number | undefined;
+ showSuffix: boolean | undefined;
fixtures: any[];
}) {
fixtures.forEach((fixture: Record) => {
@@ -143,7 +171,7 @@ describe('Duration Format', () => {
outputPrecision ? `, ${outputPrecision} decimals` : ''
}`, () => {
const duration = new DurationFormat(
- { inputFormat, outputFormat, outputPrecision },
+ { inputFormat, outputFormat, outputPrecision, showSuffix },
jest.fn()
);
expect(duration.convert(input)).toBe(output);
diff --git a/src/plugins/data/common/field_formats/converters/duration.ts b/src/plugins/data/common/field_formats/converters/duration.ts
index 53c2aba98120e..a3ce3d4dfd795 100644
--- a/src/plugins/data/common/field_formats/converters/duration.ts
+++ b/src/plugins/data/common/field_formats/converters/duration.ts
@@ -190,6 +190,7 @@ export class DurationFormat extends FieldFormat {
const inputFormat = this.param('inputFormat');
const outputFormat = this.param('outputFormat') as keyof Duration;
const outputPrecision = this.param('outputPrecision');
+ const showSuffix = Boolean(this.param('showSuffix'));
const human = this.isHuman();
const prefix =
val < 0 && human
@@ -200,6 +201,9 @@ export class DurationFormat extends FieldFormat {
const duration = parseInputAsDuration(val, inputFormat) as Record;
const formatted = duration[outputFormat]();
const precise = human ? formatted : formatted.toFixed(outputPrecision);
- return prefix + precise;
+ const type = outputFormats.find(({ method }) => method === outputFormat);
+ const suffix = showSuffix && type ? ` ${type.text}` : '';
+
+ return prefix + precise + suffix;
};
}
diff --git a/src/plugins/data/common/search/es_search/index.ts b/src/plugins/data/common/search/es_search/index.ts
index 54757b53b8665..d8f7b5091eb8f 100644
--- a/src/plugins/data/common/search/es_search/index.ts
+++ b/src/plugins/data/common/search/es_search/index.ts
@@ -17,10 +17,4 @@
* under the License.
*/
-export {
- ISearchRequestParams,
- IEsSearchRequest,
- IEsSearchResponse,
- ES_SEARCH_STRATEGY,
- ISearchOptions,
-} from './types';
+export * from './types';
diff --git a/src/plugins/data/common/search/es_search/types.ts b/src/plugins/data/common/search/es_search/types.ts
index 89faa5b7119c8..81124c1e095f7 100644
--- a/src/plugins/data/common/search/es_search/types.ts
+++ b/src/plugins/data/common/search/es_search/types.ts
@@ -53,3 +53,6 @@ export interface IEsSearchResponse extends IKibanaSearchResponse {
isPartial?: boolean;
rawResponse: SearchResponse;
}
+
+export const isEsResponse = (response: any): response is IEsSearchResponse =>
+ response && response.rawResponse;
diff --git a/src/plugins/data/common/search/index.ts b/src/plugins/data/common/search/index.ts
index 3bfb0ddb89aa9..061974d860246 100644
--- a/src/plugins/data/common/search/index.ts
+++ b/src/plugins/data/common/search/index.ts
@@ -22,11 +22,4 @@ export * from './es_search';
export * from './expressions';
export * from './tabify';
export * from './types';
-
-export {
- IEsSearchRequest,
- IEsSearchResponse,
- ES_SEARCH_STRATEGY,
- ISearchRequestParams,
- ISearchOptions,
-} from './es_search';
+export * from './es_search';
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
index f7b4111df5172..553ee6bde5f2d 100644
--- a/src/plugins/data/public/index.ts
+++ b/src/plugins/data/public/index.ts
@@ -429,6 +429,7 @@ export {
TimeHistory,
TimefilterContract,
TimeHistoryContract,
+ QueryStateChange,
} from './query';
export {
diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
index a3de45189a85d..27d4ea49f9eb1 100644
--- a/src/plugins/data/public/public.api.md
+++ b/src/plugins/data/public/public.api.md
@@ -693,7 +693,6 @@ export const getKbnTypeNames: () => string[];
//
// @public (undocumented)
export function getSearchParamsFromRequest(searchRequest: SearchRequest, dependencies: {
- esShardTimeout: number;
getConfig: GetConfigFn;
}): ISearchRequestParams;
@@ -1465,6 +1464,17 @@ export interface QueryState {
time?: TimeRange;
}
+// Warning: (ae-forgotten-export) The symbol "QueryStateChangePartial" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "QueryStateChange" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface QueryStateChange extends QueryStateChangePartial {
+ // (undocumented)
+ appFilters?: boolean;
+ // (undocumented)
+ globalFilters?: boolean;
+}
+
// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "QueryStringInput" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -1682,8 +1692,8 @@ export const search: {
// Warning: (ae-missing-release-tag) "SearchBar" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
-export const SearchBar: React.ComponentClass, "query" | "isLoading" | "filters" | "onRefresh" | "onRefreshChange" | "refreshInterval" | "indexPatterns" | "dataTestSubj" | "customSubmitButton" | "screenTitle" | "showQueryBar" | "showQueryInput" | "showFilterBar" | "showDatePicker" | "showAutoRefreshOnly" | "isRefreshPaused" | "dateRangeFrom" | "dateRangeTo" | "showSaveQuery" | "savedQuery" | "onQueryChange" | "onQuerySubmit" | "onSaved" | "onSavedQueryUpdated" | "onClearSavedQuery" | "indicateNoData" | "timeHistory" | "onFiltersUpdated">, any> & {
- WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>;
+export const SearchBar: React.ComponentClass, "query" | "isLoading" | "filters" | "onRefresh" | "onRefreshChange" | "refreshInterval" | "indexPatterns" | "dataTestSubj" | "timeHistory" | "customSubmitButton" | "screenTitle" | "showQueryBar" | "showQueryInput" | "showFilterBar" | "showDatePicker" | "showAutoRefreshOnly" | "isRefreshPaused" | "dateRangeFrom" | "dateRangeTo" | "showSaveQuery" | "savedQuery" | "onQueryChange" | "onQuerySubmit" | "onSaved" | "onSavedQueryUpdated" | "onClearSavedQuery" | "indicateNoData" | "onFiltersUpdated">, any> & {
+ WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>;
};
// Warning: (ae-forgotten-export) The symbol "SearchBarOwnProps" needs to be exported by the entry point index.d.ts
@@ -1715,7 +1725,7 @@ export interface SearchError {
//
// @public (undocumented)
export class SearchInterceptor {
- constructor(deps: SearchInterceptorDeps, requestTimeout?: number | undefined);
+ constructor(deps: SearchInterceptorDeps);
// @internal
protected abortController: AbortController;
// @internal (undocumented)
@@ -1729,13 +1739,14 @@ export class SearchInterceptor {
protected longRunningToast?: Toast;
// @internal
protected pendingCount$: BehaviorSubject;
- // (undocumented)
- protected readonly requestTimeout?: number | undefined;
- // (undocumented)
+ // @internal (undocumented)
protected runSearch(request: IEsSearchRequest, signal: AbortSignal, strategy?: string): Observable;
search(request: IEsSearchRequest, options?: ISearchOptions): Observable;
- // (undocumented)
- protected setupTimers(options?: ISearchOptions): {
+ // @internal (undocumented)
+ protected setupAbortSignal({ abortSignal, timeout, }: {
+ abortSignal?: AbortSignal;
+ timeout?: number;
+ }): {
combinedSignal: AbortSignal;
cleanup: () => void;
};
@@ -1906,6 +1917,7 @@ export const UI_SETTINGS: {
readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: "courier:maxConcurrentShardRequests";
readonly COURIER_BATCH_SEARCHES: "courier:batchSearches";
readonly SEARCH_INCLUDE_FROZEN: "search:includeFrozen";
+ readonly SEARCH_TIMEOUT: "search:timeout";
readonly HISTOGRAM_BAR_TARGET: "histogram:barTarget";
readonly HISTOGRAM_MAX_BARS: "histogram:maxBars";
readonly HISTORY_LIMIT: "history:limit";
diff --git a/src/plugins/data/public/search/fetch/get_search_params.test.ts b/src/plugins/data/public/search/fetch/get_search_params.test.ts
index 1ecb879b1602d..5e83e1f57bb6d 100644
--- a/src/plugins/data/public/search/fetch/get_search_params.test.ts
+++ b/src/plugins/data/public/search/fetch/get_search_params.test.ts
@@ -25,44 +25,12 @@ function getConfigStub(config: any = {}): GetConfigFn {
}
describe('getSearchParams', () => {
- test('includes rest_total_hits_as_int', () => {
- const config = getConfigStub();
+ test('includes custom preference', () => {
+ const config = getConfigStub({
+ [UI_SETTINGS.COURIER_SET_REQUEST_PREFERENCE]: 'custom',
+ [UI_SETTINGS.COURIER_CUSTOM_REQUEST_PREFERENCE]: 'aaa',
+ });
const searchParams = getSearchParams(config);
- expect(searchParams.rest_total_hits_as_int).toBe(true);
- });
-
- test('includes ignore_unavailable', () => {
- const config = getConfigStub();
- const searchParams = getSearchParams(config);
- expect(searchParams.ignore_unavailable).toBe(true);
- });
-
- test('includes ignore_throttled according to search:includeFrozen', () => {
- let config = getConfigStub({ [UI_SETTINGS.SEARCH_INCLUDE_FROZEN]: true });
- let searchParams = getSearchParams(config);
- expect(searchParams.ignore_throttled).toBe(false);
-
- config = getConfigStub({ [UI_SETTINGS.SEARCH_INCLUDE_FROZEN]: false });
- searchParams = getSearchParams(config);
- expect(searchParams.ignore_throttled).toBe(true);
- });
-
- test('includes max_concurrent_shard_requests according to courier:maxConcurrentShardRequests', () => {
- let config = getConfigStub({ [UI_SETTINGS.COURIER_MAX_CONCURRENT_SHARD_REQUESTS]: 0 });
- let searchParams = getSearchParams(config);
- expect(searchParams.max_concurrent_shard_requests).toBe(undefined);
-
- config = getConfigStub({ [UI_SETTINGS.COURIER_MAX_CONCURRENT_SHARD_REQUESTS]: 5 });
- searchParams = getSearchParams(config);
- expect(searchParams.max_concurrent_shard_requests).toBe(5);
- });
-
- test('includes timeout according to esShardTimeout if greater than 0', () => {
- const config = getConfigStub();
- let searchParams = getSearchParams(config, 0);
- expect(searchParams.timeout).toBe(undefined);
-
- searchParams = getSearchParams(config, 100);
- expect(searchParams.timeout).toBe('100ms');
+ expect(searchParams.preference).toBe('aaa');
});
});
diff --git a/src/plugins/data/public/search/fetch/get_search_params.ts b/src/plugins/data/public/search/fetch/get_search_params.ts
index 5e0395189f647..ed87c4813951c 100644
--- a/src/plugins/data/public/search/fetch/get_search_params.ts
+++ b/src/plugins/data/public/search/fetch/get_search_params.ts
@@ -22,26 +22,12 @@ import { SearchRequest } from './types';
const sessionId = Date.now();
-export function getSearchParams(getConfig: GetConfigFn, esShardTimeout: number = 0) {
+export function getSearchParams(getConfig: GetConfigFn) {
return {
- rest_total_hits_as_int: true,
- ignore_unavailable: true,
- ignore_throttled: getIgnoreThrottled(getConfig),
- max_concurrent_shard_requests: getMaxConcurrentShardRequests(getConfig),
preference: getPreference(getConfig),
- timeout: getTimeout(esShardTimeout),
};
}
-export function getIgnoreThrottled(getConfig: GetConfigFn) {
- return !getConfig(UI_SETTINGS.SEARCH_INCLUDE_FROZEN);
-}
-
-export function getMaxConcurrentShardRequests(getConfig: GetConfigFn) {
- const maxConcurrentShardRequests = getConfig(UI_SETTINGS.COURIER_MAX_CONCURRENT_SHARD_REQUESTS);
- return maxConcurrentShardRequests > 0 ? maxConcurrentShardRequests : undefined;
-}
-
export function getPreference(getConfig: GetConfigFn) {
const setRequestPreference = getConfig(UI_SETTINGS.COURIER_SET_REQUEST_PREFERENCE);
if (setRequestPreference === 'sessionId') return sessionId;
@@ -50,19 +36,15 @@ export function getPreference(getConfig: GetConfigFn) {
: undefined;
}
-export function getTimeout(esShardTimeout: number) {
- return esShardTimeout > 0 ? `${esShardTimeout}ms` : undefined;
-}
-
/** @public */
// TODO: Could provide this on runtime contract with dependencies
// already wired up.
export function getSearchParamsFromRequest(
searchRequest: SearchRequest,
- dependencies: { esShardTimeout: number; getConfig: GetConfigFn }
+ dependencies: { getConfig: GetConfigFn }
): ISearchRequestParams {
- const { esShardTimeout, getConfig } = dependencies;
- const searchParams = getSearchParams(getConfig, esShardTimeout);
+ const { getConfig } = dependencies;
+ const searchParams = getSearchParams(getConfig);
return {
index: searchRequest.index.title || searchRequest.index,
diff --git a/src/plugins/data/public/search/fetch/index.ts b/src/plugins/data/public/search/fetch/index.ts
index 79cdad1897f9c..4b8511edfc26f 100644
--- a/src/plugins/data/public/search/fetch/index.ts
+++ b/src/plugins/data/public/search/fetch/index.ts
@@ -18,14 +18,7 @@
*/
export * from './types';
-export {
- getSearchParams,
- getSearchParamsFromRequest,
- getPreference,
- getTimeout,
- getIgnoreThrottled,
- getMaxConcurrentShardRequests,
-} from './get_search_params';
+export { getSearchParams, getSearchParamsFromRequest, getPreference } from './get_search_params';
export { RequestFailure } from './request_error';
export { handleResponse } from './handle_response';
diff --git a/src/plugins/data/public/search/legacy/call_client.test.ts b/src/plugins/data/public/search/legacy/call_client.test.ts
index 38f3ab200da90..943a02d22088d 100644
--- a/src/plugins/data/public/search/legacy/call_client.test.ts
+++ b/src/plugins/data/public/search/legacy/call_client.test.ts
@@ -60,7 +60,6 @@ describe('callClient', () => {
http: coreMock.createStart().http,
legacySearchService: {},
config: { get: jest.fn() },
- esShardTimeout: 0,
loadingCount$: new BehaviorSubject(0),
} as FetchHandlers;
diff --git a/src/plugins/data/public/search/search_interceptor.test.ts b/src/plugins/data/public/search/search_interceptor.test.ts
index da60f39b522ac..84db69a83a005 100644
--- a/src/plugins/data/public/search/search_interceptor.test.ts
+++ b/src/plugins/data/public/search/search_interceptor.test.ts
@@ -32,15 +32,12 @@ jest.useFakeTimers();
describe('SearchInterceptor', () => {
beforeEach(() => {
mockCoreSetup = coreMock.createSetup();
- searchInterceptor = new SearchInterceptor(
- {
- toasts: mockCoreSetup.notifications.toasts,
- startServices: mockCoreSetup.getStartServices(),
- uiSettings: mockCoreSetup.uiSettings,
- http: mockCoreSetup.http,
- },
- 1000
- );
+ searchInterceptor = new SearchInterceptor({
+ toasts: mockCoreSetup.notifications.toasts,
+ startServices: mockCoreSetup.getStartServices(),
+ uiSettings: mockCoreSetup.uiSettings,
+ http: mockCoreSetup.http,
+ });
});
describe('search', () => {
diff --git a/src/plugins/data/public/search/search_interceptor.ts b/src/plugins/data/public/search/search_interceptor.ts
index c6c03267163c9..0a6d60afed2f7 100644
--- a/src/plugins/data/public/search/search_interceptor.ts
+++ b/src/plugins/data/public/search/search_interceptor.ts
@@ -18,7 +18,16 @@
*/
import { trimEnd } from 'lodash';
-import { BehaviorSubject, throwError, timer, Subscription, defer, from, Observable } from 'rxjs';
+import {
+ BehaviorSubject,
+ throwError,
+ timer,
+ Subscription,
+ defer,
+ from,
+ Observable,
+ NEVER,
+} from 'rxjs';
import { finalize, filter } from 'rxjs/operators';
import { Toast, CoreStart, ToastsSetup, CoreSetup } from 'kibana/public';
import { getCombinedSignal, AbortError } from '../../common/utils';
@@ -71,17 +80,10 @@ export class SearchInterceptor {
*/
protected application!: CoreStart['application'];
- /**
- * This class should be instantiated with a `requestTimeout` corresponding with how many ms after
- * requests are initiated that they should automatically cancel.
- * @param toasts The `core.notifications.toasts` service
- * @param application The `core.application` service
- * @param requestTimeout Usually config value `elasticsearch.requestTimeout`
+ /*
+ * @internal
*/
- constructor(
- protected readonly deps: SearchInterceptorDeps,
- protected readonly requestTimeout?: number
- ) {
+ constructor(protected readonly deps: SearchInterceptorDeps) {
this.deps.http.addLoadingCountSource(this.pendingCount$);
this.deps.startServices.then(([coreStart]) => {
@@ -94,7 +96,6 @@ export class SearchInterceptor {
.pipe(filter((count) => count === 0))
.subscribe(this.hideToast);
}
-
/**
* Returns an `Observable` over the current number of pending searches. This could mean that one
* of the search requests is still in flight, or that it has only received partial responses.
@@ -103,6 +104,9 @@ export class SearchInterceptor {
return this.pendingCount$.asObservable();
}
+ /**
+ * @internal
+ */
protected runSearch(
request: IEsSearchRequest,
signal: AbortSignal,
@@ -136,7 +140,9 @@ export class SearchInterceptor {
return throwError(new AbortError());
}
- const { combinedSignal, cleanup } = this.setupTimers(options);
+ const { combinedSignal, cleanup } = this.setupAbortSignal({
+ abortSignal: options?.abortSignal,
+ });
this.pendingCount$.next(this.pendingCount$.getValue() + 1);
return this.runSearch(request, combinedSignal, options?.strategy).pipe(
@@ -148,11 +154,20 @@ export class SearchInterceptor {
});
}
- protected setupTimers(options?: ISearchOptions) {
+ /**
+ * @internal
+ */
+ protected setupAbortSignal({
+ abortSignal,
+ timeout,
+ }: {
+ abortSignal?: AbortSignal;
+ timeout?: number;
+ }) {
// Schedule this request to automatically timeout after some interval
const timeoutController = new AbortController();
const { signal: timeoutSignal } = timeoutController;
- const timeout$ = timer(this.requestTimeout);
+ const timeout$ = timeout ? timer(timeout) : NEVER;
const subscription = timeout$.subscribe(() => {
timeoutController.abort();
});
@@ -168,7 +183,7 @@ export class SearchInterceptor {
const signals = [
this.abortController.signal,
timeoutSignal,
- ...(options?.abortSignal ? [options.abortSignal] : []),
+ ...(abortSignal ? [abortSignal] : []),
];
const combinedSignal = getCombinedSignal(signals);
diff --git a/src/plugins/data/public/search/search_service.ts b/src/plugins/data/public/search/search_service.ts
index a49d2ef0956ff..f8f4acbe43dfd 100644
--- a/src/plugins/data/public/search/search_service.ts
+++ b/src/plugins/data/public/search/search_service.ts
@@ -52,26 +52,19 @@ export class SearchService implements Plugin {
{ http, getStartServices, injectedMetadata, notifications, uiSettings }: CoreSetup,
{ expressions, usageCollection }: SearchServiceSetupDependencies
): ISearchSetup {
- const esRequestTimeout = injectedMetadata.getInjectedVar('esRequestTimeout') as number;
-
this.usageCollector = createUsageCollector(getStartServices, usageCollection);
/**
* A global object that intercepts all searches and provides convenience methods for cancelling
* all pending search requests, as well as getting the number of pending search requests.
- * TODO: Make this modular so that apps can opt in/out of search collection, or even provide
- * their own search collector instances
*/
- this.searchInterceptor = new SearchInterceptor(
- {
- toasts: notifications.toasts,
- http,
- uiSettings,
- startServices: getStartServices(),
- usageCollector: this.usageCollector!,
- },
- esRequestTimeout
- );
+ this.searchInterceptor = new SearchInterceptor({
+ toasts: notifications.toasts,
+ http,
+ uiSettings,
+ startServices: getStartServices(),
+ usageCollector: this.usageCollector!,
+ });
expressions.registerFunction(esdsl);
expressions.registerType(esRawResponse);
@@ -101,8 +94,6 @@ export class SearchService implements Plugin {
const searchSourceDependencies: SearchSourceDependencies = {
getConfig: uiSettings.get.bind(uiSettings),
- // TODO: we don't need this, apply on the server
- esShardTimeout: injectedMetadata.getInjectedVar('esShardTimeout') as number,
search,
http,
loadingCount$,
diff --git a/src/plugins/data/public/search/search_source/create_search_source.test.ts b/src/plugins/data/public/search/search_source/create_search_source.test.ts
index 2820aab67ea3a..bc1c7c06c8806 100644
--- a/src/plugins/data/public/search/search_source/create_search_source.test.ts
+++ b/src/plugins/data/public/search/search_source/create_search_source.test.ts
@@ -35,7 +35,6 @@ describe('createSearchSource', () => {
dependencies = {
getConfig: jest.fn(),
search: jest.fn(),
- esShardTimeout: 30000,
http: coreMock.createStart().http,
loadingCount$: new BehaviorSubject(0),
};
diff --git a/src/plugins/data/public/search/search_source/mocks.ts b/src/plugins/data/public/search/search_source/mocks.ts
index bc3e287d9fe80..adf53bee33fe1 100644
--- a/src/plugins/data/public/search/search_source/mocks.ts
+++ b/src/plugins/data/public/search/search_source/mocks.ts
@@ -53,7 +53,6 @@ export const searchSourceMock = {
export const createSearchSourceMock = (fields?: SearchSourceFields) =>
new SearchSource(fields, {
getConfig: uiSettingsServiceMock.createStartContract().get,
- esShardTimeout: 30000,
search: jest.fn(),
http: httpServiceMock.createStartContract(),
loadingCount$: new BehaviorSubject(0),
diff --git a/src/plugins/data/public/search/search_source/search_source.test.ts b/src/plugins/data/public/search/search_source/search_source.test.ts
index a8baed9faa84d..282a33e6d01f7 100644
--- a/src/plugins/data/public/search/search_source/search_source.test.ts
+++ b/src/plugins/data/public/search/search_source/search_source.test.ts
@@ -68,7 +68,6 @@ describe('SearchSource', () => {
searchSourceDependencies = {
getConfig: jest.fn(),
search: mockSearchMethod,
- esShardTimeout: 30000,
http: coreMock.createStart().http,
loadingCount$: new BehaviorSubject(0),
};
diff --git a/src/plugins/data/public/search/search_source/search_source.ts b/src/plugins/data/public/search/search_source/search_source.ts
index eec2d9b50eafe..68c7b663b3628 100644
--- a/src/plugins/data/public/search/search_source/search_source.ts
+++ b/src/plugins/data/public/search/search_source/search_source.ts
@@ -118,7 +118,6 @@ export interface SearchSourceDependencies {
getConfig: GetConfigFn;
search: ISearchGeneric;
http: HttpStart;
- esShardTimeout: number;
loadingCount$: BehaviorSubject;
}
@@ -233,10 +232,9 @@ export class SearchSource {
* @return {Observable>}
*/
private fetch$(searchRequest: SearchRequest, options: ISearchOptions) {
- const { search, esShardTimeout, getConfig } = this.dependencies;
+ const { search, getConfig } = this.dependencies;
const params = getSearchParamsFromRequest(searchRequest, {
- esShardTimeout,
getConfig,
});
diff --git a/src/plugins/data/server/index.ts b/src/plugins/data/server/index.ts
index 71ed83290e697..03baff4910309 100644
--- a/src/plugins/data/server/index.ts
+++ b/src/plugins/data/server/index.ts
@@ -212,8 +212,11 @@ export {
ISearchStrategy,
ISearchSetup,
ISearchStart,
+ toSnakeCase,
getDefaultSearchParams,
+ getShardTimeout,
getTotalLoaded,
+ shimHitsTotal,
usageProvider,
SearchUsage,
} from './search';
diff --git a/src/plugins/data/server/search/es_search/es_search_strategy.test.ts b/src/plugins/data/server/search/es_search/es_search_strategy.test.ts
index c34c3a310814c..504ce728481f0 100644
--- a/src/plugins/data/server/search/es_search/es_search_strategy.test.ts
+++ b/src/plugins/data/server/search/es_search/es_search_strategy.test.ts
@@ -36,7 +36,14 @@ describe('ES search strategy', () => {
},
});
const mockContext = {
- core: { elasticsearch: { client: { asCurrentUser: { search: mockApiCaller } } } },
+ core: {
+ uiSettings: {
+ client: {
+ get: () => {},
+ },
+ },
+ elasticsearch: { client: { asCurrentUser: { search: mockApiCaller } } },
+ },
};
const mockConfig$ = pluginInitializerContextConfigMock({}).legacy.globalConfig$;
@@ -59,14 +66,13 @@ describe('ES search strategy', () => {
expect(mockApiCaller).toBeCalled();
expect(mockApiCaller.mock.calls[0][0]).toEqual({
...params,
- timeout: '0ms',
- ignoreUnavailable: true,
- restTotalHitsAsInt: true,
+ ignore_unavailable: true,
+ track_total_hits: true,
});
});
it('calls the API caller with overridden defaults', async () => {
- const params = { index: 'logstash-*', ignoreUnavailable: false, timeout: '1000ms' };
+ const params = { index: 'logstash-*', ignore_unavailable: false, timeout: '1000ms' };
const esSearch = await esSearchStrategyProvider(mockConfig$, mockLogger);
await esSearch.search((mockContext as unknown) as RequestHandlerContext, { params });
@@ -74,7 +80,7 @@ describe('ES search strategy', () => {
expect(mockApiCaller).toBeCalled();
expect(mockApiCaller.mock.calls[0][0]).toEqual({
...params,
- restTotalHitsAsInt: true,
+ track_total_hits: true,
});
});
diff --git a/src/plugins/data/server/search/es_search/es_search_strategy.ts b/src/plugins/data/server/search/es_search/es_search_strategy.ts
index eabbf3e3e2600..106f974ed3457 100644
--- a/src/plugins/data/server/search/es_search/es_search_strategy.ts
+++ b/src/plugins/data/server/search/es_search/es_search_strategy.ts
@@ -22,7 +22,8 @@ import { SearchResponse } from 'elasticsearch';
import { Observable } from 'rxjs';
import { ApiResponse } from '@elastic/elasticsearch';
import { SearchUsage } from '../collectors/usage';
-import { ISearchStrategy, getDefaultSearchParams, getTotalLoaded } from '..';
+import { toSnakeCase } from './to_snake_case';
+import { ISearchStrategy, getDefaultSearchParams, getTotalLoaded, getShardTimeout } from '..';
export const esSearchStrategyProvider = (
config$: Observable,
@@ -33,7 +34,7 @@ export const esSearchStrategyProvider = (
search: async (context, request, options) => {
logger.debug(`search ${request.params?.index}`);
const config = await config$.pipe(first()).toPromise();
- const defaultParams = getDefaultSearchParams(config);
+ const uiSettingsClient = await context.core.uiSettings.client;
// Only default index pattern type is supported here.
// See data_enhanced for other type support.
@@ -41,10 +42,14 @@ export const esSearchStrategyProvider = (
throw new Error(`Unsupported index pattern type ${request.indexType}`);
}
- const params = {
+ // ignoreThrottled is not supported in OSS
+ const { ignoreThrottled, ...defaultParams } = await getDefaultSearchParams(uiSettingsClient);
+
+ const params = toSnakeCase({
...defaultParams,
+ ...getShardTimeout(config),
...request.params,
- };
+ });
try {
const esResponse = (await context.core.elasticsearch.client.asCurrentUser.search(
diff --git a/src/plugins/data/server/search/es_search/get_default_search_params.ts b/src/plugins/data/server/search/es_search/get_default_search_params.ts
index b2341ccc0f3c8..13607fce51670 100644
--- a/src/plugins/data/server/search/es_search/get_default_search_params.ts
+++ b/src/plugins/data/server/search/es_search/get_default_search_params.ts
@@ -17,12 +17,28 @@
* under the License.
*/
-import { SharedGlobalConfig } from '../../../../../core/server';
+import { SharedGlobalConfig, IUiSettingsClient } from '../../../../../core/server';
+import { UI_SETTINGS } from '../../../common/constants';
-export function getDefaultSearchParams(config: SharedGlobalConfig) {
+export function getShardTimeout(config: SharedGlobalConfig) {
+ const timeout = config.elasticsearch.shardTimeout.asMilliseconds();
+ return timeout
+ ? {
+ timeout: `${timeout}ms`,
+ }
+ : {};
+}
+
+export async function getDefaultSearchParams(uiSettingsClient: IUiSettingsClient) {
+ const ignoreThrottled = !(await uiSettingsClient.get(UI_SETTINGS.SEARCH_INCLUDE_FROZEN));
+ const maxConcurrentShardRequests = await uiSettingsClient.get(
+ UI_SETTINGS.COURIER_MAX_CONCURRENT_SHARD_REQUESTS
+ );
return {
- timeout: `${config.elasticsearch.shardTimeout.asMilliseconds()}ms`,
+ maxConcurrentShardRequests:
+ maxConcurrentShardRequests > 0 ? maxConcurrentShardRequests : undefined,
+ ignoreThrottled,
ignoreUnavailable: true, // Don't fail if the index/indices don't exist
- restTotalHitsAsInt: true, // Get the number of hits as an int rather than a range
+ trackTotalHits: true,
};
}
diff --git a/src/plugins/data/server/search/es_search/index.ts b/src/plugins/data/server/search/es_search/index.ts
index 20006b70730d8..1bd17fc986168 100644
--- a/src/plugins/data/server/search/es_search/index.ts
+++ b/src/plugins/data/server/search/es_search/index.ts
@@ -17,7 +17,9 @@
* under the License.
*/
-export { ES_SEARCH_STRATEGY, IEsSearchRequest, IEsSearchResponse } from '../../../common/search';
export { esSearchStrategyProvider } from './es_search_strategy';
-export { getDefaultSearchParams } from './get_default_search_params';
+export * from './get_default_search_params';
export { getTotalLoaded } from './get_total_loaded';
+export * from './to_snake_case';
+
+export { ES_SEARCH_STRATEGY, IEsSearchRequest, IEsSearchResponse } from '../../../common';
diff --git a/src/legacy/utils/path_contains.js b/src/plugins/data/server/search/es_search/to_snake_case.ts
similarity index 83%
rename from src/legacy/utils/path_contains.js
rename to src/plugins/data/server/search/es_search/to_snake_case.ts
index 60d05c1099554..74f156274cbc6 100644
--- a/src/legacy/utils/path_contains.js
+++ b/src/plugins/data/server/search/es_search/to_snake_case.ts
@@ -17,8 +17,8 @@
* under the License.
*/
-import { relative } from 'path';
+import { mapKeys, snakeCase } from 'lodash';
-export default function pathContains(root, child) {
- return relative(child, root).slice(0, 2) !== '..';
+export function toSnakeCase(obj: Record) {
+ return mapKeys(obj, (value, key) => snakeCase(key));
}
diff --git a/src/plugins/data/server/search/index.ts b/src/plugins/data/server/search/index.ts
index 8a74c51f52f51..b671ed806510b 100644
--- a/src/plugins/data/server/search/index.ts
+++ b/src/plugins/data/server/search/index.ts
@@ -19,8 +19,10 @@
export { ISearchStrategy, ISearchSetup, ISearchStart, SearchEnhancements } from './types';
-export { getDefaultSearchParams, getTotalLoaded } from './es_search';
+export * from './es_search';
export { usageProvider, SearchUsage } from './collectors';
export * from './aggs';
+
+export { shimHitsTotal } from './routes';
diff --git a/src/plugins/data/server/search/routes/index.ts b/src/plugins/data/server/search/routes/index.ts
index 2217890ff778e..a290f08f9b843 100644
--- a/src/plugins/data/server/search/routes/index.ts
+++ b/src/plugins/data/server/search/routes/index.ts
@@ -19,3 +19,4 @@
export * from './msearch';
export * from './search';
+export * from './shim_hits_total';
diff --git a/src/plugins/data/server/search/routes/msearch.test.ts b/src/plugins/data/server/search/routes/msearch.test.ts
index 0a52cf23c5472..3a7d67c31b8be 100644
--- a/src/plugins/data/server/search/routes/msearch.test.ts
+++ b/src/plugins/data/server/search/routes/msearch.test.ts
@@ -48,7 +48,7 @@ describe('msearch route', () => {
});
it('handler calls /_msearch with the given request', async () => {
- const response = { id: 'yay' };
+ const response = { id: 'yay', body: { responses: [{ hits: { total: 5 } }] } };
const mockClient = { transport: { request: jest.fn().mockResolvedValue(response) } };
const mockContext = {
core: {
@@ -73,7 +73,7 @@ describe('msearch route', () => {
expect(mockClient.transport.request.mock.calls[0][0].method).toBe('GET');
expect(mockClient.transport.request.mock.calls[0][0].path).toBe('/_msearch');
expect(mockClient.transport.request.mock.calls[0][0].body).toEqual(
- convertRequestBody(mockBody as any, { timeout: '0ms' })
+ convertRequestBody(mockBody as any, {})
);
expect(mockResponse.ok).toBeCalled();
expect(mockResponse.ok.mock.calls[0][0]).toEqual({
diff --git a/src/plugins/data/server/search/routes/msearch.ts b/src/plugins/data/server/search/routes/msearch.ts
index efb40edd90d58..e1ddb06e4fb6f 100644
--- a/src/plugins/data/server/search/routes/msearch.ts
+++ b/src/plugins/data/server/search/routes/msearch.ts
@@ -20,10 +20,11 @@
import { first } from 'rxjs/operators';
import { schema } from '@kbn/config-schema';
+import { SearchResponse } from 'elasticsearch';
import { IRouter } from 'src/core/server';
-import { UI_SETTINGS } from '../../../common';
import { SearchRouteDependencies } from '../search_service';
-import { getDefaultSearchParams } from '..';
+import { shimHitsTotal } from './shim_hits_total';
+import { getShardTimeout, getDefaultSearchParams, toSnakeCase } from '..';
interface MsearchHeaders {
index: string;
@@ -96,30 +97,31 @@ export function registerMsearchRoute(router: IRouter, deps: SearchRouteDependenc
// get shardTimeout
const config = await deps.globalConfig$.pipe(first()).toPromise();
- const { timeout } = getDefaultSearchParams(config);
+ const timeout = getShardTimeout(config);
- const body = convertRequestBody(request.body, { timeout });
+ const body = convertRequestBody(request.body, timeout);
+
+ // trackTotalHits is not supported by msearch
+ const { trackTotalHits, ...defaultParams } = await getDefaultSearchParams(
+ context.core.uiSettings.client
+ );
try {
- const ignoreThrottled = !(await context.core.uiSettings.client.get(
- UI_SETTINGS.SEARCH_INCLUDE_FROZEN
- ));
- const maxConcurrentShardRequests = await context.core.uiSettings.client.get(
- UI_SETTINGS.COURIER_MAX_CONCURRENT_SHARD_REQUESTS
- );
const response = await client.transport.request({
method: 'GET',
path: '/_msearch',
body,
- querystring: {
- rest_total_hits_as_int: true,
- ignore_throttled: ignoreThrottled,
- max_concurrent_shard_requests:
- maxConcurrentShardRequests > 0 ? maxConcurrentShardRequests : undefined,
- },
+ querystring: toSnakeCase(defaultParams),
});
- return res.ok({ body: response });
+ return res.ok({
+ body: {
+ ...response,
+ body: {
+ responses: response.body.responses?.map((r: SearchResponse) => shimHitsTotal(r)),
+ },
+ },
+ });
} catch (err) {
return res.customError({
statusCode: err.statusCode || 500,
diff --git a/src/plugins/data/server/search/routes/search.ts b/src/plugins/data/server/search/routes/search.ts
index 4340285583489..b5d5ec283767d 100644
--- a/src/plugins/data/server/search/routes/search.ts
+++ b/src/plugins/data/server/search/routes/search.ts
@@ -21,6 +21,8 @@ import { schema } from '@kbn/config-schema';
import { IRouter } from 'src/core/server';
import { getRequestAbortedSignal } from '../../lib';
import { SearchRouteDependencies } from '../search_service';
+import { shimHitsTotal } from './shim_hits_total';
+import { isEsResponse } from '../../../common';
export function registerSearchRoute(
router: IRouter,
@@ -56,7 +58,17 @@ export function registerSearchRoute(
strategy,
}
);
- return res.ok({ body: response });
+
+ return res.ok({
+ body: {
+ ...response,
+ ...(isEsResponse(response)
+ ? {
+ rawResponse: shimHitsTotal(response.rawResponse),
+ }
+ : {}),
+ },
+ });
} catch (err) {
return res.customError({
statusCode: err.statusCode || 500,
diff --git a/x-pack/plugins/data_enhanced/server/search/shim_hits_total.test.ts b/src/plugins/data/server/search/routes/shim_hits_total.test.ts
similarity index 54%
rename from x-pack/plugins/data_enhanced/server/search/shim_hits_total.test.ts
rename to src/plugins/data/server/search/routes/shim_hits_total.test.ts
index 61740b97299da..0f24735386121 100644
--- a/x-pack/plugins/data_enhanced/server/search/shim_hits_total.test.ts
+++ b/src/plugins/data/server/search/routes/shim_hits_total.test.ts
@@ -1,7 +1,20 @@
/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License;
- * you may not use this file except in compliance with the Elastic License.
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
import { shimHitsTotal } from './shim_hits_total';
diff --git a/src/plugins/data/server/search/routes/shim_hits_total.ts b/src/plugins/data/server/search/routes/shim_hits_total.ts
new file mode 100644
index 0000000000000..5f95b21358978
--- /dev/null
+++ b/src/plugins/data/server/search/routes/shim_hits_total.ts
@@ -0,0 +1,33 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { SearchResponse } from 'elasticsearch';
+
+/**
+ * Temporary workaround until https://github.com/elastic/kibana/issues/26356 is addressed.
+ * Since we are setting `track_total_hits` in the request, `hits.total` will be an object
+ * containing the `value`.
+ *
+ * @internal
+ */
+export function shimHitsTotal(response: SearchResponse) {
+ const total = (response.hits?.total as any)?.value ?? response.hits?.total;
+ const hits = { ...response.hits, total };
+ return { ...response, hits };
+}
diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md
index a4f5f590e1774..cd0369a5c4551 100644
--- a/src/plugins/data/server/server.api.md
+++ b/src/plugins/data/server/server.api.md
@@ -446,14 +446,25 @@ export interface Filter {
query?: any;
}
-// Warning: (ae-forgotten-export) The symbol "SharedGlobalConfig" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "IUiSettingsClient" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "getDefaultSearchParams" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
-export function getDefaultSearchParams(config: SharedGlobalConfig): {
- timeout: string;
+export function getDefaultSearchParams(uiSettingsClient: IUiSettingsClient): Promise<{
+ maxConcurrentShardRequests: number | undefined;
+ ignoreThrottled: boolean;
ignoreUnavailable: boolean;
- restTotalHitsAsInt: boolean;
+ trackTotalHits: boolean;
+}>;
+
+// Warning: (ae-forgotten-export) The symbol "SharedGlobalConfig" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "getShardTimeout" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function getShardTimeout(config: SharedGlobalConfig): {
+ timeout: string;
+} | {
+ timeout?: undefined;
};
// Warning: (ae-missing-release-tag) "getTime" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -873,7 +884,7 @@ export class Plugin implements Plugin_2>;
+ search: ISearchStart>;
fieldFormats: {
fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise;
};
@@ -989,6 +1000,33 @@ export interface SearchUsage {
trackSuccess(duration: number): Promise;
}
+// @internal
+export function shimHitsTotal(response: SearchResponse): {
+ hits: {
+ total: any;
+ max_score: number;
+ hits: {
+ _index: string;
+ _type: string;
+ _id: string;
+ _score: number;
+ _source: any;
+ _version?: number | undefined;
+ _explanation?: import("elasticsearch").Explanation | undefined;
+ fields?: any;
+ highlight?: any;
+ inner_hits?: any;
+ matched_queries?: string[] | undefined;
+ sort?: string[] | undefined;
+ }[];
+ };
+ took: number;
+ timed_out: boolean;
+ _scroll_id?: string | undefined;
+ _shards: import("elasticsearch").ShardsResponse;
+ aggregations?: any;
+};
+
// Warning: (ae-missing-release-tag) "shouldReadFieldFromDocValues" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
@@ -1027,6 +1065,11 @@ export interface TimeRange {
to: string;
}
+// Warning: (ae-missing-release-tag) "toSnakeCase" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function toSnakeCase(obj: Record): import("lodash").Dictionary;
+
// Warning: (ae-missing-release-tag) "UI_SETTINGS" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
@@ -1043,6 +1086,7 @@ export const UI_SETTINGS: {
readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: "courier:maxConcurrentShardRequests";
readonly COURIER_BATCH_SEARCHES: "courier:batchSearches";
readonly SEARCH_INCLUDE_FROZEN: "search:includeFrozen";
+ readonly SEARCH_TIMEOUT: "search:timeout";
readonly HISTOGRAM_BAR_TARGET: "histogram:barTarget";
readonly HISTOGRAM_MAX_BARS: "histogram:maxBars";
readonly HISTORY_LIMIT: "history:limit";
@@ -1091,19 +1135,19 @@ export function usageProvider(core: CoreSetup_2): SearchUsage;
// src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "TruncateFormat" needs to be exported by the entry point index.d.ts
// src/plugins/data/server/index.ts:127:27 - (ae-forgotten-export) The symbol "isFilterable" needs to be exported by the entry point index.d.ts
// src/plugins/data/server/index.ts:127:27 - (ae-forgotten-export) The symbol "isNestedField" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:222:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:222:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:222:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:222:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:224:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:225:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:234:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:235:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:236:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:240:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:241:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:245:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
-// src/plugins/data/server/index.ts:248:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:225:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:225:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:225:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:225:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:227:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:228:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:237:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:238:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:239:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:243:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:244:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:248:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
+// src/plugins/data/server/index.ts:251:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
// src/plugins/data/server/plugin.ts:88:66 - (ae-forgotten-export) The symbol "DataEnhancements" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)
diff --git a/src/plugins/es_ui_shared/public/request/use_request.test.helpers.tsx b/src/plugins/es_ui_shared/public/request/use_request.test.helpers.tsx
index 0d6fd122ad22c..7a42ed7fad427 100644
--- a/src/plugins/es_ui_shared/public/request/use_request.test.helpers.tsx
+++ b/src/plugins/es_ui_shared/public/request/use_request.test.helpers.tsx
@@ -106,7 +106,7 @@ export const createUseRequestHelpers = (): UseRequestHelpers => {
};
const TestComponent = ({ requestConfig }: { requestConfig: UseRequestConfig }) => {
- const { isInitialRequest, isLoading, error, data, sendRequest } = useRequest(
+ const { isInitialRequest, isLoading, error, data, resendRequest } = useRequest(
httpClient as HttpSetup,
requestConfig
);
@@ -115,7 +115,7 @@ export const createUseRequestHelpers = (): UseRequestHelpers => {
hookResult.isLoading = isLoading;
hookResult.error = error;
hookResult.data = data;
- hookResult.sendRequest = sendRequest;
+ hookResult.resendRequest = resendRequest;
return null;
};
diff --git a/src/plugins/es_ui_shared/public/request/use_request.test.ts b/src/plugins/es_ui_shared/public/request/use_request.test.ts
index f7902218d9314..2a639f93b47b4 100644
--- a/src/plugins/es_ui_shared/public/request/use_request.test.ts
+++ b/src/plugins/es_ui_shared/public/request/use_request.test.ts
@@ -102,7 +102,7 @@ describe('useRequest hook', () => {
setupSuccessRequest();
expect(hookResult.isInitialRequest).toBe(true);
- hookResult.sendRequest();
+ hookResult.resendRequest();
await completeRequest();
expect(hookResult.isInitialRequest).toBe(false);
});
@@ -148,7 +148,7 @@ describe('useRequest hook', () => {
expect(hookResult.error).toBe(getErrorResponse().error);
act(() => {
- hookResult.sendRequest();
+ hookResult.resendRequest();
});
expect(hookResult.isLoading).toBe(true);
expect(hookResult.error).toBe(getErrorResponse().error);
@@ -183,7 +183,7 @@ describe('useRequest hook', () => {
expect(hookResult.data).toBe(getSuccessResponse().data);
act(() => {
- hookResult.sendRequest();
+ hookResult.resendRequest();
});
expect(hookResult.isLoading).toBe(true);
expect(hookResult.data).toBe(getSuccessResponse().data);
@@ -215,7 +215,7 @@ describe('useRequest hook', () => {
});
describe('callbacks', () => {
- describe('sendRequest', () => {
+ describe('resendRequest', () => {
it('sends the request', async () => {
const { setupSuccessRequest, completeRequest, hookResult, getSendRequestSpy } = helpers;
setupSuccessRequest();
@@ -224,7 +224,7 @@ describe('useRequest hook', () => {
expect(getSendRequestSpy().callCount).toBe(1);
await act(async () => {
- hookResult.sendRequest();
+ hookResult.resendRequest();
await completeRequest();
});
expect(getSendRequestSpy().callCount).toBe(2);
@@ -239,17 +239,17 @@ describe('useRequest hook', () => {
await advanceTime(REQUEST_TIME);
expect(getSendRequestSpy().callCount).toBe(1);
act(() => {
- hookResult.sendRequest();
+ hookResult.resendRequest();
});
// The manual request resolves, and we'll send yet another one...
await advanceTime(REQUEST_TIME);
expect(getSendRequestSpy().callCount).toBe(2);
act(() => {
- hookResult.sendRequest();
+ hookResult.resendRequest();
});
- // At this point, we've moved forward 3s. The poll is set at 2s. If sendRequest didn't
+ // At this point, we've moved forward 3s. The poll is set at 2s. If resendRequest didn't
// reset the poll, the request call count would be 4, not 3.
await advanceTime(REQUEST_TIME);
expect(getSendRequestSpy().callCount).toBe(3);
@@ -291,14 +291,14 @@ describe('useRequest hook', () => {
const HALF_REQUEST_TIME = REQUEST_TIME * 0.5;
setupSuccessRequest({ pollIntervalMs: REQUEST_TIME });
- // Before the original request resolves, we make a manual sendRequest call.
+ // Before the original request resolves, we make a manual resendRequest call.
await advanceTime(HALF_REQUEST_TIME);
expect(getSendRequestSpy().callCount).toBe(0);
act(() => {
- hookResult.sendRequest();
+ hookResult.resendRequest();
});
- // The original quest resolves but it's been marked as outdated by the the manual sendRequest
+ // The original quest resolves but it's been marked as outdated by the the manual resendRequest
// call "interrupts", so data is left undefined.
await advanceTime(HALF_REQUEST_TIME);
expect(getSendRequestSpy().callCount).toBe(1);
diff --git a/src/plugins/es_ui_shared/public/request/use_request.ts b/src/plugins/es_ui_shared/public/request/use_request.ts
index 481843bf40e88..e04f84a67b8a3 100644
--- a/src/plugins/es_ui_shared/public/request/use_request.ts
+++ b/src/plugins/es_ui_shared/public/request/use_request.ts
@@ -20,11 +20,7 @@
import { useEffect, useCallback, useState, useRef, useMemo } from 'react';
import { HttpSetup } from '../../../../../src/core/public';
-import {
- sendRequest as sendStatelessRequest,
- SendRequestConfig,
- SendRequestResponse,
-} from './send_request';
+import { sendRequest, SendRequestConfig } from './send_request';
export interface UseRequestConfig extends SendRequestConfig {
pollIntervalMs?: number;
@@ -37,7 +33,7 @@ export interface UseRequestResponse {
isLoading: boolean;
error: E | null;
data?: D | null;
- sendRequest: () => Promise>;
+ resendRequest: () => void;
}
export const useRequest = (
@@ -80,7 +76,7 @@ export const useRequest = (
/* eslint-disable-next-line react-hooks/exhaustive-deps */
}, [path, method, queryStringified, bodyStringified]);
- const sendRequest = useCallback(async () => {
+ const resendRequest = useCallback(async () => {
// If we're on an interval, this allows us to reset it if the user has manually requested the
// data, to avoid doubled-up requests.
clearPollInterval();
@@ -91,7 +87,7 @@ export const useRequest = (
// "old" error/data or loading state when a new request is in-flight.
setIsLoading(true);
- const response = await sendStatelessRequest(httpClient, requestBody);
+ const response = await sendRequest(httpClient, requestBody);
const { data: serializedResponseData, error: responseError } = response;
const isOutdatedRequest = requestId !== requestCountRef.current;
@@ -99,7 +95,7 @@ export const useRequest = (
// Ignore outdated or irrelevant data.
if (isOutdatedRequest || isUnmounted) {
- return { data: null, error: null };
+ return;
}
setError(responseError);
@@ -112,8 +108,6 @@ export const useRequest = (
}
// Setting isLoading to false also acts as a signal for scheduling the next poll request.
setIsLoading(false);
-
- return { data: serializedResponseData, error: responseError };
}, [requestBody, httpClient, deserializer, clearPollInterval]);
const scheduleRequest = useCallback(() => {
@@ -121,19 +115,19 @@ export const useRequest = (
clearPollInterval();
if (pollIntervalMs) {
- pollIntervalIdRef.current = setTimeout(sendRequest, pollIntervalMs);
+ pollIntervalIdRef.current = setTimeout(resendRequest, pollIntervalMs);
}
- }, [pollIntervalMs, sendRequest, clearPollInterval]);
+ }, [pollIntervalMs, resendRequest, clearPollInterval]);
- // Send the request on component mount and whenever the dependencies of sendRequest() change.
+ // Send the request on component mount and whenever the dependencies of resendRequest() change.
useEffect(() => {
- sendRequest();
- }, [sendRequest]);
+ resendRequest();
+ }, [resendRequest]);
// Schedule the next poll request when the previous one completes.
useEffect(() => {
// When a request completes, attempt to schedule the next one. Note that we aren't re-scheduling
- // a request whenever sendRequest's dependencies change. isLoading isn't set to false until the
+ // a request whenever resendRequest's dependencies change. isLoading isn't set to false until the
// initial request has completed, so we won't schedule a request on mount.
if (!isLoading) {
scheduleRequest();
@@ -156,6 +150,6 @@ export const useRequest = (
isLoading,
error,
data,
- sendRequest, // Gives the user the ability to manually request data
+ resendRequest, // Gives the user the ability to manually request data
};
};
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_array.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_array.ts
index 3688421964d2e..d0ac0d4ab28c3 100644
--- a/src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_array.ts
+++ b/src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_array.ts
@@ -17,18 +17,25 @@
* under the License.
*/
-import { useState, useEffect, useRef, useCallback } from 'react';
+import { useEffect, useRef, useCallback, useMemo } from 'react';
+import { FormHook, FieldConfig } from '../types';
+import { getFieldValidityAndErrorMessage } from '../helpers';
import { useFormContext } from '../form_context';
+import { useField, InternalFieldConfig } from '../hooks';
interface Props {
path: string;
initialNumberOfItems?: number;
readDefaultValueOnForm?: boolean;
+ validations?: FieldConfig['validations'];
children: (args: {
items: ArrayItem[];
+ error: string | null;
addItem: () => void;
removeItem: (id: number) => void;
+ moveItem: (sourceIdx: number, destinationIdx: number) => void;
+ form: FormHook;
}) => JSX.Element;
}
@@ -56,32 +63,62 @@ export interface ArrayItem {
export const UseArray = ({
path,
initialNumberOfItems,
+ validations,
readDefaultValueOnForm = true,
children,
}: Props) => {
- const didMountRef = useRef(false);
- const form = useFormContext();
- const defaultValues = readDefaultValueOnForm && (form.getFieldDefaultValue(path) as any[]);
+ const isMounted = useRef(false);
const uniqueId = useRef(0);
- const getInitialItemsFromValues = (values: any[]): ArrayItem[] =>
- values.map((_, index) => ({
+ const form = useFormContext();
+ const { getFieldDefaultValue } = form;
+
+ const getNewItemAtIndex = useCallback(
+ (index: number): ArrayItem => ({
id: uniqueId.current++,
path: `${path}[${index}]`,
- isNew: false,
- }));
+ isNew: true,
+ }),
+ [path]
+ );
+
+ const fieldDefaultValue = useMemo(() => {
+ const defaultValues = readDefaultValueOnForm
+ ? (getFieldDefaultValue(path) as any[])
+ : undefined;
- const getNewItemAtIndex = (index: number): ArrayItem => ({
- id: uniqueId.current++,
- path: `${path}[${index}]`,
- isNew: true,
- });
+ const getInitialItemsFromValues = (values: any[]): ArrayItem[] =>
+ values.map((_, index) => ({
+ id: uniqueId.current++,
+ path: `${path}[${index}]`,
+ isNew: false,
+ }));
- const initialState = defaultValues
- ? getInitialItemsFromValues(defaultValues)
- : new Array(initialNumberOfItems).fill('').map((_, i) => getNewItemAtIndex(i));
+ return defaultValues
+ ? getInitialItemsFromValues(defaultValues)
+ : new Array(initialNumberOfItems).fill('').map((_, i) => getNewItemAtIndex(i));
+ }, [path, initialNumberOfItems, readDefaultValueOnForm, getFieldDefaultValue, getNewItemAtIndex]);
- const [items, setItems] = useState(initialState);
+ // Create a new hook field with the "hasValue" set to false so we don't use its value to build the final form data.
+ // Apart from that the field behaves like a normal field and is hooked into the form validation lifecycle.
+ const fieldConfigBase: FieldConfig & InternalFieldConfig = {
+ defaultValue: fieldDefaultValue,
+ errorDisplayDelay: 0,
+ isIncludedInOutput: false,
+ };
+
+ const fieldConfig: FieldConfig & InternalFieldConfig = validations
+ ? { validations, ...fieldConfigBase }
+ : fieldConfigBase;
+
+ const field = useField(form, path, fieldConfig);
+ const { setValue, value, isChangingValue, errors } = field;
+
+ // Derived state from the field
+ const error = useMemo(() => {
+ const { errorMessage } = getFieldValidityAndErrorMessage({ isChangingValue, errors });
+ return errorMessage;
+ }, [isChangingValue, errors]);
const updatePaths = useCallback(
(_rows: ArrayItem[]) => {
@@ -96,29 +133,51 @@ export const UseArray = ({
[path]
);
- const addItem = () => {
- setItems((previousItems) => {
+ const addItem = useCallback(() => {
+ setValue((previousItems) => {
const itemIndex = previousItems.length;
return [...previousItems, getNewItemAtIndex(itemIndex)];
});
- };
+ }, [setValue, getNewItemAtIndex]);
- const removeItem = (id: number) => {
- setItems((previousItems) => {
- const updatedItems = previousItems.filter((item) => item.id !== id);
- return updatePaths(updatedItems);
- });
- };
+ const removeItem = useCallback(
+ (id: number) => {
+ setValue((previousItems) => {
+ const updatedItems = previousItems.filter((item) => item.id !== id);
+ return updatePaths(updatedItems);
+ });
+ },
+ [setValue, updatePaths]
+ );
- useEffect(() => {
- if (didMountRef.current) {
- setItems((prev) => {
- return updatePaths(prev);
+ const moveItem = useCallback(
+ (sourceIdx: number, destinationIdx: number) => {
+ setValue((previousItems) => {
+ const nextItems = [...previousItems];
+ const removed = nextItems.splice(sourceIdx, 1)[0];
+ nextItems.splice(destinationIdx, 0, removed);
+ return updatePaths(nextItems);
});
- } else {
- didMountRef.current = true;
+ },
+ [setValue, updatePaths]
+ );
+
+ useEffect(() => {
+ if (!isMounted.current) {
+ return;
}
- }, [path, updatePaths]);
- return children({ items, addItem, removeItem });
+ setValue((prev) => {
+ return updatePaths(prev);
+ });
+ }, [path, updatePaths, setValue]);
+
+ useEffect(() => {
+ isMounted.current = true;
+ return () => {
+ isMounted.current = false;
+ };
+ }, []);
+
+ return children({ items: value, error, form, addItem, removeItem, moveItem });
};
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/helpers.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/helpers.ts
index 7ea42f81b43cb..a148dc543542b 100644
--- a/src/plugins/es_ui_shared/static/forms/hook_form_lib/helpers.ts
+++ b/src/plugins/es_ui_shared/static/forms/hook_form_lib/helpers.ts
@@ -19,9 +19,10 @@
import { FieldHook } from './types';
-export const getFieldValidityAndErrorMessage = (
- field: FieldHook
-): { isInvalid: boolean; errorMessage: string | null } => {
+export const getFieldValidityAndErrorMessage = (field: {
+ isChangingValue: FieldHook['isChangingValue'];
+ errors: FieldHook['errors'];
+}): { isInvalid: boolean; errorMessage: string | null } => {
const isInvalid = !field.isChangingValue && field.errors.length > 0;
const errorMessage =
!field.isChangingValue && field.errors.length ? field.errors[0].message : null;
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/index.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/index.ts
index 45c11dd6272e4..aa9610dd85ae3 100644
--- a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/index.ts
+++ b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/index.ts
@@ -17,6 +17,6 @@
* under the License.
*/
-export { useField } from './use_field';
+export { useField, InternalFieldConfig } from './use_field';
export { useForm } from './use_form';
export { useFormData } from './use_form_data';
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_field.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_field.ts
index f01c7226ea4ce..bb4aae6eccae8 100644
--- a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_field.ts
+++ b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_field.ts
@@ -22,16 +22,22 @@ import { useMemo, useState, useEffect, useRef, useCallback } from 'react';
import { FormHook, FieldHook, FieldConfig, FieldValidateResponse, ValidationError } from '../types';
import { FIELD_TYPES, VALIDATION_TYPES } from '../constants';
+export interface InternalFieldConfig {
+ initialValue?: T;
+ isIncludedInOutput?: boolean;
+}
+
export const useField = (
form: FormHook,
path: string,
- config: FieldConfig & { initialValue?: T } = {},
+ config: FieldConfig & InternalFieldConfig = {},
valueChangeListener?: (value: T) => void
) => {
const {
type = FIELD_TYPES.TEXT,
defaultValue = '', // The value to use a fallback mecanism when no initial value is passed
initialValue = config.defaultValue ?? '', // The value explicitly passed
+ isIncludedInOutput = true,
label = '',
labelAppend = '',
helpText = '',
@@ -201,7 +207,7 @@ export const useField = (
validationTypeToValidate,
}: {
formData: any;
- value: unknown;
+ value: T;
validationTypeToValidate?: string;
}): ValidationError[] | Promise => {
if (!validations) {
@@ -234,7 +240,7 @@ export const useField = (
}
inflightValidation.current = validator({
- value: (valueToValidate as unknown) as string,
+ value: valueToValidate,
errors: validationErrors,
form: { getFormData, getFields },
formData,
@@ -280,7 +286,7 @@ export const useField = (
}
const validationResult = validator({
- value: (valueToValidate as unknown) as string,
+ value: valueToValidate,
errors: validationErrors,
form: { getFormData, getFields },
formData,
@@ -388,9 +394,15 @@ export const useField = (
*/
const setValue: FieldHook['setValue'] = useCallback(
(newValue) => {
- const formattedValue = formatInputValue(newValue);
- setStateValue(formattedValue);
- return formattedValue;
+ setStateValue((prev) => {
+ let formattedValue: T;
+ if (typeof newValue === 'function') {
+ formattedValue = formatInputValue((newValue as Function)(prev));
+ } else {
+ formattedValue = formatInputValue(newValue);
+ }
+ return formattedValue;
+ });
},
[formatInputValue]
);
@@ -496,6 +508,7 @@ export const useField = (
clearErrors,
validate,
reset,
+ __isIncludedInOutput: isIncludedInOutput,
__serializeValue: serializeValue,
};
}, [
@@ -511,6 +524,7 @@ export const useField = (
isValidating,
isValidated,
isChangingValue,
+ isIncludedInOutput,
onChange,
getErrorsMessages,
setValue,
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_form.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_form.ts
index 7b72a9eeacf7b..b390c17d3c2ff 100644
--- a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_form.ts
+++ b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_form.ts
@@ -95,19 +95,25 @@ export function useForm(
const fieldsToArray = useCallback(() => Object.values(fieldsRefs.current), []);
- const stripEmptyFields = useCallback(
- (fields: FieldsMap): FieldsMap => {
- if (formOptions.stripEmptyFields) {
- return Object.entries(fields).reduce((acc, [key, field]) => {
- if (typeof field.value !== 'string' || field.value.trim() !== '') {
- acc[key] = field;
- }
+ const getFieldsForOutput = useCallback(
+ (fields: FieldsMap, opts: { stripEmptyFields: boolean }): FieldsMap => {
+ return Object.entries(fields).reduce((acc, [key, field]) => {
+ if (!field.__isIncludedInOutput) {
return acc;
- }, {} as FieldsMap);
- }
- return fields;
+ }
+
+ if (opts.stripEmptyFields) {
+ const isFieldEmpty = typeof field.value === 'string' && field.value.trim() === '';
+ if (isFieldEmpty) {
+ return acc;
+ }
+ }
+
+ acc[key] = field;
+ return acc;
+ }, {} as FieldsMap);
},
- [formOptions]
+ []
);
const updateFormDataAt: FormHook['__updateFormDataAt'] = useCallback(
@@ -133,8 +139,10 @@ export function useForm(
const getFormData: FormHook['getFormData'] = useCallback(
(getDataOptions: Parameters['getFormData']>[0] = { unflatten: true }) => {
if (getDataOptions.unflatten) {
- const nonEmptyFields = stripEmptyFields(fieldsRefs.current);
- const fieldsValue = mapFormFields(nonEmptyFields, (field) => field.__serializeValue());
+ const fieldsToOutput = getFieldsForOutput(fieldsRefs.current, {
+ stripEmptyFields: formOptions.stripEmptyFields,
+ });
+ const fieldsValue = mapFormFields(fieldsToOutput, (field) => field.__serializeValue());
return serializer
? (serializer(unflattenObject(fieldsValue)) as T)
: (unflattenObject(fieldsValue) as T);
@@ -148,7 +156,7 @@ export function useForm(
{} as T
);
},
- [stripEmptyFields, serializer]
+ [getFieldsForOutput, formOptions.stripEmptyFields, serializer]
);
const getErrors: FormHook['getErrors'] = useCallback(() => {
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts
index 4b343ec5e9f2e..18b8f478f7c0e 100644
--- a/src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts
+++ b/src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts
@@ -108,15 +108,18 @@ export interface FieldHook {
errorCode?: string;
}) => string | null;
onChange: (event: ChangeEvent<{ name?: string; value: string; checked?: boolean }>) => void;
- setValue: (value: T) => T;
+ setValue: (value: T | ((prevValue: T) => T)) => void;
setErrors: (errors: ValidationError[]) => void;
clearErrors: (type?: string | string[]) => void;
validate: (validateData?: {
formData?: any;
- value?: unknown;
+ value?: T;
validationType?: string;
}) => FieldValidateResponse | Promise;
reset: (options?: { resetValue?: boolean; defaultValue?: T }) => unknown | undefined;
+ // Flag to indicate if the field value will be included in the form data outputted
+ // when calling form.getFormData();
+ __isIncludedInOutput: boolean;
__serializeValue: (rawValue?: unknown) => unknown;
}
@@ -127,7 +130,7 @@ export interface FieldConfig {
readonly helpText?: string | ReactNode;
readonly type?: HTMLInputElement['type'];
readonly defaultValue?: ValueType;
- readonly validations?: Array>;
+ readonly validations?: Array>;
readonly formatters?: FormatterFunc[];
readonly deserializer?: SerializerFunc;
readonly serializer?: SerializerFunc;
@@ -163,8 +166,8 @@ export interface ValidationFuncArg {
errors: readonly ValidationError[];
}
-export type ValidationFunc = (
- data: ValidationFuncArg
+export type ValidationFunc = (
+ data: ValidationFuncArg
) => ValidationError | void | undefined | Promise | void | undefined>;
export interface FieldValidateResponse {
@@ -184,8 +187,8 @@ type FormatterFunc = (value: any, formData: FormData) => unknown;
// string | number | boolean | string[] ...
type FieldValue = unknown;
-export interface ValidationConfig {
- validator: ValidationFunc