From f3f08ff1f636a28ce6720259983e8a88a83df529 Mon Sep 17 00:00:00 2001
From: Alison Goryachev
Date: Thu, 20 May 2021 08:54:47 -0400
Subject: [PATCH 01/33] Rename client integration test folders (#100119)
---
.../client_integration}/helpers/http_requests.ts | 6 +++---
.../client_integration}/helpers/index.ts | 0
.../client_integration}/helpers/indices.helpers.ts | 2 +-
.../client_integration}/helpers/kibana.helpers.ts | 2 +-
.../client_integration}/helpers/overview.helpers.ts | 2 +-
.../helpers/setup_environment.tsx | 12 ++++++------
.../client_integration}/indices.test.ts | 4 ++--
.../client_integration}/kibana.test.ts | 0
.../client_integration}/overview.test.ts | 2 +-
x-pack/plugins/upgrade_assistant/tsconfig.json | 2 +-
.../client_integration}/helpers/app_context.mock.tsx | 6 +++---
.../client_integration}/helpers/body_response.ts | 0
.../client_integration}/helpers/http_requests.ts | 2 +-
.../client_integration}/helpers/index.ts | 0
.../client_integration}/helpers/jest_constants.ts | 2 +-
.../client_integration}/helpers/setup_environment.ts | 2 +-
.../helpers/watch_create_json.helpers.ts | 6 +++---
.../helpers/watch_create_threshold.helpers.ts | 6 +++---
.../helpers/watch_edit.helpers.ts | 6 +++---
.../helpers/watch_list.helpers.ts | 4 ++--
.../helpers/watch_status.helpers.ts | 4 ++--
.../client_integration}/watch_create_json.test.ts | 4 ++--
.../watch_create_threshold.test.tsx | 8 ++++----
.../client_integration}/watch_edit.test.ts | 8 ++++----
.../client_integration}/watch_list.test.ts | 4 ++--
.../client_integration}/watch_status.test.ts | 7 +++----
x-pack/plugins/watcher/tsconfig.json | 2 +-
27 files changed, 51 insertions(+), 52 deletions(-)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/helpers/http_requests.ts (92%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/helpers/index.ts (100%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/helpers/indices.helpers.ts (95%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/helpers/kibana.helpers.ts (93%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/helpers/overview.helpers.ts (95%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/helpers/setup_environment.tsx (84%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/indices.test.ts (98%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/kibana.test.ts (100%)
rename x-pack/plugins/upgrade_assistant/{tests_client_integration => __jest__/client_integration}/overview.test.ts (99%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/app_context.mock.tsx (89%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/body_response.ts (100%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/http_requests.ts (99%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/index.ts (100%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/jest_constants.ts (87%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/setup_environment.ts (91%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/watch_create_json.helpers.ts (89%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/watch_create_threshold.helpers.ts (92%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/watch_edit.helpers.ts (86%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/watch_list.helpers.ts (95%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/helpers/watch_status.helpers.ts (96%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/watch_create_json.test.ts (98%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/watch_create_threshold.test.tsx (99%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/watch_edit.test.ts (96%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/watch_list.test.ts (98%)
rename x-pack/plugins/watcher/{tests_client_integration => __jest__/client_integration}/watch_status.test.ts (98%)
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/http_requests.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/http_requests.ts
similarity index 92%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/http_requests.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/http_requests.ts
index 9abd981bd85c8..e3f6df54db60e 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/http_requests.ts
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/http_requests.ts
@@ -6,9 +6,9 @@
*/
import sinon, { SinonFakeServer } from 'sinon';
-import { API_BASE_PATH } from '../../common/constants';
-import { UpgradeAssistantStatus } from '../../common/types';
-import { ResponseError } from '../../public/application/lib/api';
+import { API_BASE_PATH } from '../../../common/constants';
+import { UpgradeAssistantStatus } from '../../../common/types';
+import { ResponseError } from '../../../public/application/lib/api';
// Register helpers to mock HTTP Requests
const registerHttpRequestMockHelpers = (server: SinonFakeServer) => {
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/index.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/index.ts
similarity index 100%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/index.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/index.ts
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/indices.helpers.ts
similarity index 95%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/indices.helpers.ts
index a59aa009a912b..5189ddc420b08 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/indices.helpers.ts
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/indices.helpers.ts
@@ -6,7 +6,7 @@
*/
import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest';
-import { EsDeprecationsContent } from '../../public/application/components/es_deprecations';
+import { EsDeprecationsContent } from '../../../public/application/components/es_deprecations';
import { WithAppDependencies } from './setup_environment';
const testBedConfig: TestBedConfig = {
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/kibana.helpers.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/kibana.helpers.ts
similarity index 93%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/kibana.helpers.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/kibana.helpers.ts
index 0a800771e2656..370679d7d1a71 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/kibana.helpers.ts
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/kibana.helpers.ts
@@ -6,7 +6,7 @@
*/
import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest';
-import { KibanaDeprecationsContent } from '../../public/application/components/kibana_deprecations';
+import { KibanaDeprecationsContent } from '../../../public/application/components/kibana_deprecations';
import { WithAppDependencies } from './setup_environment';
const testBedConfig: TestBedConfig = {
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/overview.helpers.ts
similarity index 95%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/overview.helpers.ts
index 9e4b2eae483ea..5c89b6230d85f 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/overview.helpers.ts
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/overview.helpers.ts
@@ -7,7 +7,7 @@
import { act } from 'react-dom/test-utils';
import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest';
-import { DeprecationsOverview } from '../../public/application/components/overview';
+import { DeprecationsOverview } from '../../../public/application/components/overview';
import { WithAppDependencies } from './setup_environment';
const testBedConfig: TestBedConfig = {
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/setup_environment.tsx
similarity index 84%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/setup_environment.tsx
index 9ea5c15e9d031..31189428fda18 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/helpers/setup_environment.tsx
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/helpers/setup_environment.tsx
@@ -14,14 +14,14 @@ import {
deprecationsServiceMock,
docLinksServiceMock,
notificationServiceMock,
-} from '../../../../../src/core/public/mocks';
-import { HttpSetup } from '../../../../../src/core/public';
+} from 'src/core/public/mocks';
+import { HttpSetup } from 'src/core/public';
-import { mockKibanaSemverVersion, UA_READONLY_MODE } from '../../common/constants';
-import { AppContextProvider } from '../../public/application/app_context';
+import { mockKibanaSemverVersion, UA_READONLY_MODE } from '../../../common/constants';
+import { AppContextProvider } from '../../../public/application/app_context';
+import { apiService } from '../../../public/application/lib/api';
+import { breadcrumbService } from '../../../public/application/lib/breadcrumbs';
import { init as initHttpRequests } from './http_requests';
-import { apiService } from '../../public/application/lib/api';
-import { breadcrumbService } from '../../public/application/lib/breadcrumbs';
const mockHttpClient = axios.create({ adapter: axiosXhrAdapter });
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/indices.test.ts
similarity index 98%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/indices.test.ts
index 51526698effc5..059980cb5671b 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/indices.test.ts
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/indices.test.ts
@@ -6,8 +6,8 @@
*/
import { act } from 'react-dom/test-utils';
-import { indexSettingDeprecations } from '../common/constants';
-import { MIGRATION_DEPRECATION_LEVEL } from '../common/types';
+import { indexSettingDeprecations } from '../../common/constants';
+import { MIGRATION_DEPRECATION_LEVEL } from '../../common/types';
import { IndicesTestBed, setupIndicesPage, setupEnvironment } from './helpers';
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/kibana.test.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/kibana.test.ts
similarity index 100%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/kibana.test.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/kibana.test.ts
diff --git a/x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/overview.test.ts
similarity index 99%
rename from x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts
rename to x-pack/plugins/upgrade_assistant/__jest__/client_integration/overview.test.ts
index fd7cd2c90e952..f3f76c3a6688e 100644
--- a/x-pack/plugins/upgrade_assistant/tests_client_integration/overview.test.ts
+++ b/x-pack/plugins/upgrade_assistant/__jest__/client_integration/overview.test.ts
@@ -8,7 +8,7 @@
import type { DomainDeprecationDetails } from 'kibana/public';
import { act } from 'react-dom/test-utils';
import { deprecationsServiceMock } from 'src/core/public/mocks';
-import { UpgradeAssistantStatus } from '../common/types';
+import { UpgradeAssistantStatus } from '../../common/types';
import { OverviewTestBed, setupOverviewPage, setupEnvironment } from './helpers';
diff --git a/x-pack/plugins/upgrade_assistant/tsconfig.json b/x-pack/plugins/upgrade_assistant/tsconfig.json
index 0d65c8ddd8fed..6303b06c0d899 100644
--- a/x-pack/plugins/upgrade_assistant/tsconfig.json
+++ b/x-pack/plugins/upgrade_assistant/tsconfig.json
@@ -8,10 +8,10 @@
"declarationMap": true
},
"include": [
+ "__jest__/**/*",
"common/**/*",
"public/**/*",
"server/**/*",
- "tests_client_integration/**/*",
// have to declare *.json explicitly due to https://github.com/microsoft/TypeScript/issues/25636
"public/**/*.json",
"server/**/*.json"
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/app_context.mock.tsx b/x-pack/plugins/watcher/__jest__/client_integration/helpers/app_context.mock.tsx
similarity index 89%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/app_context.mock.tsx
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/app_context.mock.tsx
index 2c85c357d709f..01c7155832745 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/app_context.mock.tsx
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/app_context.mock.tsx
@@ -15,9 +15,9 @@ import {
notificationServiceMock,
httpServiceMock,
scopedHistoryMock,
-} from '../../../../../src/core/public/mocks';
-import { AppContextProvider } from '../../public/application/app_context';
-import { LicenseStatus } from '../../common/types/license_status';
+} from '../../../../../../src/core/public/mocks';
+import { AppContextProvider } from '../../../public/application/app_context';
+import { LicenseStatus } from '../../../common/types/license_status';
class MockTimeBuckets {
setBounds(_domain: any) {
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/body_response.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/body_response.ts
similarity index 100%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/body_response.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/body_response.ts
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/http_requests.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/http_requests.ts
similarity index 99%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/http_requests.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/http_requests.ts
index 20af3b25ead8a..e98cd66a25684 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/http_requests.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/http_requests.ts
@@ -6,7 +6,7 @@
*/
import sinon, { SinonFakeServer } from 'sinon';
-import { ROUTES } from '../../common/constants';
+import { ROUTES } from '../../../common/constants';
const { API_ROOT } = ROUTES;
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/index.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/index.ts
similarity index 100%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/index.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/index.ts
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/jest_constants.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/jest_constants.ts
similarity index 87%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/jest_constants.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/jest_constants.ts
index 5626d067aad2c..c59fa21a3ffae 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/jest_constants.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/jest_constants.ts
@@ -5,7 +5,7 @@
* 2.0.
*/
-import { getWatch } from '../../__fixtures__';
+import { getWatch } from '../../../__fixtures__';
export const WATCH_ID = 'my-test-watch';
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/setup_environment.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/setup_environment.ts
similarity index 91%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/setup_environment.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/setup_environment.ts
index 6cd4ca3bcd2dd..05b325ee946bd 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/setup_environment.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/setup_environment.ts
@@ -8,7 +8,7 @@
import axios from 'axios';
import axiosXhrAdapter from 'axios/lib/adapters/xhr';
import { init as initHttpRequests } from './http_requests';
-import { setHttpClient, setSavedObjectsClient } from '../../public/application/lib/api';
+import { setHttpClient, setSavedObjectsClient } from '../../../public/application/lib/api';
const mockHttpClient = axios.create({ adapter: axiosXhrAdapter });
mockHttpClient.interceptors.response.use(
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_create_json.helpers.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_create_json.helpers.ts
similarity index 89%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/watch_create_json.helpers.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_create_json.helpers.ts
index eb7b2bbfd6146..696a266ca4a3e 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_create_json.helpers.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_create_json.helpers.ts
@@ -6,10 +6,10 @@
*/
import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest';
+import { WatchEdit } from '../../../public/application/sections/watch_edit/components/watch_edit';
+import { registerRouter } from '../../../public/application/lib/navigation';
+import { ROUTES, WATCH_TYPES } from '../../../common/constants';
import { withAppContext } from './app_context.mock';
-import { WatchEdit } from '../../public/application/sections/watch_edit/components/watch_edit';
-import { registerRouter } from '../../public/application/lib/navigation';
-import { ROUTES, WATCH_TYPES } from '../../common/constants';
const testBedConfig: TestBedConfig = {
memoryRouter: {
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_create_threshold.helpers.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_create_threshold.helpers.ts
similarity index 92%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/watch_create_threshold.helpers.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_create_threshold.helpers.ts
index 8bc147b1bc16c..c70684b80a6d5 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_create_threshold.helpers.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_create_threshold.helpers.ts
@@ -6,9 +6,9 @@
*/
import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest';
-import { WatchEdit } from '../../public/application/sections/watch_edit/components/watch_edit';
-import { registerRouter } from '../../public/application/lib/navigation';
-import { ROUTES, WATCH_TYPES } from '../../common/constants';
+import { WatchEdit } from '../../../public/application/sections/watch_edit/components/watch_edit';
+import { registerRouter } from '../../../public/application/lib/navigation';
+import { ROUTES, WATCH_TYPES } from '../../../common/constants';
import { withAppContext } from './app_context.mock';
const testBedConfig: TestBedConfig = {
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_edit.helpers.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_edit.helpers.ts
similarity index 86%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/watch_edit.helpers.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_edit.helpers.ts
index b9ca328618257..957755c9e5361 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_edit.helpers.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_edit.helpers.ts
@@ -6,9 +6,9 @@
*/
import { registerTestBed, TestBed, TestBedConfig } from '@kbn/test/jest';
-import { WatchEdit } from '../../public/application/sections/watch_edit/components/watch_edit';
-import { registerRouter } from '../../public/application/lib/navigation';
-import { ROUTES } from '../../common/constants';
+import { WatchEdit } from '../../../public/application/sections/watch_edit/components/watch_edit';
+import { registerRouter } from '../../../public/application/lib/navigation';
+import { ROUTES } from '../../../common/constants';
import { WATCH_ID } from './jest_constants';
import { withAppContext } from './app_context.mock';
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_list.helpers.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_list.helpers.ts
similarity index 95%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/watch_list.helpers.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_list.helpers.ts
index 246da308bedfd..ad171f9e40cad 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_list.helpers.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_list.helpers.ts
@@ -8,8 +8,8 @@
import { act } from 'react-dom/test-utils';
import { registerTestBed, findTestSubject, TestBed, TestBedConfig, nextTick } from '@kbn/test/jest';
-import { WatchList } from '../../public/application/sections/watch_list/components/watch_list';
-import { ROUTES, REFRESH_INTERVALS } from '../../common/constants';
+import { WatchList } from '../../../public/application/sections/watch_list/components/watch_list';
+import { ROUTES, REFRESH_INTERVALS } from '../../../common/constants';
import { withAppContext } from './app_context.mock';
const testBedConfig: TestBedConfig = {
diff --git a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_status.helpers.ts b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_status.helpers.ts
similarity index 96%
rename from x-pack/plugins/watcher/tests_client_integration/helpers/watch_status.helpers.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_status.helpers.ts
index c817f4b13de14..a1c7e8b404997 100644
--- a/x-pack/plugins/watcher/tests_client_integration/helpers/watch_status.helpers.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/helpers/watch_status.helpers.ts
@@ -8,8 +8,8 @@
import { act } from 'react-dom/test-utils';
import { registerTestBed, findTestSubject, TestBed, TestBedConfig, delay } from '@kbn/test/jest';
-import { WatchStatus } from '../../public/application/sections/watch_status/components/watch_status';
-import { ROUTES } from '../../common/constants';
+import { WatchStatus } from '../../../public/application/sections/watch_status/components/watch_status';
+import { ROUTES } from '../../../common/constants';
import { WATCH_ID } from './jest_constants';
import { withAppContext } from './app_context.mock';
diff --git a/x-pack/plugins/watcher/tests_client_integration/watch_create_json.test.ts b/x-pack/plugins/watcher/__jest__/client_integration/watch_create_json.test.ts
similarity index 98%
rename from x-pack/plugins/watcher/tests_client_integration/watch_create_json.test.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/watch_create_json.test.ts
index e775a9d661acf..4a632d9752cac 100644
--- a/x-pack/plugins/watcher/tests_client_integration/watch_create_json.test.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/watch_create_json.test.ts
@@ -7,8 +7,8 @@
import { act } from 'react-dom/test-utils';
-import { getExecuteDetails } from '../__fixtures__';
-import { defaultWatch } from '../public/application/models/watch';
+import { getExecuteDetails } from '../../__fixtures__';
+import { defaultWatch } from '../../public/application/models/watch';
import { setupEnvironment, pageHelpers, nextTick, wrapBodyResponse } from './helpers';
import { WatchCreateJsonTestBed } from './helpers/watch_create_json.helpers';
import { WATCH } from './helpers/jest_constants';
diff --git a/x-pack/plugins/watcher/tests_client_integration/watch_create_threshold.test.tsx b/x-pack/plugins/watcher/__jest__/client_integration/watch_create_threshold.test.tsx
similarity index 99%
rename from x-pack/plugins/watcher/tests_client_integration/watch_create_threshold.test.tsx
rename to x-pack/plugins/watcher/__jest__/client_integration/watch_create_threshold.test.tsx
index 123e8bc9cff1c..2909243110303 100644
--- a/x-pack/plugins/watcher/tests_client_integration/watch_create_threshold.test.tsx
+++ b/x-pack/plugins/watcher/__jest__/client_integration/watch_create_threshold.test.tsx
@@ -9,6 +9,8 @@ import React from 'react';
import { act } from 'react-dom/test-utils';
import axiosXhrAdapter from 'axios/lib/adapters/xhr';
import axios from 'axios';
+import { getExecuteDetails } from '../../__fixtures__';
+import { WATCH_TYPES } from '../../common/constants';
import {
setupEnvironment,
pageHelpers,
@@ -17,8 +19,6 @@ import {
unwrapBodyResponse,
} from './helpers';
import { WatchCreateThresholdTestBed } from './helpers/watch_create_threshold.helpers';
-import { getExecuteDetails } from '../__fixtures__';
-import { WATCH_TYPES } from '../common/constants';
const WATCH_NAME = 'my_test_watch';
@@ -50,8 +50,8 @@ const WATCH_VISUALIZE_DATA = {
const mockHttpClient = axios.create({ adapter: axiosXhrAdapter });
-jest.mock('../public/application/lib/api', () => {
- const original = jest.requireActual('../public/application/lib/api');
+jest.mock('../../public/application/lib/api', () => {
+ const original = jest.requireActual('../../public/application/lib/api');
return {
...original,
diff --git a/x-pack/plugins/watcher/tests_client_integration/watch_edit.test.ts b/x-pack/plugins/watcher/__jest__/client_integration/watch_edit.test.ts
similarity index 96%
rename from x-pack/plugins/watcher/tests_client_integration/watch_edit.test.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/watch_edit.test.ts
index aae6b96e325a7..b40388376d8d5 100644
--- a/x-pack/plugins/watcher/tests_client_integration/watch_edit.test.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/watch_edit.test.ts
@@ -10,16 +10,16 @@ import axiosXhrAdapter from 'axios/lib/adapters/xhr';
import axios from 'axios';
import { getRandomString } from '@kbn/test/jest';
-import { getWatch } from '../__fixtures__';
-import { defaultWatch } from '../public/application/models/watch';
+import { getWatch } from '../../__fixtures__';
+import { defaultWatch } from '../../public/application/models/watch';
import { setupEnvironment, pageHelpers, nextTick, wrapBodyResponse } from './helpers';
import { WatchEditTestBed } from './helpers/watch_edit.helpers';
import { WATCH } from './helpers/jest_constants';
const mockHttpClient = axios.create({ adapter: axiosXhrAdapter });
-jest.mock('../public/application/lib/api', () => {
- const original = jest.requireActual('../public/application/lib/api');
+jest.mock('../../public/application/lib/api', () => {
+ const original = jest.requireActual('../../public/application/lib/api');
return {
...original,
diff --git a/x-pack/plugins/watcher/tests_client_integration/watch_list.test.ts b/x-pack/plugins/watcher/__jest__/client_integration/watch_list.test.ts
similarity index 98%
rename from x-pack/plugins/watcher/tests_client_integration/watch_list.test.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/watch_list.test.ts
index 9fc2f6946b8e0..1a396a007dd0c 100644
--- a/x-pack/plugins/watcher/tests_client_integration/watch_list.test.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/watch_list.test.ts
@@ -6,10 +6,10 @@
*/
import { act } from 'react-dom/test-utils';
-import * as fixtures from '../__fixtures__';
+import * as fixtures from '../../__fixtures__';
+import { ROUTES } from '../../common/constants';
import { setupEnvironment, pageHelpers, getRandomString, findTestSubject } from './helpers';
import { WatchListTestBed } from './helpers/watch_list.helpers';
-import { ROUTES } from '../common/constants';
const { API_ROOT } = ROUTES;
diff --git a/x-pack/plugins/watcher/tests_client_integration/watch_status.test.ts b/x-pack/plugins/watcher/__jest__/client_integration/watch_status.test.ts
similarity index 98%
rename from x-pack/plugins/watcher/tests_client_integration/watch_status.test.ts
rename to x-pack/plugins/watcher/__jest__/client_integration/watch_status.test.ts
index 69b081e1f1218..c19ec62b94477 100644
--- a/x-pack/plugins/watcher/tests_client_integration/watch_status.test.ts
+++ b/x-pack/plugins/watcher/__jest__/client_integration/watch_status.test.ts
@@ -6,13 +6,12 @@
*/
import { act } from 'react-dom/test-utils';
+import moment from 'moment';
+import { getWatchHistory } from '../../__fixtures__';
+import { ROUTES, WATCH_STATES, ACTION_STATES } from '../../common/constants';
import { setupEnvironment, pageHelpers, nextTick } from './helpers';
import { WatchStatusTestBed } from './helpers/watch_status.helpers';
import { WATCH } from './helpers/jest_constants';
-import { getWatchHistory } from '../__fixtures__';
-import moment from 'moment';
-import { ROUTES } from '../common/constants';
-import { WATCH_STATES, ACTION_STATES } from '../common/constants';
const { API_ROOT } = ROUTES;
diff --git a/x-pack/plugins/watcher/tsconfig.json b/x-pack/plugins/watcher/tsconfig.json
index 9f5c0db779f94..15a28d498f2bd 100644
--- a/x-pack/plugins/watcher/tsconfig.json
+++ b/x-pack/plugins/watcher/tsconfig.json
@@ -8,10 +8,10 @@
"declarationMap": true
},
"include": [
+ "__jest__/**/*",
"server/**/*",
"public/**/*",
"common/**/*",
- "tests_client_integration/**/*",
"__fixtures__/*",
"../../../typings/**/*"
],
From e62887b9d7e436972a70466cbde0b78c633df049 Mon Sep 17 00:00:00 2001
From: Ignacio Rivas
Date: Thu, 20 May 2021 14:56:52 +0200
Subject: [PATCH 02/33] [Ingest pipelines] fix default paramenter for
ignore_missing in csv processor (#100316)
* fix: set ignoreMissingField to true by default
* Add missing serializer to trim fieldConfig
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
---
.../__jest__/processors/csv.test.tsx | 172 ++++++++++++++++++
.../__jest__/processors/processor.helpers.tsx | 7 +-
.../processor_form/processors/csv.tsx | 36 +++-
3 files changed, 209 insertions(+), 6 deletions(-)
create mode 100644 x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/csv.test.tsx
diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/csv.test.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/csv.test.tsx
new file mode 100644
index 0000000000000..b40b46967dae5
--- /dev/null
+++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/csv.test.tsx
@@ -0,0 +1,172 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { act } from 'react-dom/test-utils';
+import { setup, SetupResult, getProcessorValue } from './processor.helpers';
+
+// Default parameter values automatically added to the CSV processor when saved
+const defaultCSVParameters = {
+ description: undefined,
+ if: undefined,
+ ignore_missing: undefined,
+ ignore_failure: undefined,
+ empty_value: undefined,
+ quote: undefined,
+ separator: undefined,
+ tag: undefined,
+ trim: undefined,
+};
+
+const CSV_TYPE = 'csv';
+
+describe('Processor: CSV', () => {
+ let onUpdate: jest.Mock;
+ let testBed: SetupResult;
+
+ beforeAll(() => {
+ jest.useFakeTimers();
+ });
+
+ afterAll(() => {
+ jest.useRealTimers();
+ });
+
+ beforeEach(async () => {
+ onUpdate = jest.fn();
+
+ await act(async () => {
+ testBed = await setup({
+ value: {
+ processors: [],
+ },
+ onFlyoutOpen: jest.fn(),
+ onUpdate,
+ });
+ });
+
+ testBed.component.update();
+
+ // Open flyout to add new processor
+ testBed.actions.addProcessor();
+ // Add type (the other fields are not visible until a type is selected)
+ await testBed.actions.addProcessorType(CSV_TYPE);
+ });
+
+ test('prevents form submission if required fields are not provided', async () => {
+ const {
+ actions: { saveNewProcessor },
+ form,
+ } = testBed;
+
+ // Click submit button with only the type defined
+ await saveNewProcessor();
+
+ // Expect form error as "field" and "target_field" are required parameters
+ expect(form.getErrorsMessages()).toEqual([
+ 'A field value is required.',
+ 'A target fields value is required.',
+ ]);
+ });
+
+ test('saves with default parameter values', async () => {
+ const {
+ actions: { saveNewProcessor },
+ form,
+ find,
+ component,
+ } = testBed;
+
+ // Add "field" value (required)
+ form.setInputValue('fieldNameField.input', 'field_1');
+ // Add "target_field" value (required)
+ await act(async () => {
+ find('targetFieldsField.input').simulate('change', [{ label: 'a_value' }]);
+ });
+ component.update();
+
+ // Save the field
+ await saveNewProcessor();
+
+ const processors = getProcessorValue(onUpdate, CSV_TYPE);
+ expect(processors[0][CSV_TYPE]).toEqual({
+ ...defaultCSVParameters,
+ field: 'field_1',
+ target_fields: ['a_value'],
+ });
+ });
+
+ test('should send ignore_missing:false when the toggle is disabled', async () => {
+ const {
+ actions: { saveNewProcessor },
+ form,
+ find,
+ component,
+ } = testBed;
+
+ // Add "field" value (required)
+ form.setInputValue('fieldNameField.input', 'field_1');
+ // Add "target_field" value (required)
+ await act(async () => {
+ find('targetFieldsField.input').simulate('change', [{ label: 'a_value' }]);
+ });
+ component.update();
+ // Disable ignore missing toggle
+ form.toggleEuiSwitch('ignoreMissingSwitch.input');
+
+ // Save the field with new changes
+ await saveNewProcessor();
+
+ const processors = getProcessorValue(onUpdate, CSV_TYPE);
+ expect(processors[0][CSV_TYPE]).toEqual({
+ ...defaultCSVParameters,
+ field: 'field_1',
+ target_fields: ['a_value'],
+ ignore_missing: false,
+ });
+ });
+
+ test('allows optional parameters to be set', async () => {
+ const {
+ actions: { saveNewProcessor },
+ form,
+ find,
+ component,
+ } = testBed;
+
+ // Add "field" value (required)
+ form.setInputValue('fieldNameField.input', 'field_1');
+ // Add "target_field" value (required)
+ await act(async () => {
+ find('targetFieldsField.input').simulate('change', [{ label: 'a_value' }]);
+ });
+ component.update();
+
+ // Set optional parameters
+ form.toggleEuiSwitch('trimSwitch.input');
+ form.toggleEuiSwitch('ignoreFailureSwitch.input');
+ form.toggleEuiSwitch('ignoreMissingSwitch.input');
+ form.setInputValue('quoteValueField.input', '"');
+ form.setInputValue('emptyValueField.input', ' ');
+ form.setInputValue('separatorValueField.input', ',');
+
+ // Save the field with new changes
+ await saveNewProcessor();
+
+ const processors = getProcessorValue(onUpdate, CSV_TYPE);
+ expect(processors[0][CSV_TYPE]).toEqual({
+ ...defaultCSVParameters,
+ field: 'field_1',
+ target_fields: ['a_value'],
+ trim: true,
+ ignore_failure: true,
+ ignore_missing: false,
+ separator: ',',
+ quote: '"',
+ empty_value: ' ',
+ });
+ });
+});
diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx
index 797d26f2404ab..193e94c7aeb9e 100644
--- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx
+++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/__jest__/processors/processor.helpers.tsx
@@ -148,4 +148,9 @@ type TestSubject =
| 'ifField.textarea'
| 'targetField.input'
| 'keepOriginalField.input'
- | 'removeIfSuccessfulField.input';
+ | 'removeIfSuccessfulField.input'
+ | 'targetFieldsField.input'
+ | 'separatorValueField.input'
+ | 'quoteValueField.input'
+ | 'emptyValueField.input'
+ | 'trimSwitch.input';
diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/csv.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/csv.tsx
index b192ee0494bb3..1fbfba387dcb6 100644
--- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/csv.tsx
+++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/csv.tsx
@@ -18,6 +18,7 @@ import {
ToggleField,
ComboBoxField,
ValidationFunc,
+ SerializerFunc,
} from '../../../../../../shared_imports';
import { FieldsConfig } from './shared';
@@ -112,6 +113,7 @@ const fieldsConfig: FieldsConfig = {
type: FIELD_TYPES.TOGGLE,
defaultValue: false,
deserializer: to.booleanOrUndef,
+ serializer: from.undefinedIfValue(false),
label: i18n.translate('xpack.ingestPipelines.pipelineEditor.csvForm.trimFieldLabel', {
defaultMessage: 'Trim',
}),
@@ -148,17 +150,41 @@ export const CSV: FunctionComponent = () => {
config={fieldsConfig.target_fields}
component={ComboBoxField}
path="fields.target_fields"
+ data-test-subj="targetFieldsField"
/>
-
+
-
+
-
+
-
+
-
+ }
+ />
>
);
};
From 59adbb069e50c82d2081ce16516cb8315461d43a Mon Sep 17 00:00:00 2001
From: Pete Hampton
Date: Thu, 20 May 2021 14:02:05 +0100
Subject: [PATCH 03/33] Refactor away from expected error. Handle 404 as any
other error. (#100383)
---
.../spaces_usage_collector.test.ts | 20 +-------
.../spaces_usage_collector.ts | 49 +++++++------------
2 files changed, 21 insertions(+), 48 deletions(-)
diff --git a/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts b/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts
index d3d2763da0d78..19228614dc614 100644
--- a/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts
+++ b/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts
@@ -115,7 +115,7 @@ const getMockedEsClient = (esClientMock: jest.Mock) => {
};
describe('error handling', () => {
- it('handles a 404 when searching for space usage', async () => {
+ it('throws error if cluster unavailable', async () => {
const { features, licensing, usageCollection, usageStatsService } = setup({
license: { isAvailable: true, type: 'basic' },
});
@@ -126,24 +126,8 @@ describe('error handling', () => {
usageStatsServicePromise: Promise.resolve(usageStatsService),
});
const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;
- esClient.search.mockRejectedValue({ status: 404 });
- await collector.fetch(getMockFetchContext(esClient));
- });
-
- it('throws error for a non-404', async () => {
- const { features, licensing, usageCollection, usageStatsService } = setup({
- license: { isAvailable: true, type: 'basic' },
- });
- const collector = getSpacesUsageCollector(usageCollection as any, {
- kibanaIndexConfig$: Rx.of({ kibana: { index: '.kibana' } }),
- features,
- licensing,
- usageStatsServicePromise: Promise.resolve(usageStatsService),
- });
- const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;
-
- const statusCodes = [401, 402, 403, 500];
+ const statusCodes = [401, 402, 403, 404, 500];
for (const statusCode of statusCodes) {
const error = { status: statusCode };
esClient.search.mockRejectedValue(error);
diff --git a/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts b/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts
index a43171fc3b464..93892378717d5 100644
--- a/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts
+++ b/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts
@@ -47,42 +47,31 @@ async function getSpacesUsage(
}
const knownFeatureIds = features.getKibanaFeatures().map((feature) => feature.id);
-
- let resp: SpacesAggregationResponse | undefined;
- try {
- // @ts-expect-error `SearchResponse['hits']['total']` incorrectly expects `number` type instead of `{ value: number }`.
- ({ body: resp } = await esClient.search({
- index: kibanaIndex,
- body: {
- track_total_hits: true,
- query: {
- term: {
- type: {
- value: 'space',
- },
+ const { body: resp } = (await esClient.search({
+ index: kibanaIndex,
+ body: {
+ track_total_hits: true,
+ query: {
+ term: {
+ type: {
+ value: 'space',
},
},
- aggs: {
- disabledFeatures: {
- terms: {
- field: 'space.disabledFeatures',
- include: knownFeatureIds,
- size: knownFeatureIds.length,
- },
+ },
+ aggs: {
+ disabledFeatures: {
+ terms: {
+ field: 'space.disabledFeatures',
+ include: knownFeatureIds,
+ size: knownFeatureIds.length,
},
},
- size: 0,
},
- }));
- } catch (err) {
- if (err.status === 404) {
- return null;
- }
-
- throw err;
- }
+ size: 0,
+ },
+ })) as { body: SpacesAggregationResponse };
- const { hits, aggregations } = resp!;
+ const { hits, aggregations } = resp;
const count = hits?.total?.value ?? 0;
const disabledFeatureBuckets = aggregations?.disabledFeatures?.buckets ?? [];
From 320c9e0198fbe5e30c05f7448612ce3f42338dff Mon Sep 17 00:00:00 2001
From: Jen Huang
Date: Thu, 20 May 2021 06:04:41 -0700
Subject: [PATCH 04/33] Add back install button for integrations that aren't
installed yet (#100370)
---
.../sections/epm/screens/detail/settings/settings.tsx | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/epm/screens/detail/settings/settings.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/epm/screens/detail/settings/settings.tsx
index 3bdb4bdb7460b..f01364fc78157 100644
--- a/x-pack/plugins/fleet/public/applications/fleet/sections/epm/screens/detail/settings/settings.tsx
+++ b/x-pack/plugins/fleet/public/applications/fleet/sections/epm/screens/detail/settings/settings.tsx
@@ -171,6 +171,16 @@ export const SettingsPage: React.FC = memo(({ packageInfo }: Props) => {
}}
/>
+
+
+
+
+
+
+
) : (
removable && (
From 08884a6249734491ae2ac415888f4633b22627dc Mon Sep 17 00:00:00 2001
From: Kaarina Tungseth
Date: Thu, 20 May 2021 08:42:39 -0500
Subject: [PATCH 05/33] [DOCS] Fixes Discover link on runtime fields page
(#100335)
---
docs/management/manage-index-patterns.asciidoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/management/manage-index-patterns.asciidoc b/docs/management/manage-index-patterns.asciidoc
index 94870733174ad..28e823e3e48b8 100644
--- a/docs/management/manage-index-patterns.asciidoc
+++ b/docs/management/manage-index-patterns.asciidoc
@@ -45,8 +45,8 @@ Create runtime fields in your index patterns, or create runtime fields in *Disco
The script must match the field *Type*, or the script fails.
. Click *Create field*.
-//+
-//For information on how to create runtime fields in *Discover*, refer to <>.
++
+For information on how to create runtime fields in *Discover*, refer to <>.
+
For information on how to create runtime fields in *Lens*, refer to <>.
From 97b6d1eca8960793dbd0bca28ae319b0af0704e6 Mon Sep 17 00:00:00 2001
From: Pete Hampton
Date: Thu, 20 May 2021 15:39:50 +0100
Subject: [PATCH 06/33] Add ML usage collector descriptions to the schema.
(#100387)
* Add ML usage collector descriptions to the schema.
* Update the telemetry mappings file
---
.../server/usage/collector.ts | 187 +++++++++++++++---
.../schema/xpack_plugins.json | 145 +++++++++++---
2 files changed, 274 insertions(+), 58 deletions(-)
diff --git a/x-pack/plugins/security_solution/server/usage/collector.ts b/x-pack/plugins/security_solution/server/usage/collector.ts
index f27f6a76b0891..51c5c956574e7 100644
--- a/x-pack/plugins/security_solution/server/usage/collector.ts
+++ b/x-pack/plugins/security_solution/server/usage/collector.ts
@@ -226,43 +226,172 @@ export const registerCollector: RegisterCollector = ({
ml_jobs: {
type: 'array',
items: {
- job_id: { type: 'keyword' },
- open_time: { type: 'keyword' },
- create_time: { type: 'keyword' },
- finished_time: { type: 'keyword' },
- state: { type: 'keyword' },
+ job_id: {
+ type: 'keyword',
+ _meta: { description: 'Identifier for the anomaly detection job' },
+ },
+ open_time: {
+ type: 'keyword',
+ _meta: {
+ description: 'For open jobs only, the elapsed time for which the job has been open',
+ },
+ },
+ create_time: {
+ type: 'keyword',
+ _meta: { description: 'The time the job was created' },
+ },
+ finished_time: {
+ type: 'keyword',
+ _meta: {
+ description: 'If the job closed or failed, this is the time the job finished',
+ },
+ },
+ state: {
+ type: 'keyword',
+ _meta: { description: 'The status of the anomaly detection job' },
+ },
data_counts: {
- bucket_count: { type: 'long' },
- empty_bucket_count: { type: 'long' },
- input_bytes: { type: 'long' },
- input_record_count: { type: 'long' },
- last_data_time: { type: 'long' },
- processed_record_count: { type: 'long' },
+ bucket_count: {
+ type: 'long',
+ _meta: { description: 'The number of buckets processed' },
+ },
+ empty_bucket_count: {
+ type: 'long',
+ _meta: { description: 'The number of buckets which did not contain any data' },
+ },
+ input_bytes: {
+ type: 'long',
+ _meta: {
+ description:
+ 'The number of bytes of input data posted to the anomaly detection job',
+ },
+ },
+ input_record_count: {
+ type: 'long',
+ _meta: {
+ description: 'The number of input documents posted to the anomaly detection job',
+ },
+ },
+ last_data_time: {
+ type: 'long',
+ _meta: {
+ description:
+ 'The timestamp at which data was last analyzed, according to server time',
+ },
+ },
+ processed_record_count: {
+ type: 'long',
+ _meta: {
+ description:
+ 'The number of input documents that have been processed by the anomaly detection job',
+ },
+ },
},
model_size_stats: {
- bucket_allocation_failures_count: { type: 'long' },
- model_bytes: { type: 'long' },
- model_bytes_exceeded: { type: 'long' },
- model_bytes_memory_limit: { type: 'long' },
- peak_model_bytes: { type: 'long' },
+ bucket_allocation_failures_count: {
+ type: 'long',
+ _meta: {
+ description:
+ 'The number of buckets for which new entities in incoming data were not processed due to insufficient model memory',
+ },
+ },
+ model_bytes: {
+ type: 'long',
+ _meta: { description: 'The number of bytes of memory used by the models' },
+ },
+ model_bytes_exceeded: {
+ type: 'long',
+ _meta: {
+ description:
+ 'The number of bytes over the high limit for memory usage at the last allocation failure',
+ },
+ },
+ model_bytes_memory_limit: {
+ type: 'long',
+ _meta: {
+ description:
+ 'The upper limit for model memory usage, checked on increasing values',
+ },
+ },
+ peak_model_bytes: {
+ type: 'long',
+ _meta: {
+ description: 'The peak number of bytes of memory ever used by the models',
+ },
+ },
},
timing_stats: {
- bucket_count: { type: 'long' },
- exponential_average_bucket_processing_time_ms: { type: 'long' },
- exponential_average_bucket_processing_time_per_hour_ms: { type: 'long' },
- maximum_bucket_processing_time_ms: { type: 'long' },
- minimum_bucket_processing_time_ms: { type: 'long' },
- total_bucket_processing_time_ms: { type: 'long' },
+ bucket_count: {
+ type: 'long',
+ _meta: { description: 'The number of buckets processed' },
+ },
+ exponential_average_bucket_processing_time_ms: {
+ type: 'long',
+ _meta: {
+ description:
+ 'Exponential moving average of all bucket processing times, in milliseconds',
+ },
+ },
+ exponential_average_bucket_processing_time_per_hour_ms: {
+ type: 'long',
+ _meta: {
+ description:
+ 'Exponentially-weighted moving average of bucket processing times calculated in a 1 hour time window, in milliseconds',
+ },
+ },
+ maximum_bucket_processing_time_ms: {
+ type: 'long',
+ _meta: {
+ description: 'Maximum among all bucket processing times, in milliseconds',
+ },
+ },
+ minimum_bucket_processing_time_ms: {
+ type: 'long',
+ _meta: {
+ description: 'Minimum among all bucket processing times, in milliseconds',
+ },
+ },
+ total_bucket_processing_time_ms: {
+ type: 'long',
+ _meta: { description: 'Sum of all bucket processing times, in milliseconds' },
+ },
},
datafeed: {
- datafeed_id: { type: 'keyword' },
- state: { type: 'keyword' },
+ datafeed_id: {
+ type: 'keyword',
+ _meta: {
+ description: 'A numerical character string that uniquely identifies the datafeed',
+ },
+ },
+ state: {
+ type: 'keyword',
+ _meta: { description: 'The status of the datafeed' },
+ },
timing_stats: {
- average_search_time_per_bucket_ms: { type: 'long' },
- bucket_count: { type: 'long' },
- exponential_average_search_time_per_hour_ms: { type: 'long' },
- search_count: { type: 'long' },
- total_search_time_ms: { type: 'long' },
+ average_search_time_per_bucket_ms: {
+ type: 'long',
+ _meta: { description: 'The average search time per bucket, in milliseconds' },
+ },
+ bucket_count: {
+ type: 'long',
+ _meta: { description: 'The number of buckets processed' },
+ },
+ exponential_average_search_time_per_hour_ms: {
+ type: 'long',
+ _meta: {
+ description: 'The exponential average search time per hour, in milliseconds',
+ },
+ },
+ search_count: {
+ type: 'long',
+ _meta: { description: 'The number of searches run by the datafeed' },
+ },
+ total_search_time_ms: {
+ type: 'long',
+ _meta: {
+ description: 'The total time the datafeed spent searching, in milliseconds',
+ },
+ },
},
},
},
diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
index 1c0062a20d892..feb6d66060ebc 100644
--- a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
+++ b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
@@ -4994,107 +4994,194 @@
"items": {
"properties": {
"job_id": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "Identifier for the anomaly detection job"
+ }
},
"open_time": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "For open jobs only, the elapsed time for which the job has been open"
+ }
},
"create_time": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "The time the job was created"
+ }
},
"finished_time": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "If the job closed or failed, this is the time the job finished"
+ }
},
"state": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "The status of the anomaly detection job"
+ }
},
"data_counts": {
"properties": {
"bucket_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of buckets processed"
+ }
},
"empty_bucket_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of buckets which did not contain any data"
+ }
},
"input_bytes": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of bytes of input data posted to the anomaly detection job"
+ }
},
"input_record_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of input documents posted to the anomaly detection job"
+ }
},
"last_data_time": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The timestamp at which data was last analyzed, according to server time"
+ }
},
"processed_record_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of input documents that have been processed by the anomaly detection job"
+ }
}
}
},
"model_size_stats": {
"properties": {
"bucket_allocation_failures_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of buckets for which new entities in incoming data were not processed due to insufficient model memory"
+ }
},
"model_bytes": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of bytes of memory used by the models"
+ }
},
"model_bytes_exceeded": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of bytes over the high limit for memory usage at the last allocation failure"
+ }
},
"model_bytes_memory_limit": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The upper limit for model memory usage, checked on increasing values"
+ }
},
"peak_model_bytes": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The peak number of bytes of memory ever used by the models"
+ }
}
}
},
"timing_stats": {
"properties": {
"bucket_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of buckets processed"
+ }
},
"exponential_average_bucket_processing_time_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "Exponential moving average of all bucket processing times, in milliseconds"
+ }
},
"exponential_average_bucket_processing_time_per_hour_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "Exponentially-weighted moving average of bucket processing times calculated in a 1 hour time window, in milliseconds"
+ }
},
"maximum_bucket_processing_time_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "Maximum among all bucket processing times, in milliseconds"
+ }
},
"minimum_bucket_processing_time_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "Minimum among all bucket processing times, in milliseconds"
+ }
},
"total_bucket_processing_time_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "Sum of all bucket processing times, in milliseconds"
+ }
}
}
},
"datafeed": {
"properties": {
"datafeed_id": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "A numerical character string that uniquely identifies the datafeed"
+ }
},
"state": {
- "type": "keyword"
+ "type": "keyword",
+ "_meta": {
+ "description": "The status of the datafeed"
+ }
},
"timing_stats": {
"properties": {
"average_search_time_per_bucket_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The average search time per bucket, in milliseconds"
+ }
},
"bucket_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of buckets processed"
+ }
},
"exponential_average_search_time_per_hour_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The exponential average search time per hour, in milliseconds"
+ }
},
"search_count": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The number of searches run by the datafeed"
+ }
},
"total_search_time_ms": {
- "type": "long"
+ "type": "long",
+ "_meta": {
+ "description": "The total time the datafeed spent searching, in milliseconds"
+ }
}
}
}
From 3e5d9cf47dd547c091eaf85c8eed4c045969d636 Mon Sep 17 00:00:00 2001
From: Stratoula Kalafateli
Date: Thu, 20 May 2021 17:59:48 +0300
Subject: [PATCH 07/33] [TSVB] Update TSVB sample viz with the default
timerange mode (#100376)
---
.../services/sample_data/data_sets/ecommerce/saved_objects.ts | 2 +-
.../server/services/sample_data/data_sets/logs/saved_objects.ts | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/plugins/home/server/services/sample_data/data_sets/ecommerce/saved_objects.ts b/src/plugins/home/server/services/sample_data/data_sets/ecommerce/saved_objects.ts
index cfac42b97c686..dc5831aa00a0b 100644
--- a/src/plugins/home/server/services/sample_data/data_sets/ecommerce/saved_objects.ts
+++ b/src/plugins/home/server/services/sample_data/data_sets/ecommerce/saved_objects.ts
@@ -163,7 +163,7 @@ export const getSavedObjects = (): SavedObject[] => [
defaultMessage: '[eCommerce] Sold Products per Day',
}),
visState:
- '{"title":"[eCommerce] Sold Products per Day","type":"metrics","params":{"id":"61ca57f0-469d-11e7-af02-69e470af7417","type":"gauge","series":[{"id":"61ca57f1-469d-11e7-af02-69e470af7417","color":"#68BC00","split_mode":"everything","metrics":[{"id":"61ca57f2-469d-11e7-af02-69e470af7417","type":"count"}],"separate_axis":0,"axis_position":"right","formatter":"number","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","label":"Trxns / day"}],"time_field":"order_date","index_pattern_ref_name":"ref_1_index_pattern","interval":"1d","axis_position":"left","axis_formatter":"number","axis_scale":"normal","show_legend":1,"show_grid":1,"gauge_color_rules":[{"value":150,"id":"6da070c0-b891-11e8-b645-195edeb9de84","gauge":"rgba(104,188,0,1)","operator":"gte"},{"value":150,"id":"9b0cdbc0-b891-11e8-b645-195edeb9de84","gauge":"rgba(244,78,59,1)","operator":"lt"}],"gauge_width":"15","gauge_inner_width":10,"gauge_style":"half","filter":"","gauge_max":"300","use_kibana_indexes":true},"aggs":[]}',
+ '{"title":"[eCommerce] Sold Products per Day","type":"metrics","params":{"id":"61ca57f0-469d-11e7-af02-69e470af7417","type":"gauge","series":[{"id":"61ca57f1-469d-11e7-af02-69e470af7417","color":"#68BC00","split_mode":"everything","metrics":[{"id":"61ca57f2-469d-11e7-af02-69e470af7417","type":"count"}],"separate_axis":0,"axis_position":"right","formatter":"number","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","label":"Trxns / day"}],"time_field":"order_date","index_pattern_ref_name":"ref_1_index_pattern","interval":"1d","axis_position":"left","axis_formatter":"number","axis_scale":"normal","show_legend":1,"show_grid":1,"time_range_mode":"entire_time_range","gauge_color_rules":[{"value":150,"id":"6da070c0-b891-11e8-b645-195edeb9de84","gauge":"rgba(104,188,0,1)","operator":"gte"},{"value":150,"id":"9b0cdbc0-b891-11e8-b645-195edeb9de84","gauge":"rgba(244,78,59,1)","operator":"lt"}],"gauge_width":"15","gauge_inner_width":10,"gauge_style":"half","filter":"","gauge_max":"300","use_kibana_indexes":true},"aggs":[]}',
uiStateJSON: '{}',
description: '',
version: 1,
diff --git a/src/plugins/home/server/services/sample_data/data_sets/logs/saved_objects.ts b/src/plugins/home/server/services/sample_data/data_sets/logs/saved_objects.ts
index a68d6bfe9cc58..4a17f96bf89ba 100644
--- a/src/plugins/home/server/services/sample_data/data_sets/logs/saved_objects.ts
+++ b/src/plugins/home/server/services/sample_data/data_sets/logs/saved_objects.ts
@@ -89,7 +89,7 @@ export const getSavedObjects = (): SavedObject[] => [
defaultMessage: '[Logs] Host, Visits and Bytes Table',
}),
visState:
- '{"title":"[Logs] Host, Visits and Bytes Table","type":"metrics","params":{"id":"61ca57f0-469d-11e7-af02-69e470af7417","type":"table","series":[{"id":"bd09d600-e5b1-11e7-bfc2-a1f7e71965a1","color":"#68BC00","split_mode":"everything","metrics":[{"id":"bd09d601-e5b1-11e7-bfc2-a1f7e71965a1","type":"sum","field":"bytes"},{"sigma":"","id":"c9514c90-e5b1-11e7-bfc2-a1f7e71965a1","type":"sum_bucket","field":"bd09d601-e5b1-11e7-bfc2-a1f7e71965a1"}],"seperate_axis":0,"axis_position":"right","formatter":"bytes","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","color_rules":[{"id":"c0c668d0-e5b1-11e7-bfc2-a1f7e71965a1"}],"label":"Bytes (Total)"},{"id":"b7672c30-a6df-11e8-8b18-1da1dfc50975","color":"#68BC00","split_mode":"everything","metrics":[{"id":"b7672c31-a6df-11e8-8b18-1da1dfc50975","type":"sum","field":"bytes"}],"seperate_axis":0,"axis_position":"right","formatter":"bytes","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","color_rules":[{"id":"c0c668d0-e5b1-11e7-bfc2-a1f7e71965a1"}],"label":"Bytes (Last Hour)"},{"id":"f2c20700-a6df-11e8-8b18-1da1dfc50975","color":"#68BC00","split_mode":"everything","metrics":[{"id":"f2c20701-a6df-11e8-8b18-1da1dfc50975","type":"cardinality","field":"ip"},{"sigma":"","id":"f46333e0-a6df-11e8-8b18-1da1dfc50975","type":"sum_bucket","field":"f2c20701-a6df-11e8-8b18-1da1dfc50975"}],"seperate_axis":0,"axis_position":"right","formatter":"number","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","label":"Unique Visits (Total)","color_rules":[{"value":1000,"id":"2e963080-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(211,49,21,1)","operator":"lt"},{"value":1000,"id":"3d4fb880-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(252,196,0,1)","operator":"gte"},{"value":1500,"id":"435f8a20-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(104,188,0,1)","operator":"gte"}],"offset_time":"","value_template":"","trend_arrows":1},{"id":"46fd7fc0-e5b1-11e7-bfc2-a1f7e71965a1","color":"#68BC00","split_mode":"everything","metrics":[{"id":"46fd7fc1-e5b1-11e7-bfc2-a1f7e71965a1","type":"cardinality","field":"ip"}],"seperate_axis":0,"axis_position":"right","formatter":"number","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","label":"Unique Visits (Last Hour)","color_rules":[{"value":10,"id":"4e90aeb0-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(211,49,21,1)","operator":"lt"},{"value":10,"id":"6d59b1c0-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(252,196,0,1)","operator":"gte"},{"value":25,"id":"77578670-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(104,188,0,1)","operator":"gte"}],"offset_time":"","value_template":"","trend_arrows":1}],"time_field":"timestamp","index_pattern_ref_name":"ref_1_index_pattern","use_kibana_indexes": true,"interval":"1h","axis_position":"left","axis_formatter":"number","show_legend":1,"show_grid":1,"bar_color_rules":[{"id":"e9b4e490-e1c6-11e7-b4f6-0f68c45f7387"}],"pivot_id":"extension.keyword","pivot_label":"Type","drilldown_url":"","axis_scale":"normal"},"aggs":[]}',
+ '{"title":"[Logs] Host, Visits and Bytes Table","type":"metrics","params":{"id":"61ca57f0-469d-11e7-af02-69e470af7417","type":"table","series":[{"id":"bd09d600-e5b1-11e7-bfc2-a1f7e71965a1","color":"#68BC00","split_mode":"everything","metrics":[{"id":"bd09d601-e5b1-11e7-bfc2-a1f7e71965a1","type":"sum","field":"bytes"},{"sigma":"","id":"c9514c90-e5b1-11e7-bfc2-a1f7e71965a1","type":"sum_bucket","field":"bd09d601-e5b1-11e7-bfc2-a1f7e71965a1"}],"seperate_axis":0,"axis_position":"right","formatter":"bytes","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","color_rules":[{"id":"c0c668d0-e5b1-11e7-bfc2-a1f7e71965a1"}],"label":"Bytes (Total)"},{"id":"b7672c30-a6df-11e8-8b18-1da1dfc50975","color":"#68BC00","split_mode":"everything","metrics":[{"id":"b7672c31-a6df-11e8-8b18-1da1dfc50975","type":"sum","field":"bytes"}],"seperate_axis":0,"axis_position":"right","formatter":"bytes","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","color_rules":[{"id":"c0c668d0-e5b1-11e7-bfc2-a1f7e71965a1"}],"label":"Bytes (Last Hour)"},{"id":"f2c20700-a6df-11e8-8b18-1da1dfc50975","color":"#68BC00","split_mode":"everything","metrics":[{"id":"f2c20701-a6df-11e8-8b18-1da1dfc50975","type":"cardinality","field":"ip"},{"sigma":"","id":"f46333e0-a6df-11e8-8b18-1da1dfc50975","type":"sum_bucket","field":"f2c20701-a6df-11e8-8b18-1da1dfc50975"}],"seperate_axis":0,"axis_position":"right","formatter":"number","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","label":"Unique Visits (Total)","color_rules":[{"value":1000,"id":"2e963080-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(211,49,21,1)","operator":"lt"},{"value":1000,"id":"3d4fb880-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(252,196,0,1)","operator":"gte"},{"value":1500,"id":"435f8a20-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(104,188,0,1)","operator":"gte"}],"offset_time":"","value_template":"","trend_arrows":1},{"id":"46fd7fc0-e5b1-11e7-bfc2-a1f7e71965a1","color":"#68BC00","split_mode":"everything","metrics":[{"id":"46fd7fc1-e5b1-11e7-bfc2-a1f7e71965a1","type":"cardinality","field":"ip"}],"seperate_axis":0,"axis_position":"right","formatter":"number","chart_type":"line","line_width":1,"point_size":1,"fill":0.5,"stacked":"none","label":"Unique Visits (Last Hour)","color_rules":[{"value":10,"id":"4e90aeb0-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(211,49,21,1)","operator":"lt"},{"value":10,"id":"6d59b1c0-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(252,196,0,1)","operator":"gte"},{"value":25,"id":"77578670-a6e0-11e8-8b18-1da1dfc50975","text":"rgba(104,188,0,1)","operator":"gte"}],"offset_time":"","value_template":"","trend_arrows":1}],"time_field":"timestamp","index_pattern_ref_name":"ref_1_index_pattern","use_kibana_indexes": true,"interval":"1h","axis_position":"left","axis_formatter":"number","show_legend":1,"time_range_mode":"entire_time_range","show_grid":1,"bar_color_rules":[{"id":"e9b4e490-e1c6-11e7-b4f6-0f68c45f7387"}],"pivot_id":"extension.keyword","pivot_label":"Type","drilldown_url":"","axis_scale":"normal"},"aggs":[]}',
uiStateJSON: '{}',
description: '',
version: 1,
From 044c725c719658b3d1521807a92834f6fe5a9203 Mon Sep 17 00:00:00 2001
From: Stacey Gammon
Date: Thu, 20 May 2021 13:22:41 -0400
Subject: [PATCH 08/33] Fix a bunch of bugs with APIDocs system (#99589)
* Remove custom code, add in a hack
* remove artifical limit
* Fix arrow functions in interfaces not having children
* Update docs
* Update api docs after merge from master
* update api docs after merge from master
* update api docs
---
api_docs/actions.json | 94 +-
api_docs/advanced_settings.json | 108 +-
api_docs/alerting.json | 533 +-
api_docs/apm.json | 3226 +-
api_docs/apm_oss.json | 2 +-
api_docs/banners.json | 8 +-
api_docs/beats_management.json | 3 +-
api_docs/bfetch.json | 447 +-
api_docs/cases.json | 22464 +++++++--
api_docs/charts.json | 215 +-
api_docs/core.json | 7224 ++-
api_docs/core_application.json | 225 +-
api_docs/core_chrome.json | 148 +-
api_docs/core_http.json | 10104 +++-
api_docs/core_saved_objects.json | 12946 +++--
api_docs/dashboard.json | 552 +-
api_docs/dashboard.mdx | 3 +
api_docs/dashboard_enhanced.json | 56 +-
api_docs/data.json | 38848 +++++++++++-----
api_docs/data_autocomplete.json | 12 +-
api_docs/data_field_formats.json | 492 +-
api_docs/data_index_patterns.json | 5884 ++-
api_docs/data_query.json | 806 +-
api_docs/data_search.json | 6141 ++-
api_docs/data_ui.json | 26 +-
api_docs/deprecations.mdx | 3976 +-
api_docs/dev_tools.json | 25 +-
api_docs/discover.json | 75 +-
api_docs/discover_enhanced.json | 109 +-
api_docs/embeddable.json | 1338 +-
api_docs/embeddable_enhanced.json | 38 +-
api_docs/encrypted_saved_objects.json | 292 +-
api_docs/enterprise_search.json | 3 +-
api_docs/es_ui_shared.json | 102 +-
api_docs/event_log.json | 22 +-
api_docs/expressions.json | 5165 +-
api_docs/features.json | 156 +-
api_docs/file_data_visualizer.json | 4 +-
api_docs/file_upload.json | 349 +-
api_docs/fleet.json | 3177 +-
api_docs/global_search.json | 103 +-
api_docs/home.json | 143 +-
api_docs/home.mdx | 3 -
api_docs/index_management.json | 4 +-
api_docs/index_pattern_field_editor.json | 55 +-
api_docs/index_pattern_management.json | 49 +-
api_docs/infra.json | 146 +-
api_docs/inspector.json | 150 +-
api_docs/kibana_legacy.json | 29 +-
api_docs/kibana_react.json | 810 +-
api_docs/kibana_utils.json | 2741 +-
api_docs/lens.json | 448 +-
api_docs/license_api_guard.json | 520 +-
api_docs/licensing.json | 732 +-
api_docs/lists.json | 4337 +-
api_docs/lists.mdx | 6 -
api_docs/management.json | 108 +-
api_docs/maps.json | 228 +-
api_docs/maps_ems.json | 18 +-
api_docs/metrics_entities.json | 42 +-
api_docs/ml.json | 244 +-
api_docs/monitoring.json | 63 +-
api_docs/navigation.json | 153 +-
api_docs/newsfeed.json | 20 +-
api_docs/observability.json | 688 +-
api_docs/observability.mdx | 3 -
api_docs/presentation_util.json | 764 +-
api_docs/reporting.json | 230 +-
api_docs/rule_registry.json | 1218 +-
api_docs/rule_registry.mdx | 26 +-
api_docs/runtime_fields.json | 58 +-
api_docs/saved_objects.json | 788 +-
api_docs/saved_objects_management.json | 219 +-
api_docs/saved_objects_tagging.json | 30 +-
api_docs/saved_objects_tagging_oss.json | 171 +-
api_docs/screenshot_mode.json | 345 +
api_docs/screenshot_mode.mdx | 38 +
api_docs/security.json | 190 +-
api_docs/security_oss.json | 22 +-
api_docs/security_solution.json | 13150 +-----
api_docs/security_solution.mdx | 14 -
api_docs/share.json | 43 +-
api_docs/spaces.json | 54 +-
api_docs/spaces_oss.json | 226 +-
api_docs/task_manager.json | 18 +-
api_docs/telemetry.json | 61 +-
api_docs/telemetry_collection_manager.json | 420 +-
api_docs/telemetry_collection_xpack.json | 2 +-
api_docs/telemetry_management_section.json | 18 +-
api_docs/triggers_actions_ui.json | 670 +-
api_docs/ui_actions.json | 113 +-
api_docs/ui_actions_enhanced.json | 455 +-
api_docs/uptime.json | 21 +-
api_docs/url_forwarding.json | 28 +-
api_docs/usage_collection.json | 494 +-
api_docs/vis_type_timeseries.json | 60 +-
api_docs/visualizations.json | 786 +-
.../buid_api_declaration.test.ts | 32 +
.../build_call_signature_dec.ts | 66 +
.../build_variable_dec.ts | 21 +-
.../extract_import_refs.ts | 5 -
.../build_api_declarations/get_signature.ts | 71 +-
.../api_docs/mdx/split_apis_by_folder.test.ts | 4 +-
.../src/plugin_a/public/classes.ts | 2 +
.../__fixtures__/src/plugin_a/public/types.ts | 9 +-
.../src/api_docs/tests/api_doc_suite.test.ts | 34 +-
.../api_docs/tests/snapshots/plugin_a.json | 600 +-
107 files changed, 109859 insertions(+), 48958 deletions(-)
create mode 100644 api_docs/screenshot_mode.json
create mode 100644 api_docs/screenshot_mode.mdx
create mode 100644 packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_call_signature_dec.ts
diff --git a/api_docs/actions.json b/api_docs/actions.json
index 1c08a3661cc24..8bd644be376d7 100644
--- a/api_docs/actions.json
+++ b/api_docs/actions.json
@@ -252,7 +252,9 @@
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 40
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "actions",
@@ -276,7 +278,9 @@
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 41
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
}
],
"initialIsOpen": false
@@ -516,14 +520,55 @@
"label": "executor",
"description": [],
"signature": [
- "ExecutorType",
- ""
+ "(options: ",
+ {
+ "pluginId": "actions",
+ "scope": "server",
+ "docId": "kibActionsPluginApi",
+ "section": "def-server.ActionTypeExecutorOptions",
+ "text": "ActionTypeExecutorOptions"
+ },
+ ") => Promise<",
+ {
+ "pluginId": "actions",
+ "scope": "common",
+ "docId": "kibActionsPluginApi",
+ "section": "def-common.ActionTypeExecutorResult",
+ "text": "ActionTypeExecutorResult"
+ },
+ ">"
],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 116
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "actions",
+ "id": "def-server.options",
+ "type": "Object",
+ "tags": [],
+ "label": "options",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "actions",
+ "scope": "server",
+ "docId": "kibActionsPluginApi",
+ "section": "def-server.ActionTypeExecutorOptions",
+ "text": "ActionTypeExecutorOptions"
+ },
+ ""
+ ],
+ "source": {
+ "path": "x-pack/plugins/actions/server/types.ts",
+ "lineNumber": 84
+ },
+ "deprecated": false
+ }
+ ]
}
],
"initialIsOpen": false
@@ -743,7 +788,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
- "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
+ "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"error\" | \"info\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
],
"source": {
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
@@ -760,7 +805,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
- "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
+ "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
],
"source": {
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
@@ -923,7 +968,38 @@
"docId": "kibActionsPluginApi",
"section": "def-server.ActionResult",
"text": "ActionResult"
- }
+ },
+ ">>; execute: ({ actionId, params, source, }: Pick<",
+ "ExecuteOptions",
+ ", \"source\" | \"params\" | \"actionId\">) => Promise<",
+ {
+ "pluginId": "actions",
+ "scope": "common",
+ "docId": "kibActionsPluginApi",
+ "section": "def-common.ActionTypeExecutorResult",
+ "text": "ActionTypeExecutorResult"
+ },
+ ">; getAll: () => Promise<",
+ "FindActionResult",
+ "[]>; getBulk: (ids: string[]) => Promise<",
+ {
+ "pluginId": "actions",
+ "scope": "server",
+ "docId": "kibActionsPluginApi",
+ "section": "def-server.ActionResult",
+ "text": "ActionResult"
+ },
+ ">[]>; enqueueExecution: (options: ",
+ "ExecuteOptions",
+ ") => Promise; listTypes: () => Promise<",
+ {
+ "pluginId": "actions",
+ "scope": "common",
+ "docId": "kibActionsPluginApi",
+ "section": "def-common.ActionType",
+ "text": "ActionType"
+ },
+ "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; }"
],
"source": {
"path": "x-pack/plugins/actions/server/index.ts",
@@ -1719,7 +1795,7 @@
"label": "config",
"description": [],
"signature": [
- "Record"
+ "{ [x: string]: any; }"
],
"source": {
"path": "x-pack/plugins/actions/common/types.ts",
diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json
index 791915c9fcd61..a87967f0970e9 100644
--- a/api_docs/advanced_settings.json
+++ b/api_docs/advanced_settings.json
@@ -58,7 +58,9 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 30
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "advancedSettings",
@@ -74,7 +76,9 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 31
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "advancedSettings",
@@ -90,7 +94,9 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 32
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
}
]
},
@@ -151,7 +157,55 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 73
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "advancedSettings",
+ "id": "def-public.id",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "id",
+ "description": [],
+ "signature": [
+ "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
+ ],
+ "source": {
+ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
+ "lineNumber": 47
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "advancedSettings",
+ "id": "def-public.component",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "component",
+ "description": [],
+ "signature": [
+ "React.ComponentClass | undefined, any> | React.FunctionComponent | undefined>"
+ ],
+ "source": {
+ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
+ "lineNumber": 47
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "advancedSettings",
+ "id": "def-public.allowOverride",
+ "type": "boolean",
+ "tags": [],
+ "label": "allowOverride",
+ "description": [],
+ "source": {
+ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
+ "lineNumber": 47
+ },
+ "deprecated": false
+ }
+ ]
}
]
},
@@ -198,7 +252,26 @@
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 78
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "advancedSettings",
+ "id": "def-public.id",
+ "type": "CompoundType",
+ "tags": [],
+ "label": "id",
+ "description": [],
+ "signature": [
+ "\"advanced_settings_page_title\" | \"advanced_settings_page_subtitle\" | \"advanced_settings_page_footer\""
+ ],
+ "source": {
+ "path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
+ "lineNumber": 67
+ },
+ "deprecated": false
+ }
+ ]
}
]
}
@@ -217,15 +290,36 @@
"\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context."
],
"signature": [
- "React.LazyExoticComponent"
+ ">> & { readonly _result: typeof ",
+ "Field",
+ "; }"
],
"source": {
"path": "src/plugins/advanced_settings/public/index.ts",
"lineNumber": 20
},
"deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "advancedSettings",
+ "id": "def-public.props",
+ "type": "Uncategorized",
+ "tags": [],
+ "label": "props",
+ "description": [],
+ "signature": [
+ "P"
+ ],
+ "source": {
+ "path": "node_modules/@types/react/index.d.ts",
+ "lineNumber": 359
+ },
+ "deprecated": false
+ }
+ ],
"initialIsOpen": false
}
],
diff --git a/api_docs/alerting.json b/api_docs/alerting.json
index cbe045a4981a0..a42dda758dae1 100644
--- a/api_docs/alerting.json
+++ b/api_docs/alerting.json
@@ -36,7 +36,75 @@
"path": "x-pack/plugins/alerting/public/plugin.ts",
"lineNumber": 15
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "alerting",
+ "id": "def-public.consumer",
+ "type": "string",
+ "tags": [],
+ "label": "consumer",
+ "description": [],
+ "source": {
+ "path": "x-pack/plugins/alerting/public/plugin.ts",
+ "lineNumber": 16
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "alerting",
+ "id": "def-public.alertType",
+ "type": "string",
+ "tags": [],
+ "label": "alertType",
+ "description": [],
+ "source": {
+ "path": "x-pack/plugins/alerting/public/plugin.ts",
+ "lineNumber": 17
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "alerting",
+ "id": "def-public.handler",
+ "type": "Function",
+ "tags": [],
+ "label": "handler",
+ "description": [],
+ "signature": [
+ "(alert: Pick<",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.Alert",
+ "text": "Alert"
+ },
+ ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.AlertType",
+ "text": "AlertType"
+ },
+ "<\"default\", \"recovered\">) => string | ",
+ {
+ "pluginId": "kibanaUtils",
+ "scope": "common",
+ "docId": "kibKibanaUtilsPluginApi",
+ "section": "def-common.JsonObject",
+ "text": "JsonObject"
+ }
+ ],
+ "source": {
+ "path": "x-pack/plugins/alerting/public/plugin.ts",
+ "lineNumber": 18
+ },
+ "deprecated": false
+ }
+ ]
},
{
"parentPluginId": "alerting",
@@ -54,7 +122,62 @@
"path": "x-pack/plugins/alerting/public/plugin.ts",
"lineNumber": 20
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "alerting",
+ "id": "def-public.consumer",
+ "type": "string",
+ "tags": [],
+ "label": "consumer",
+ "description": [],
+ "source": {
+ "path": "x-pack/plugins/alerting/public/plugin.ts",
+ "lineNumber": 20
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "alerting",
+ "id": "def-public.handler",
+ "type": "Function",
+ "tags": [],
+ "label": "handler",
+ "description": [],
+ "signature": [
+ "(alert: Pick<",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.Alert",
+ "text": "Alert"
+ },
+ ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">, alertType: ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.AlertType",
+ "text": "AlertType"
+ },
+ "<\"default\", \"recovered\">) => string | ",
+ {
+ "pluginId": "kibanaUtils",
+ "scope": "common",
+ "docId": "kibKibanaUtilsPluginApi",
+ "section": "def-common.JsonObject",
+ "text": "JsonObject"
+ }
+ ],
+ "source": {
+ "path": "x-pack/plugins/alerting/public/plugin.ts",
+ "lineNumber": 20
+ },
+ "deprecated": false
+ }
+ ]
}
],
"lifecycle": "setup",
@@ -103,7 +226,23 @@
"path": "x-pack/plugins/alerting/public/plugin.ts",
"lineNumber": 23
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "alerting",
+ "id": "def-public.alertId",
+ "type": "string",
+ "tags": [],
+ "label": "alertId",
+ "description": [],
+ "source": {
+ "path": "x-pack/plugins/alerting/public/plugin.ts",
+ "lineNumber": 23
+ },
+ "deprecated": false
+ }
+ ]
}
],
"lifecycle": "start",
@@ -496,7 +635,9 @@
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 46
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "alerting",
@@ -514,7 +655,9 @@
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 47
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "alerting",
@@ -538,7 +681,9 @@
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 48
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "alerting",
@@ -554,7 +699,9 @@
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 49
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
}
],
"initialIsOpen": false
@@ -659,7 +806,23 @@
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 74
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "alerting",
+ "id": "def-server.id",
+ "type": "string",
+ "tags": [],
+ "label": "id",
+ "description": [],
+ "source": {
+ "path": "x-pack/plugins/alerting/server/types.ts",
+ "lineNumber": 75
+ },
+ "deprecated": false
+ }
+ ]
}
],
"initialIsOpen": false
@@ -801,7 +964,14 @@
"label": "executor",
"description": [],
"signature": [
- "ExecutorType",
+ "(options: ",
+ {
+ "pluginId": "alerting",
+ "scope": "server",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-server.AlertExecutorOptions",
+ "text": "AlertExecutorOptions"
+ },
">"
+ ">) => Promise"
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 129
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "alerting",
+ "id": "def-server.options",
+ "type": "Object",
+ "tags": [],
+ "label": "options",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "alerting",
+ "scope": "server",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-server.AlertExecutorOptions",
+ "text": "AlertExecutorOptions"
+ },
+ ""
+ ],
+ "source": {
+ "path": "x-pack/plugins/alerting/server/types.ts",
+ "lineNumber": 107
+ },
+ "deprecated": false
+ }
+ ]
},
{
"parentPluginId": "alerting",
@@ -909,7 +1105,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
- "lineNumber": 132
+ "lineNumber": 140
},
"deprecated": false,
"children": [
@@ -922,7 +1118,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
- "lineNumber": 133
+ "lineNumber": 141
},
"deprecated": false
},
@@ -935,7 +1131,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
- "lineNumber": 134
+ "lineNumber": 142
},
"deprecated": false
},
@@ -948,7 +1144,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
- "lineNumber": 135
+ "lineNumber": 143
},
"deprecated": false
},
@@ -968,11 +1164,11 @@
"section": "def-common.Alert",
"text": "Alert"
},
- ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
+ ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[]"
],
"source": {
"path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts",
- "lineNumber": 136
+ "lineNumber": 144
},
"deprecated": false
}
@@ -988,7 +1184,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 84
+ "lineNumber": 85
},
"deprecated": false,
"children": [
@@ -1012,7 +1208,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 85
+ "lineNumber": 86
},
"deprecated": false,
"children": [
@@ -1035,7 +1231,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 93
+ "lineNumber": 94
},
"deprecated": false,
"isRequired": true
@@ -1055,7 +1251,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 104
+ "lineNumber": 105
},
"deprecated": false,
"children": [
@@ -1073,9 +1269,11 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 105
+ "lineNumber": 106
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
},
{
"parentPluginId": "alerting",
@@ -1101,11 +1299,11 @@
"section": "def-server.AlertsClient",
"text": "AlertsClient"
},
- ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"
+ ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"muteAll\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 106
+ "lineNumber": 107
},
"deprecated": false,
"children": [
@@ -1128,7 +1326,60 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 106
+ "lineNumber": 107
+ },
+ "deprecated": false,
+ "isRequired": true
+ }
+ ],
+ "returnComment": []
+ },
+ {
+ "parentPluginId": "alerting",
+ "id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest",
+ "type": "Function",
+ "tags": [],
+ "label": "getAlertingAuthorizationWithRequest",
+ "description": [],
+ "signature": [
+ "(request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ ") => Pick<",
+ "AlertingAuthorization",
+ ", \"ensureAuthorized\" | \"getFindAuthorizationFilter\" | \"filterByRuleTypeAuthorization\">"
+ ],
+ "source": {
+ "path": "x-pack/plugins/alerting/server/plugin.ts",
+ "lineNumber": 108
+ },
+ "deprecated": false,
+ "children": [
+ {
+ "parentPluginId": "alerting",
+ "id": "def-server.PluginStartContract.getAlertingAuthorizationWithRequest.$1",
+ "type": "Object",
+ "tags": [],
+ "label": "request",
+ "description": [],
+ "signature": [
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ ""
+ ],
+ "source": {
+ "path": "x-pack/plugins/alerting/server/plugin.ts",
+ "lineNumber": 109
},
"deprecated": false,
"isRequired": true
@@ -1156,9 +1407,11 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
- "lineNumber": 107
+ "lineNumber": 111
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
}
],
"initialIsOpen": false
@@ -1174,7 +1427,23 @@
"label": "ActionGroupIdsOf",
"description": [],
"signature": [
- "T extends ActionGroup ? groups : T extends Readonly> ? groups : never"
+ "T extends ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.ActionGroup",
+ "text": "ActionGroup"
+ },
+ " ? groups : T extends Readonly<",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.ActionGroup",
+ "text": "ActionGroup"
+ },
+ "> ? groups : never"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_type.ts",
@@ -1242,7 +1511,7 @@
"label": "AlertsClient",
"description": [],
"signature": [
- "{ get: ({ id, }: { id: string; }) => Promise = never>({ id, }: { id: string; }) => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ",
+ ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ",
"CreateOptions",
") => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: ({ options: { fields, ...options }, }?: { options?: ",
+ ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>; find: = never>({ options: { fields, ...options }, }?: { options?: ",
"FindOptions",
" | undefined; }) => Promise<",
{
@@ -1269,7 +1538,38 @@
"docId": "kibAlertingPluginApi",
"section": "def-server.FindResult",
"text": "FindResult"
- }
+ },
+ ">; update: = never>({ id, data, }: ",
+ "UpdateOptions",
+ ") => Promise<",
+ {
+ "pluginId": "alerting",
+ "scope": "server",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-server.PartialAlert",
+ "text": "PartialAlert"
+ },
+ ">; aggregate: ({ options: { fields, ...options }, }?: { options?: ",
+ "AggregateOptions",
+ " | undefined; }) => Promise<",
+ "AggregateResult",
+ ">; enable: ({ id }: { id: string; }) => Promise; disable: ({ id }: { id: string; }) => Promise; muteAll: ({ id }: { id: string; }) => Promise; getAlertState: ({ id }: { id: string; }) => Promise; getAlertInstanceSummary: ({ id, dateStart, }: ",
+ "GetAlertInstanceSummaryParams",
+ ") => Promise<",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.AlertInstanceSummary",
+ "text": "AlertInstanceSummary"
+ },
+ ">; updateApiKey: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ",
+ "MuteOptions",
+ ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ",
+ "MuteOptions",
+ ") => Promise; listAlertTypes: () => Promise>; }"
],
"source": {
"path": "x-pack/plugins/alerting/server/index.ts",
@@ -1320,7 +1620,23 @@
"label": "PartialAlert",
"description": [],
"signature": [
- "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"
+ "Pick<",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.Alert",
+ "text": "Alert"
+ },
+ ", \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">>"
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
@@ -1337,7 +1653,13 @@
"label": "PublicAlertInstance",
"description": [],
"signature": [
- "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }"
+ "{ getState: () => State; replaceState: (state: State) => ",
+ "AlertInstance",
+ "; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ",
+ "AlertInstance",
+ "; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => ",
+ "AlertInstance",
+ "; }"
],
"source": {
"path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts",
@@ -2413,13 +2735,7 @@
"label": "status",
"description": [],
"signature": [
- {
- "pluginId": "alerting",
- "scope": "common",
- "docId": "kibAlertingPluginApi",
- "section": "def-common.AlertInstanceStatusValues",
- "text": "AlertInstanceStatusValues"
- }
+ "\"OK\" | \"Active\""
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
@@ -2648,13 +2964,7 @@
"label": "status",
"description": [],
"signature": [
- {
- "pluginId": "alerting",
- "scope": "common",
- "docId": "kibAlertingPluginApi",
- "section": "def-common.AlertStatusValues",
- "text": "AlertStatusValues"
- }
+ "\"OK\" | \"Active\" | \"Error\""
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
@@ -2702,7 +3012,7 @@
"label": "instances",
"description": [],
"signature": [
- "Record"
+ "; }"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_instance_summary.ts",
@@ -3115,7 +3425,23 @@
"label": "ActionGroupIdsOf",
"description": [],
"signature": [
- "T extends ActionGroup ? groups : T extends Readonly> ? groups : never"
+ "T extends ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.ActionGroup",
+ "text": "ActionGroup"
+ },
+ " ? groups : T extends Readonly<",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.ActionGroup",
+ "text": "ActionGroup"
+ },
+ "> ? groups : never"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_type.ts",
@@ -3132,11 +3458,11 @@
"label": "AlertActionParam",
"description": [],
"signature": [
- "undefined | null | string | number | false | true | ",
+ "string | number | boolean | ",
"SavedObjectAttributes",
" | ",
"SavedObjectAttributeSingle",
- "[]"
+ "[] | null | undefined"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
@@ -3507,7 +3833,7 @@
"label": "ReservedActionGroups",
"description": [],
"signature": [
- "RecoveryActionGroupId | \"recovered\""
+ "\"recovered\" | RecoveryActionGroupId"
],
"source": {
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
@@ -3524,7 +3850,31 @@
"label": "SanitizedAlert",
"description": [],
"signature": [
- "{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; tags: string[]; muteAll: boolean; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }"
+ "{ enabled: boolean; id: string; name: string; params: Params; actions: ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.AlertAction",
+ "text": "AlertAction"
+ },
+ "[]; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.IntervalSchedule",
+ "text": "IntervalSchedule"
+ },
+ "; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.AlertExecutionStatus",
+ "text": "AlertExecutionStatus"
+ },
+ "; }"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert.ts",
@@ -3541,7 +3891,15 @@
"label": "WithoutReservedActionGroups",
"description": [],
"signature": [
- "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds"
+ "ActionGroupIds extends ",
+ {
+ "pluginId": "alerting",
+ "scope": "common",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-common.ReservedActionGroups",
+ "text": "ReservedActionGroups"
+ },
+ " ? never : ActionGroupIds"
],
"source": {
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
@@ -3585,7 +3943,8 @@
"; }>, ",
"PartialC",
"<{ spaceId: ",
- "StringC"
+ "StringC",
+ "; }>]>"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_task_instance.ts",
@@ -3610,7 +3969,38 @@
", ",
"UnknownC",
">; alertInstances: ",
- "RecordC"
+ "RecordC",
+ "<",
+ "StringC",
+ ", ",
+ "PartialC",
+ "<{ state: ",
+ "RecordC",
+ "<",
+ "StringC",
+ ", ",
+ "UnknownC",
+ ">; meta: ",
+ "PartialC",
+ "<{ lastScheduledActions: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ subgroup: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ group: ",
+ "StringC",
+ "; date: ",
+ "Type",
+ "; }>]>; }>; }>>; previousStartedAt: ",
+ "UnionC",
+ "<[",
+ "NullC",
+ ", ",
+ "Type",
+ "]>; }>"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_task_instance.ts",
@@ -3652,7 +4042,20 @@
", ",
"UnknownC",
">; meta: ",
- "PartialC"
+ "PartialC",
+ "<{ lastScheduledActions: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ subgroup: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ group: ",
+ "StringC",
+ "; date: ",
+ "Type",
+ "; }>]>; }>; }>"
],
"source": {
"path": "x-pack/plugins/alerting/common/alert_instance.ts",
@@ -3669,15 +4072,7 @@
"label": "RecoveredActionGroup",
"description": [],
"signature": [
- "Readonly<",
- {
- "pluginId": "alerting",
- "scope": "common",
- "docId": "kibAlertingPluginApi",
- "section": "def-common.ActionGroup",
- "text": "ActionGroup"
- },
- "<\"recovered\">>"
+ "{ readonly id: \"recovered\"; readonly name: string; }"
],
"source": {
"path": "x-pack/plugins/alerting/common/builtin_action_groups.ts",
diff --git a/api_docs/apm.json b/api_docs/apm.json
index 611bf6f455ec5..95cc86814e99a 100644
--- a/api_docs/apm.json
+++ b/api_docs/apm.json
@@ -74,11 +74,11 @@
"label": "ApmPluginSetup",
"description": [],
"signature": [
- "{ ruleRegistry: FormatterRuleRegistry<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>; }"
+ "{}"
],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
- "lineNumber": 48
+ "lineNumber": 45
},
"deprecated": false,
"lifecycle": "setup",
@@ -96,7 +96,7 @@
],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
- "lineNumber": 51
+ "lineNumber": 47
},
"deprecated": false,
"lifecycle": "start",
@@ -139,11 +139,12 @@
", void, ",
"APMPluginSetupDependencies",
", ",
- "APMPluginStartDependencies"
+ "APMPluginStartDependencies",
+ ">"
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 50
+ "lineNumber": 55
},
"deprecated": false,
"children": [
@@ -159,7 +160,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 60
+ "lineNumber": 65
},
"deprecated": false,
"children": [
@@ -182,7 +183,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 60
+ "lineNumber": 65
},
"deprecated": false,
"isRequired": true
@@ -210,14 +211,33 @@
"APMPluginStartDependencies",
", unknown>, plugins: Pick<",
"APMPluginSetupDependencies",
- ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">) => { config$: ",
+ ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"ruleRegistry\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">) => { config$: ",
"Observable",
"<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
- "SearchAggregatedTransactionSetting"
+ "SearchAggregatedTransactionSetting",
+ "; 'xpack.apm.metricsInterval': number; }>; getApmIndices: () => Promise<",
+ "ApmIndicesConfig",
+ ">; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ "; context: ",
+ "ApmPluginRequestHandlerContext",
+ "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<",
+ "InferSearchResponseOf",
+ ">, ESSearchRequestOf, {}>>; }>; }"
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 64
+ "lineNumber": 69
},
"deprecated": false,
"children": [
@@ -242,7 +262,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 65
+ "lineNumber": 70
},
"deprecated": false,
"isRequired": true
@@ -257,11 +277,11 @@
"signature": [
"Pick<",
"APMPluginSetupDependencies",
- ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">"
+ ", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"ruleRegistry\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">"
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 66
+ "lineNumber": 71
},
"deprecated": false,
"isRequired": true
@@ -289,7 +309,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 200
+ "lineNumber": 270
},
"deprecated": false,
"children": [
@@ -311,7 +331,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 200
+ "lineNumber": 270
},
"deprecated": false,
"isRequired": true
@@ -331,7 +351,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
- "lineNumber": 219
+ "lineNumber": 289
},
"deprecated": false,
"children": [],
@@ -578,6 +598,30 @@
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
},
+ ">; }; apmOss: { setup: ",
+ {
+ "pluginId": "apmOss",
+ "scope": "server",
+ "docId": "kibApmOssPluginApi",
+ "section": "def-server.APMOSSPluginSetup",
+ "text": "APMOSSPluginSetup"
+ },
+ "; start: () => Promise; }; licensing: { setup: ",
+ {
+ "pluginId": "licensing",
+ "scope": "server",
+ "docId": "kibLicensingPluginApi",
+ "section": "def-server.LicensingPluginSetup",
+ "text": "LicensingPluginSetup"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "licensing",
+ "scope": "server",
+ "docId": "kibLicensingPluginApi",
+ "section": "def-server.LicensingPluginStart",
+ "text": "LicensingPluginStart"
+ },
">; }; observability: { setup: { getScopedAnnotationsClient: (requestContext: ",
{
"pluginId": "core",
@@ -585,7 +629,146 @@
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
- }
+ },
+ " & { licensing: ",
+ {
+ "pluginId": "licensing",
+ "scope": "server",
+ "docId": "kibLicensingPluginApi",
+ "section": "def-server.LicensingApiRequestHandlerContext",
+ "text": "LicensingApiRequestHandlerContext"
+ },
+ "; }, request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ",
+ "Annotation",
+ "; }>; getById: (getByIdParams: { id: string; }) => Promise<",
+ "GetResponse",
+ ">; delete: (deleteParams: { id: string; }) => Promise<",
+ "DeleteResponse",
+ ">; } | undefined>; }; start: () => Promise; }; ruleRegistry: { setup: ",
+ "RuleDataPluginService",
+ "; start: () => Promise; }; security?: { setup: ",
+ {
+ "pluginId": "security",
+ "scope": "server",
+ "docId": "kibSecurityPluginApi",
+ "section": "def-server.SecurityPluginSetup",
+ "text": "SecurityPluginSetup"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "security",
+ "scope": "server",
+ "docId": "kibSecurityPluginApi",
+ "section": "def-server.SecurityPluginStart",
+ "text": "SecurityPluginStart"
+ },
+ ">; } | undefined; home?: { setup: ",
+ {
+ "pluginId": "home",
+ "scope": "server",
+ "docId": "kibHomePluginApi",
+ "section": "def-server.HomeServerPluginSetup",
+ "text": "HomeServerPluginSetup"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "home",
+ "scope": "server",
+ "docId": "kibHomePluginApi",
+ "section": "def-server.HomeServerPluginStart",
+ "text": "HomeServerPluginStart"
+ },
+ ">; } | undefined; ml?: { setup: ",
+ "SharedServices",
+ "; start: () => Promise; } | undefined; actions?: { setup: ",
+ {
+ "pluginId": "actions",
+ "scope": "server",
+ "docId": "kibActionsPluginApi",
+ "section": "def-server.PluginSetupContract",
+ "text": "PluginSetupContract"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "actions",
+ "scope": "server",
+ "docId": "kibActionsPluginApi",
+ "section": "def-server.PluginStartContract",
+ "text": "PluginStartContract"
+ },
+ ">; } | undefined; usageCollection?: { setup: ",
+ {
+ "pluginId": "usageCollection",
+ "scope": "server",
+ "docId": "kibUsageCollectionPluginApi",
+ "section": "def-server.UsageCollectionSetup",
+ "text": "UsageCollectionSetup"
+ },
+ "; start: () => Promise; } | undefined; spaces?: { setup: ",
+ {
+ "pluginId": "spaces",
+ "scope": "server",
+ "docId": "kibSpacesPluginApi",
+ "section": "def-server.SpacesPluginSetup",
+ "text": "SpacesPluginSetup"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "spaces",
+ "scope": "server",
+ "docId": "kibSpacesPluginApi",
+ "section": "def-server.SpacesPluginStart",
+ "text": "SpacesPluginStart"
+ },
+ ">; } | undefined; cloud?: { setup: ",
+ {
+ "pluginId": "cloud",
+ "scope": "server",
+ "docId": "kibCloudPluginApi",
+ "section": "def-server.CloudSetup",
+ "text": "CloudSetup"
+ },
+ "; start: () => Promise; } | undefined; taskManager?: { setup: ",
+ {
+ "pluginId": "taskManager",
+ "scope": "server",
+ "docId": "kibTaskManagerPluginApi",
+ "section": "def-server.TaskManagerSetupContract",
+ "text": "TaskManagerSetupContract"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "taskManager",
+ "scope": "server",
+ "docId": "kibTaskManagerPluginApi",
+ "section": "def-server.TaskManagerStartContract",
+ "text": "TaskManagerStartContract"
+ },
+ ">; } | undefined; alerting?: { setup: ",
+ {
+ "pluginId": "alerting",
+ "scope": "server",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-server.PluginSetupContract",
+ "text": "PluginSetupContract"
+ },
+ "; start: () => Promise<",
+ {
+ "pluginId": "alerting",
+ "scope": "server",
+ "docId": "kibAlertingPluginApi",
+ "section": "def-server.PluginStartContract",
+ "text": "PluginStartContract"
+ },
+ ">; } | undefined; }"
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
@@ -595,14 +778,19 @@
},
{
"parentPluginId": "apm",
- "id": "def-server.APMRouteHandlerResources.apmRuleRegistry",
+ "id": "def-server.APMRouteHandlerResources.ruleDataClient",
"type": "Object",
"tags": [],
- "label": "apmRuleRegistry",
+ "label": "ruleDataClient",
"description": [],
"signature": [
- "RuleRegistry",
- "<{ readonly 'kibana.rac.producer': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.uuid': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.id': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.start': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.end': { readonly type: \"date\"; }; readonly 'kibana.rac.alert.duration.us': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.severity.level': { readonly type: \"keyword\"; }; readonly 'kibana.rac.alert.severity.value': { readonly type: \"long\"; }; readonly 'kibana.rac.alert.status': { readonly type: \"keyword\"; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { 'kibana.observability.evaluation.value': { type: \"scaled_float\"; scaling_factor: number; }; 'kibana.observability.evaluation.threshold': { type: \"scaled_float\"; scaling_factor: number; }; 'host.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; 'service.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; } & { readonly 'service.environment': { readonly type: \"keyword\"; }; readonly 'transaction.type': { readonly type: \"keyword\"; }; readonly 'processor.event': { readonly type: \"keyword\"; }; }>"
+ {
+ "pluginId": "ruleRegistry",
+ "scope": "server",
+ "docId": "kibRuleRegistryPluginApi",
+ "section": "def-server.RuleDataClient",
+ "text": "RuleDataClient"
+ }
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
@@ -639,7 +827,9 @@
"label": "APMConfig",
"description": [],
"signature": [
- "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }"
+ "{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
+ "SearchAggregatedTransactionSetting",
+ "; 'xpack.apm.metricsInterval': number; }"
],
"source": {
"path": "x-pack/plugins/apm/server/index.ts",
@@ -656,140 +846,2882 @@
"label": "APMServerRouteRepository",
"description": [],
"signature": [
- "ServerRouteRepository; } & { \"GET /api/apm/index_pattern/dynamic\": ",
"ServerRoute",
- "<\"GET /api/apm/index_pattern/dynamic\", undefined, APMRouteHandlerResources, { dynamicIndexPattern: ",
- "IndexPatternTitleAndFields"
- ],
- "source": {
- "path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts",
- "lineNumber": 60
- },
- "deprecated": false,
- "initialIsOpen": false
- },
- {
- "parentPluginId": "apm",
- "id": "def-server.APMXPackConfig",
- "type": "Type",
- "tags": [],
- "label": "APMXPackConfig",
- "description": [],
- "signature": [
- "{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }"
- ],
- "source": {
- "path": "x-pack/plugins/apm/server/index.ts",
- "lineNumber": 55
- },
- "deprecated": false,
- "initialIsOpen": false
- },
- {
- "parentPluginId": "apm",
- "id": "def-server.InspectResponse",
- "type": "Type",
- "tags": [],
- "label": "InspectResponse",
- "description": [],
- "signature": [
- "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]"
- ],
- "source": {
- "path": "x-pack/plugins/apm/server/routes/typings.ts",
- "lineNumber": 26
- },
- "deprecated": false,
- "initialIsOpen": false
- }
- ],
- "objects": [],
- "setup": {
- "parentPluginId": "apm",
- "id": "def-server.APMPluginSetup",
- "type": "Interface",
- "tags": [],
- "label": "APMPluginSetup",
- "description": [],
- "source": {
- "path": "x-pack/plugins/apm/server/types.ts",
- "lineNumber": 47
- },
- "deprecated": false,
- "children": [
- {
- "parentPluginId": "apm",
- "id": "def-server.APMPluginSetup.config$",
- "type": "Object",
- "tags": [],
- "label": "config$",
- "description": [],
- "signature": [
- "Observable",
- "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
- "SearchAggregatedTransactionSetting",
- "; 'xpack.apm.metricsInterval': number; }>"
- ],
- "source": {
- "path": "x-pack/plugins/apm/server/types.ts",
- "lineNumber": 48
+ "<\"GET /api/apm/index_pattern/dynamic\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
},
- "deprecated": false
- },
- {
- "parentPluginId": "apm",
- "id": "def-server.APMPluginSetup.getApmIndices",
- "type": "Function",
- "tags": [],
- "label": "getApmIndices",
- "description": [],
- "signature": [
- "() => Promise<",
- "ApmIndicesConfig",
- ">"
- ],
- "source": {
- "path": "x-pack/plugins/apm/server/types.ts",
- "lineNumber": 49
+ ", { dynamicIndexPattern: ",
+ "IndexPatternTitleAndFields",
+ " | undefined; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/index_pattern/title\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/index_pattern/title\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
},
- "deprecated": false
- },
- {
- "parentPluginId": "apm",
- "id": "def-server.APMPluginSetup.createApmEventClient",
- "type": "Function",
- "tags": [],
- "label": "createApmEventClient",
- "description": [],
- "signature": [
- "(params: { debug?: boolean | undefined; request: ",
- {
- "pluginId": "core",
- "scope": "server",
- "docId": "kibCoreHttpPluginApi",
- "section": "def-server.KibanaRequest",
- "text": "KibanaRequest"
- },
- "; context: ",
- "ApmPluginRequestHandlerContext",
- "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<",
- "InferSearchResponseOf",
- "; } & { \"GET /api/apm/environments\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/environments\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
},
- "deprecated": false
+ ", { environments: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/errors\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/errors\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ sortField: ",
+ "StringC",
+ "; sortDirection: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<\"asc\">, ",
+ "LiteralC",
+ "<\"desc\">]>; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { errorGroups: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/errors/{groupId}\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/errors/{groupId}\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; groupId: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { transaction: ",
+ "APMError",
+ " | ",
+ "Transaction",
+ " | ",
+ "Span",
+ " | BaseMetric | ",
+ "Profile",
+ " | undefined; error: ",
+ "APMError",
+ "; occurrencesCount: number; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/errors/distribution\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/errors/distribution\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ groupId: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { noHits: boolean; buckets: any; bucketSize: number; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/metrics/charts\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/metrics/charts\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ agentName: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ serviceNodeName: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "MetricsChartsByAgentAPIResponse",
+ ", ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/observability_overview\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/observability_overview\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ bucketSize: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { serviceCount: any; transactionPerMinute: { value: undefined; timeseries: never[]; } | { value: number; timeseries: any; }; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/observability_overview/has_data\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/observability_overview/has_data\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { hasData: boolean; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum/client-metrics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum/client-metrics\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { pageViews: { value: number; }; totalPageLoadDuration: { value: number; }; backEnd: { value: number; }; frontEnd: { value: number; }; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/page-load-distribution\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/page-load-distribution\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>, ",
+ "PartialC",
+ "<{ minPercentile: ",
+ "StringC",
+ "; maxPercentile: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { pageLoadDistribution: { pageLoadDistribution: { x: number; y: number; }[]; percentiles: Record | undefined; minDuration: number; maxDuration: number; } | null; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/page-load-distribution/breakdown\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/page-load-distribution/breakdown\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>, ",
+ "PartialC",
+ "<{ minPercentile: ",
+ "StringC",
+ "; maxPercentile: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ breakdown: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { pageLoadDistBreakdown: { name: string; data: { x: number; y: number; }[]; }[] | undefined; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/page-view-trends\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/page-view-trends\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>, ",
+ "PartialC",
+ "<{ breakdowns: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { topItems: string[]; items: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/services\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/services\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { rumServices: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/visitor-breakdown\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/visitor-breakdown\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { os: any; browsers: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/web-core-vitals\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/web-core-vitals\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { coreVitalPages: any; cls: any; fid: any; lcp: any; tbt: any; fcp: any; lcpRanks: number[]; fidRanks: number[]; clsRanks: number[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/long-task-metrics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/long-task-metrics\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { noOfLongTasks: number; sumOfLongTasks: number; longestLongTask: number; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/url-search\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/url-search\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; percentile: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { total: number; items: { url: string; count: number; pld: number; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum-client/js-errors\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum-client/js-errors\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ pageSize: ",
+ "StringC",
+ "; pageIndex: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ urlQuery: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { totalErrorPages: number; totalErrors: number; totalErrorGroups: number; items: { count: number; errorGroupId: React.ReactText; errorMessage: string; }[] | undefined; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/observability_overview/has_rum_data\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/observability_overview/has_rum_data\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { indices: string; hasData: boolean; serviceName: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/rum/local_filters\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/rum/local_filters\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ filterNames: ",
+ "Type",
+ "<(\"host\" | \"location\" | \"browser\" | \"serviceName\" | \"agentName\" | \"containerId\" | \"podName\" | \"transactionResult\" | \"serviceVersion\" | \"transactionUrl\" | \"device\" | \"os\")[], string, unknown>; }>, ",
+ "TypeC",
+ "<{ uiFilters: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>, ",
+ "TypeC",
+ "<{}>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { localUiFilters: { options: any[]; name: \"host\" | \"location\" | \"browser\" | \"serviceName\" | \"agentName\" | \"containerId\" | \"podName\" | \"transactionResult\" | \"serviceVersion\" | \"transactionUrl\" | \"device\" | \"os\"; title: string; fieldName: string; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/service-map\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/service-map\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { elements: (",
+ "ConnectionElement",
+ " | { data: { id: string; 'span.type': string; label: string; groupedConnections: ({ 'service.name': string; 'service.environment': string | null; 'agent.name': string; serviceAnomalyStats?: ",
+ "ServiceAnomalyStats",
+ " | undefined; label: string | undefined; id?: string | undefined; parent?: string | undefined; position?: cytoscape.Position | undefined; } | { 'span.destination.service.resource': string; 'span.type': string; 'span.subtype': string; label: string | undefined; id?: string | undefined; parent?: string | undefined; position?: cytoscape.Position | undefined; } | { id: string; source: string | undefined; target: string | undefined; label: string | undefined; bidirectional?: boolean | undefined; isInverseEdge?: boolean | undefined; } | undefined)[]; }; } | { data: { id: string; source: string; target: string; }; })[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/service-map/service/{serviceName}\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/service-map/service/{serviceName}\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { avgMemoryUsage: number | null; avgCpuUsage: number | null; transactionStats: { avgTransactionDuration: number | null; avgRequestsPerMinute: number | null; }; avgErrorRate: number | null; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/serviceNodes\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/serviceNodes\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { serviceNodes: { name: string; cpu: number | null; heapMemory: number | null; nonHeapMemory: number | null; threadCount: number | null; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { items: JoinedReturnType; hasHistoricalData: boolean; hasLegacyData: boolean; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/metadata/details\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/metadata/details\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "ServiceMetadataDetails",
+ ", ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/metadata/icons\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/metadata/icons\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "ServiceMetadataIcons",
+ ", ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/agent_name\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/agent_name\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { agentName: string | undefined; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transaction_types\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transaction_types\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { transactionTypes: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/node/{serviceNodeName}/metadata\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/node/{serviceNodeName}/metadata\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; serviceNodeName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { host: React.ReactText; containerId: React.ReactText; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/annotation/search\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/annotation/search\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { annotations: ",
+ "Annotation",
+ "[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"POST /api/apm/services/{serviceName}/annotation\": ",
+ "ServerRoute",
+ "<\"POST /api/apm/services/{serviceName}/annotation\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; body: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ '@timestamp': ",
+ "Type",
+ "; service: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ version: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>]>; }>, ",
+ "PartialC",
+ "<{ message: ",
+ "StringC",
+ "; tags: ",
+ "ArrayC",
+ "<",
+ "StringC",
+ ">; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { _id: string; _index: string; _source: ",
+ "Annotation",
+ "; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/error_groups/main_statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/error_groups/main_statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { is_aggregation_accurate: boolean; error_groups: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/error_groups/detailed_statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/error_groups/detailed_statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ numBuckets: ",
+ "Type",
+ "; transactionType: ",
+ "StringC",
+ "; groupIds: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: _.Dictionary<{ groupId: string; timeseries: ",
+ "Coordinate",
+ "[]; }>; previousPeriod: _.Dictionary<{ timeseries: { x: number; y: number | null | undefined; }[]; groupId: string; }>; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; serviceNodeName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { '@timestamp'?: undefined; agent?: undefined; service?: undefined; container?: undefined; kubernetes?: undefined; host?: undefined; cloud?: undefined; } | { '@timestamp': string; agent: ",
+ "Agent",
+ " | { name: string; version: string; }; service: any; container: any; kubernetes: any; host: any; cloud: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/throughput\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/throughput\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: any; previousPeriod: { x: number; y: number | null | undefined; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/service_overview_instances/main_statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/service_overview_instances/main_statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ latencyAggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".avg>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p95>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p99>]>; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: { serviceNodeName: string; errorRate?: number | undefined; latency?: number | undefined; throughput?: number | undefined; cpuUsage?: number | null | undefined; memoryUsage?: number | null | undefined; }[]; previousPeriod: { serviceNodeName: string; errorRate?: number | undefined; latency?: number | undefined; throughput?: number | undefined; cpuUsage?: number | null | undefined; memoryUsage?: number | null | undefined; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/service_overview_instances/detailed_statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/service_overview_instances/detailed_statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ latencyAggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".avg>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p95>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p99>]>; transactionType: ",
+ "StringC",
+ "; serviceNodeIds: ",
+ "Type",
+ "; numBuckets: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: _.Dictionary<{ serviceNodeName: string; errorRate?: ",
+ "Coordinate",
+ "[] | undefined; latency?: ",
+ "Coordinate",
+ "[] | undefined; throughput?: ",
+ "Coordinate",
+ "[] | undefined; cpuUsage?: ",
+ "Coordinate",
+ "[] | undefined; memoryUsage?: ",
+ "Coordinate",
+ "[] | undefined; }>; previousPeriod: _.Dictionary<{ cpuUsage: { x: number; y: number | null | undefined; }[]; errorRate: { x: number; y: number | null | undefined; }[]; latency: { x: number; y: number | null | undefined; }[]; memoryUsage: { x: number; y: number | null | undefined; }[]; throughput: { x: number; y: number | null | undefined; }[]; serviceNodeName: string; }>; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/dependencies\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/dependencies\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ numBuckets: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { serviceDependencies: ",
+ "ServiceDependencyItem",
+ "[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/profiling/timeline\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/profiling/timeline\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { profilingTimeline: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/profiling/statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/profiling/statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ valueType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".wallTime>, ",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".cpuTime>, ",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".samples>, ",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".allocObjects>, ",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".allocSpace>, ",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".inuseObjects>, ",
+ "LiteralC",
+ "<",
+ "ProfilingValueType",
+ ".inuseSpace>]>; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { nodes: Record; rootNodes: string[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/alerts\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/alerts\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { alerts: any[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/traces/{traceId}\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/traces/{traceId}\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ traceId: ",
+ "StringC",
+ "; }>; query: ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { trace: { errorDocs: ",
+ "APMError",
+ "[]; items: TypeOfProcessorEvent<",
+ "ProcessorEvent",
+ ".transaction | ",
+ "ProcessorEvent",
+ ".span>[]; exceedsMax: boolean; }; errorsPerTransaction: ",
+ "ErrorsPerTransaction",
+ "; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/traces\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/traces\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { items: ",
+ "TransactionGroup",
+ "[]; isAggregationAccurate: boolean; bucketSize: number; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/traces/{traceId}/root_transaction\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/traces/{traceId}/root_transaction\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ traceId: ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { transaction: TypeOfProcessorEvent<",
+ "ProcessorEvent",
+ ">; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/groups\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/groups\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { items: ",
+ "TransactionGroup",
+ "[]; isAggregationAccurate: boolean; bucketSize: number; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/groups/main_statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/groups/main_statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; latencyAggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".avg>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p95>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p99>]>; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { transactionGroups: any; isAggregationAccurate: boolean; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/groups/detailed_statistics\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/groups/detailed_statistics\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>, ",
+ "TypeC",
+ "<{ transactionNames: ",
+ "Type",
+ "; numBuckets: ",
+ "Type",
+ "; transactionType: ",
+ "StringC",
+ "; latencyAggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".avg>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p95>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p99>]>; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: _.Dictionary<{ transactionName: string; latency: ",
+ "Coordinate",
+ "[]; throughput: ",
+ "Coordinate",
+ "[]; errorRate: ",
+ "Coordinate",
+ "[]; impact: number; }>; previousPeriod: _.Dictionary<{ errorRate: { x: number; y: number | null | undefined; }[]; throughput: { x: number; y: number | null | undefined; }[]; latency: { x: number; y: number | null | undefined; }[]; transactionName: string; impact: number; }>; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/latency\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/charts/latency\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; latencyAggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".avg>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p95>, ",
+ "LiteralC",
+ "<",
+ "LatencyAggregationType",
+ ".p99>]>; }>, ",
+ "PartialC",
+ "<{ transactionName: ",
+ "StringC",
+ "; }>, ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>]>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: { overallAvgDuration: any; latencyTimeseries: any; }; previousPeriod: { latencyTimeseries: { x: number; y: number | null | undefined; }[]; overallAvgDuration: any; }; anomalyTimeseries: { jobId: string; anomalyScore: { x0: number; x: number; y: number; }[]; anomalyBoundaries: { x: number; y0: number; y: number; }[]; } | undefined; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/throughput\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/charts/throughput\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ transactionName: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { throughputTimeseries: any[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/distribution\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/charts/distribution\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; transactionName: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ transactionId: ",
+ "StringC",
+ "; traceId: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { noHits: boolean; buckets: { samples: any; count: any; }[]; bucketSize: number; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transaction/charts/breakdown\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transaction/charts/breakdown\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ transactionName: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { timeseries: { title: any; color: any; type: string; data: any; hideLegend: boolean; legendValue: string; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/services/{serviceName}/transactions/charts/error_rate\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/services/{serviceName}/transactions/charts/error_rate\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; query: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ transactionName: ",
+ "StringC",
+ "; }>, ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>, ",
+ "PartialC",
+ "<{ comparisonStart: ",
+ "Type",
+ "; comparisonEnd: ",
+ "Type",
+ "; }>]>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { currentPeriod: { noHits: boolean; transactionErrorRate: ",
+ "Coordinate",
+ "[]; average: number | null; }; previousPeriod: { transactionErrorRate: { x: number; y: number | null | undefined; }[]; noHits: boolean; average: number | null; }; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/alerts/chart_preview/transaction_error_rate\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/alerts/chart_preview/transaction_error_rate\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ aggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<\"avg\">, ",
+ "LiteralC",
+ "<\"95th\">, ",
+ "LiteralC",
+ "<\"99th\">]>; serviceName: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { errorRateChartPreview: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/alerts/chart_preview/transaction_duration\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/alerts/chart_preview/transaction_duration\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ aggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<\"avg\">, ",
+ "LiteralC",
+ "<\"95th\">, ",
+ "LiteralC",
+ "<\"99th\">]>; serviceName: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { latencyChartPreview: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/alerts/chart_preview/transaction_error_count\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/alerts/chart_preview/transaction_error_count\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ aggregationType: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<\"avg\">, ",
+ "LiteralC",
+ "<\"95th\">, ",
+ "LiteralC",
+ "<\"99th\">]>; serviceName: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { errorCountChartPreview: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/correlations/latency/overall_distribution\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/correlations/latency/overall_distribution\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; transactionName: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { maxLatency: null; distributionInterval: null; overallDistribution: null; } | { maxLatency: number; distributionInterval: number; overallDistribution: null; } | { maxLatency: number; distributionInterval: number; overallDistribution: { x: any; y: number; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/correlations/latency/slow_transactions\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/correlations/latency/slow_transactions\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; transactionName: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ durationPercentile: ",
+ "StringC",
+ "; fieldNames: ",
+ "StringC",
+ "; maxLatency: ",
+ "StringC",
+ "; distributionInterval: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { significantTerms: { distribution: { x: any; y: number; }[]; fieldName: string; fieldValue: React.ReactText; score: number; impact: number; fieldCount: number; valueCount: number; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/correlations/errors/overall_timeseries\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/correlations/errors/overall_timeseries\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; transactionName: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { overall: null; } | { overall: { timeseries: { x: number; y: number; }[]; }; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/correlations/errors/failed_transactions\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/correlations/errors/failed_transactions\", ",
+ "TypeC",
+ "<{ query: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; transactionName: ",
+ "StringC",
+ "; transactionType: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ fieldNames: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ environment: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ kuery: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ start: ",
+ "Type",
+ "; end: ",
+ "Type",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { significantTerms: { timeseries: { x: number; y: number; }[]; fieldName: string; fieldValue: React.ReactText; score: number; impact: number; fieldCount: number; valueCount: number; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/agent-configuration\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/agent-configuration\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { configurations: ",
+ "AgentConfiguration",
+ "[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/agent-configuration/view\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/agent-configuration/view\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ name: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "AgentConfiguration",
+ ", ",
+ "APMRouteCreateOptions",
+ ">; } & { \"DELETE /api/apm/settings/agent-configuration\": ",
+ "ServerRoute",
+ "<\"DELETE /api/apm/settings/agent-configuration\", ",
+ "TypeC",
+ "<{ body: ",
+ "TypeC",
+ "<{ service: ",
+ "PartialC",
+ "<{ name: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; }>; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { result: string; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"PUT /api/apm/settings/agent-configuration\": ",
+ "ServerRoute",
+ "<\"PUT /api/apm/settings/agent-configuration\", ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ overwrite: ",
+ "Type",
+ "; }>; }>, ",
+ "TypeC",
+ "<{ body: ",
+ "IntersectionC",
+ "<[",
+ "PartialC",
+ "<{ agent_name: ",
+ "StringC",
+ "; }>, ",
+ "TypeC",
+ "<{ service: ",
+ "PartialC",
+ "<{ name: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; }>; settings: ",
+ "IntersectionC",
+ "<[",
+ "RecordC",
+ "<",
+ "StringC",
+ ", ",
+ "StringC",
+ ">, ",
+ "PartialC",
+ ">]>; }>]>; }>]>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", void, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"POST /api/apm/settings/agent-configuration/search\": ",
+ "ServerRoute",
+ "<\"POST /api/apm/settings/agent-configuration/search\", ",
+ "TypeC",
+ "<{ body: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ service: ",
+ "PartialC",
+ "<{ name: ",
+ "StringC",
+ "; environment: ",
+ "StringC",
+ "; }>; }>, ",
+ "PartialC",
+ "<{ etag: ",
+ "StringC",
+ "; mark_as_applied_by_agent: ",
+ "BooleanC",
+ "; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "SearchHit",
+ "<",
+ "AgentConfiguration",
+ ", undefined, undefined>, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/agent-configuration/services\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/agent-configuration/services\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { serviceNames: string[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/agent-configuration/environments\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/agent-configuration/environments\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { environments: { name: any; alreadyConfigured: any; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/agent-configuration/agent_name\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/agent-configuration/agent_name\", ",
+ "TypeC",
+ "<{ query: ",
+ "TypeC",
+ "<{ serviceName: ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { agentName: string | undefined; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/anomaly-detection/jobs\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/anomaly-detection/jobs\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { jobs: { job_id: string; environment: string; }[]; hasLegacyJobs: boolean; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"POST /api/apm/settings/anomaly-detection/jobs\": ",
+ "ServerRoute",
+ "<\"POST /api/apm/settings/anomaly-detection/jobs\", ",
+ "TypeC",
+ "<{ body: ",
+ "TypeC",
+ "<{ environments: ",
+ "ArrayC",
+ "<",
+ "StringC",
+ ">; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { jobCreated: boolean; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/anomaly-detection/environments\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/anomaly-detection/environments\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { environments: any; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/apm-index-settings\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/apm-index-settings\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { apmIndexSettings: { configurationName: \"apm_oss.sourcemapIndices\" | \"apm_oss.errorIndices\" | \"apm_oss.onboardingIndices\" | \"apm_oss.spanIndices\" | \"apm_oss.transactionIndices\" | \"apm_oss.metricsIndices\" | \"apmAgentConfigurationIndex\" | \"apmCustomLinkIndex\"; defaultValue: string; savedValue: string | undefined; }[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/apm-indices\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/apm-indices\", undefined, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "ApmIndicesConfig",
+ ", ",
+ "APMRouteCreateOptions",
+ ">; } & { \"POST /api/apm/settings/apm-indices/save\": ",
+ "ServerRoute",
+ "<\"POST /api/apm/settings/apm-indices/save\", ",
+ "TypeC",
+ "<{ body: ",
+ "PartialC",
+ "<{ 'apm_oss.sourcemapIndices': ",
+ "StringC",
+ "; 'apm_oss.errorIndices': ",
+ "StringC",
+ "; 'apm_oss.onboardingIndices': ",
+ "StringC",
+ "; 'apm_oss.spanIndices': ",
+ "StringC",
+ "; 'apm_oss.transactionIndices': ",
+ "StringC",
+ "; 'apm_oss.metricsIndices': ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", ",
+ "SavedObject",
+ "<{}>, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/custom_links/transaction\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/custom_links/transaction\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ 'service.name': ",
+ "StringC",
+ "; 'service.environment': ",
+ "StringC",
+ "; 'transaction.name': ",
+ "StringC",
+ "; 'transaction.type': ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", TypeOfProcessorEvent<",
+ "ProcessorEvent",
+ ">, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"GET /api/apm/settings/custom_links\": ",
+ "ServerRoute",
+ "<\"GET /api/apm/settings/custom_links\", ",
+ "PartialC",
+ "<{ query: ",
+ "PartialC",
+ "<{ 'service.name': ",
+ "StringC",
+ "; 'service.environment': ",
+ "StringC",
+ "; 'transaction.name': ",
+ "StringC",
+ "; 'transaction.type': ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { customLinks: ",
+ "CustomLink",
+ "[]; }, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"POST /api/apm/settings/custom_links\": ",
+ "ServerRoute",
+ "<\"POST /api/apm/settings/custom_links\", ",
+ "TypeC",
+ "<{ body: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ label: ",
+ "StringC",
+ "; url: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ id: ",
+ "StringC",
+ "; filters: ",
+ "ArrayC",
+ "<",
+ "TypeC",
+ "<{ key: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<\"\">, ",
+ "KeyofC",
+ "<{ 'service.name': ",
+ "StringC",
+ "; 'service.environment': ",
+ "StringC",
+ "; 'transaction.name': ",
+ "StringC",
+ "; 'transaction.type': ",
+ "StringC",
+ "; }>]>; value: ",
+ "StringC",
+ "; }>>; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", void, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"PUT /api/apm/settings/custom_links/{id}\": ",
+ "ServerRoute",
+ "<\"PUT /api/apm/settings/custom_links/{id}\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ id: ",
+ "StringC",
+ "; }>; body: ",
+ "IntersectionC",
+ "<[",
+ "TypeC",
+ "<{ label: ",
+ "StringC",
+ "; url: ",
+ "StringC",
+ "; }>, ",
+ "PartialC",
+ "<{ id: ",
+ "StringC",
+ "; filters: ",
+ "ArrayC",
+ "<",
+ "TypeC",
+ "<{ key: ",
+ "UnionC",
+ "<[",
+ "LiteralC",
+ "<\"\">, ",
+ "KeyofC",
+ "<{ 'service.name': ",
+ "StringC",
+ "; 'service.environment': ",
+ "StringC",
+ "; 'transaction.name': ",
+ "StringC",
+ "; 'transaction.type': ",
+ "StringC",
+ "; }>]>; value: ",
+ "StringC",
+ "; }>>; }>]>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", void, ",
+ "APMRouteCreateOptions",
+ ">; } & { \"DELETE /api/apm/settings/custom_links/{id}\": ",
+ "ServerRoute",
+ "<\"DELETE /api/apm/settings/custom_links/{id}\", ",
+ "TypeC",
+ "<{ path: ",
+ "TypeC",
+ "<{ id: ",
+ "StringC",
+ "; }>; }>, ",
+ {
+ "pluginId": "apm",
+ "scope": "server",
+ "docId": "kibApmPluginApi",
+ "section": "def-server.APMRouteHandlerResources",
+ "text": "APMRouteHandlerResources"
+ },
+ ", { result: string; }, ",
+ "APMRouteCreateOptions",
+ ">; }>"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts",
+ "lineNumber": 60
+ },
+ "deprecated": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "apm",
+ "id": "def-server.APMXPackConfig",
+ "type": "Type",
+ "tags": [],
+ "label": "APMXPackConfig",
+ "description": [],
+ "signature": [
+ "{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ",
+ "SearchAggregatedTransactionSetting",
+ "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/index.ts",
+ "lineNumber": 55
+ },
+ "deprecated": false,
+ "initialIsOpen": false
+ },
+ {
+ "parentPluginId": "apm",
+ "id": "def-server.InspectResponse",
+ "type": "Type",
+ "tags": [],
+ "label": "InspectResponse",
+ "description": [],
+ "signature": [
+ "{ response: any; duration: number; requestType: string; requestParams: Record; esError: Error; }[]"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/routes/typings.ts",
+ "lineNumber": 26
+ },
+ "deprecated": false,
+ "initialIsOpen": false
+ }
+ ],
+ "objects": [],
+ "setup": {
+ "parentPluginId": "apm",
+ "id": "def-server.APMPluginSetup",
+ "type": "Interface",
+ "tags": [],
+ "label": "APMPluginSetup",
+ "description": [],
+ "source": {
+ "path": "x-pack/plugins/apm/server/types.ts",
+ "lineNumber": 51
+ },
+ "deprecated": false,
+ "children": [
+ {
+ "parentPluginId": "apm",
+ "id": "def-server.APMPluginSetup.config$",
+ "type": "Object",
+ "tags": [],
+ "label": "config$",
+ "description": [],
+ "signature": [
+ "Observable",
+ "<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
+ "SearchAggregatedTransactionSetting",
+ "; 'xpack.apm.metricsInterval': number; }>"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/types.ts",
+ "lineNumber": 52
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "apm",
+ "id": "def-server.APMPluginSetup.getApmIndices",
+ "type": "Function",
+ "tags": [],
+ "label": "getApmIndices",
+ "description": [],
+ "signature": [
+ "() => Promise<",
+ "ApmIndicesConfig",
+ ">"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/types.ts",
+ "lineNumber": 53
+ },
+ "deprecated": false,
+ "returnComment": [],
+ "children": []
+ },
+ {
+ "parentPluginId": "apm",
+ "id": "def-server.APMPluginSetup.createApmEventClient",
+ "type": "Function",
+ "tags": [],
+ "label": "createApmEventClient",
+ "description": [],
+ "signature": [
+ "(params: { debug?: boolean | undefined; request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ "; context: ",
+ "ApmPluginRequestHandlerContext",
+ "; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<",
+ "InferSearchResponseOf",
+ ">, ESSearchRequestOf, {}>>; }>"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/types.ts",
+ "lineNumber": 54
+ },
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "apm",
+ "id": "def-server.params",
+ "type": "Object",
+ "tags": [],
+ "label": "params",
+ "description": [],
+ "signature": [
+ "{ debug?: boolean | undefined; request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ "; context: ",
+ "ApmPluginRequestHandlerContext",
+ "; }"
+ ],
+ "source": {
+ "path": "x-pack/plugins/apm/server/types.ts",
+ "lineNumber": 54
+ },
+ "deprecated": false
+ }
+ ]
}
],
"lifecycle": "setup",
diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json
index 35fddcedb22d9..75cb60610335b 100644
--- a/api_docs/apm_oss.json
+++ b/api_docs/apm_oss.json
@@ -645,7 +645,7 @@
"label": "config",
"description": [],
"signature": [
- "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"
+ "{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }"
],
"source": {
"path": "src/plugins/apm_oss/server/plugin.ts",
diff --git a/api_docs/banners.json b/api_docs/banners.json
index 27810c9ecc5db..ab2aedc00eb6c 100644
--- a/api_docs/banners.json
+++ b/api_docs/banners.json
@@ -41,13 +41,7 @@
"label": "placement",
"description": [],
"signature": [
- {
- "pluginId": "banners",
- "scope": "common",
- "docId": "kibBannersPluginApi",
- "section": "def-common.BannerPlacement",
- "text": "BannerPlacement"
- }
+ "\"top\" | \"disabled\""
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
diff --git a/api_docs/beats_management.json b/api_docs/beats_management.json
index 7c892e468d4a0..c8f0f6af96ce8 100644
--- a/api_docs/beats_management.json
+++ b/api_docs/beats_management.json
@@ -57,7 +57,8 @@
"; encryptionKey: ",
"Type",
"; enrollmentTokensTtlInSeconds: ",
- "Type"
+ "Type",
+ "; }>"
],
"source": {
"path": "x-pack/plugins/beats_management/common/index.ts",
diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json
index 35f1ce96b8d3f..76b2118282b2e 100644
--- a/api_docs/bfetch.json
+++ b/api_docs/bfetch.json
@@ -58,7 +58,7 @@
"label": "BatchedFunc",
"description": [],
"signature": [
- "(payload: Payload, signal: AbortSignal | undefined) => Promise"
+ "(payload: Payload, signal?: AbortSignal | undefined) => Promise"
],
"source": {
"path": "src/plugins/bfetch/public/batching/types.ts",
@@ -100,7 +100,26 @@
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 25
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-public.params",
+ "type": "Object",
+ "tags": [],
+ "label": "params",
+ "description": [],
+ "signature": [
+ "FetchStreamingParams"
+ ],
+ "source": {
+ "path": "src/plugins/bfetch/public/plugin.ts",
+ "lineNumber": 25
+ },
+ "deprecated": false
+ }
+ ]
},
{
"parentPluginId": "bfetch",
@@ -126,7 +145,27 @@
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 26
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-public.params",
+ "type": "Object",
+ "tags": [],
+ "label": "params",
+ "description": [],
+ "signature": [
+ "StreamingBatchedFunctionParams",
+ ""
+ ],
+ "source": {
+ "path": "src/plugins/bfetch/public/plugin.ts",
+ "lineNumber": 27
+ },
+ "deprecated": false
+ }
+ ]
}
],
"lifecycle": "start",
@@ -174,7 +213,26 @@
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 40
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-server.data",
+ "type": "Uncategorized",
+ "tags": [],
+ "label": "data",
+ "description": [],
+ "signature": [
+ "BatchItemData"
+ ],
+ "source": {
+ "path": "src/plugins/bfetch/server/plugin.ts",
+ "lineNumber": 40
+ },
+ "deprecated": false
+ }
+ ]
}
],
"initialIsOpen": false
@@ -266,7 +324,55 @@
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 45
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-server.path",
+ "type": "string",
+ "tags": [],
+ "label": "path",
+ "description": [],
+ "source": {
+ "path": "src/plugins/bfetch/server/plugin.ts",
+ "lineNumber": 46
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-server.handler",
+ "type": "Function",
+ "tags": [],
+ "label": "handler",
+ "description": [],
+ "signature": [
+ "(request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ ") => ",
+ {
+ "pluginId": "bfetch",
+ "scope": "server",
+ "docId": "kibBfetchPluginApi",
+ "section": "def-server.BatchProcessingRouteParams",
+ "text": "BatchProcessingRouteParams"
+ },
+ ""
+ ],
+ "source": {
+ "path": "src/plugins/bfetch/server/plugin.ts",
+ "lineNumber": 47
+ },
+ "deprecated": false
+ }
+ ]
},
{
"parentPluginId": "bfetch",
@@ -298,7 +404,55 @@
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 49
},
- "deprecated": false
+ "deprecated": false,
+ "returnComment": [],
+ "children": [
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-server.path",
+ "type": "string",
+ "tags": [],
+ "label": "path",
+ "description": [],
+ "source": {
+ "path": "src/plugins/bfetch/server/plugin.ts",
+ "lineNumber": 50
+ },
+ "deprecated": false
+ },
+ {
+ "parentPluginId": "bfetch",
+ "id": "def-server.params",
+ "type": "Function",
+ "tags": [],
+ "label": "params",
+ "description": [],
+ "signature": [
+ "(request: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.KibanaRequest",
+ "text": "KibanaRequest"
+ },
+ ") => ",
+ {
+ "pluginId": "bfetch",
+ "scope": "common",
+ "docId": "kibBfetchPluginApi",
+ "section": "def-common.StreamingResponseHandler",
+ "text": "StreamingResponseHandler"
+ },
+ ""
+ ],
+ "source": {
+ "path": "src/plugins/bfetch/server/plugin.ts",
+ "lineNumber": 51
+ },
+ "deprecated": false
+ }
+ ]
},
{
"parentPluginId": "bfetch",
@@ -349,13 +503,227 @@
"docId": "kibCoreHttpPluginApi",
"section": "def-server.RequestHandler",
"text": "RequestHandler"
- }
+ },
+ " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ",
+ "Stream",
+ " | undefined>(options: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.CustomHttpResponseOptions",
+ "text": "CustomHttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "; badRequest: (options?: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ErrorHttpResponseOptions",
+ "text": "ErrorHttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">; unauthorized: (options?: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ErrorHttpResponseOptions",
+ "text": "ErrorHttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">; forbidden: (options?: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ErrorHttpResponseOptions",
+ "text": "ErrorHttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">; notFound: (options?: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ErrorHttpResponseOptions",
+ "text": "ErrorHttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">; conflict: (options?: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ErrorHttpResponseOptions",
+ "text": "ErrorHttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">; customError: (options: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.CustomHttpResponseOptions",
+ "text": "CustomHttpResponseOptions"
+ },
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">) => ",
+ "KibanaResponse",
+ "<",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.ResponseError",
+ "text": "ResponseError"
+ },
+ ">; redirected: (options: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.RedirectResponseOptions",
+ "text": "RedirectResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ " | Buffer | ",
+ "Stream",
+ ">; ok: (options?: ",
+ {
+ "pluginId": "core",
+ "scope": "server",
+ "docId": "kibCoreHttpPluginApi",
+ "section": "def-server.HttpResponseOptions",
+ "text": "HttpResponseOptions"
+ },
+ ") => ",
+ "KibanaResponse",
+ "