github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Usage Collection] Report the number of SOs per type (#99344)

Browse source 
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Alejandro Fernández Haro 2021-05-06 19:09:09 +02:00 • committed by GitHub
parent a1954b4334
commit 7c432e3048
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
89 changed files with 17724 additions and 8236 deletions
Download patch file Download diff file Expand all files Collapse all files

92
api_docs/actions.json
View file

@ -148,6 +148,20 @@
"lineNumber": 65
}
},
{
"tags": [],
"id": "def-server.ActionResult.isMissingSecrets",
"type": "CompoundType",
"label": "isMissingSecrets",
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 66
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.ActionResult.config",
@ -156,7 +170,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 66
"lineNumber": 67
},
"signature": [
"Config | undefined"
@ -170,7 +184,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 67
"lineNumber": 68
}
}
],
@ -316,7 +330,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 101
"lineNumber": 102
}
},
{
@ -327,7 +341,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 102
"lineNumber": 103
}
},
{
@ -338,7 +352,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 103
"lineNumber": 104
},
"signature": [
"number | undefined"
@ -352,7 +366,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 104
"lineNumber": 105
},
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
@ -366,7 +380,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 105
"lineNumber": 106
},
"signature": [
"{ params?: ValidatorType<Params> | undefined; config?: ValidatorType<Config> | undefined; secrets?: ValidatorType<Secrets> | undefined; } | undefined"
@ -392,7 +406,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 111
"lineNumber": 112
}
},
{
@ -406,7 +420,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 112
"lineNumber": 113
}
},
{
@ -420,7 +434,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 113
"lineNumber": 114
}
}
],
@ -428,7 +442,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 110
"lineNumber": 111
}
},
{
@ -439,7 +453,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 115
"lineNumber": 116
},
"signature": [
"ExecutorType",
@ -449,7 +463,7 @@
],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 95
"lineNumber": 96
},
"initialIsOpen": false
},
@ -577,7 +591,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 74
"lineNumber": 75
},
"signature": [
"Secrets"
@ -586,7 +600,7 @@
],
"source": {
"path": "x-pack/plugins/actions/server/types.ts",
"lineNumber": 70
"lineNumber": 71
},
"initialIsOpen": false
}
@ -634,7 +648,7 @@
"lineNumber": 50
},
"signature": [
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly timestamp?: string | 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\" | \"info\" | \"error\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
],
"initialIsOpen": false
},
@ -1009,7 +1023,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 88
"lineNumber": 99
}
}
],
@ -1017,13 +1031,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 82
"lineNumber": 93
}
}
],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 81
"lineNumber": 92
},
"lifecycle": "setup",
"initialIsOpen": true
@ -1055,7 +1069,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 93
"lineNumber": 104
}
},
{
@ -1073,13 +1087,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 93
"lineNumber": 104
}
}
],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 93
"lineNumber": 104
}
}
],
@ -1087,7 +1101,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 93
"lineNumber": 104
}
},
{
@ -1110,7 +1124,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 95
"lineNumber": 106
}
},
{
@ -1124,7 +1138,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 96
"lineNumber": 107
}
},
{
@ -1142,13 +1156,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 97
"lineNumber": 108
}
}
],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 97
"lineNumber": 108
}
}
],
@ -1156,7 +1170,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 94
"lineNumber": 105
}
},
{
@ -1202,7 +1216,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 99
"lineNumber": 110
}
}
],
@ -1210,7 +1224,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 99
"lineNumber": 110
}
},
{
@ -1256,7 +1270,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 100
"lineNumber": 111
}
}
],
@ -1264,7 +1278,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 100
"lineNumber": 111
}
},
{
@ -1275,7 +1289,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 101
"lineNumber": 112
},
"signature": [
{
@ -1308,7 +1322,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 103
"lineNumber": 114
}
},
{
@ -1322,7 +1336,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 104
"lineNumber": 115
}
},
{
@ -1336,7 +1350,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 105
"lineNumber": 116
}
},
{
@ -1350,7 +1364,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 106
"lineNumber": 117
}
}
],
@ -1358,13 +1372,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 102
"lineNumber": 113
}
}
],
"source": {
"path": "x-pack/plugins/actions/server/plugin.ts",
"lineNumber": 92
"lineNumber": 103
},
"lifecycle": "start",
"initialIsOpen": true

108
api_docs/alerting.json
View file

@ -103,6 +103,40 @@
"server": {
"classes": [],
"functions": [
{
"id": "def-server.getEsErrorMessage",
"type": "Function",
"children": [
{
"id": "def-server.getEsErrorMessage.$1",
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"ElasticsearchError"
],
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts",
"lineNumber": 37
}
}
],
"signature": [
"(error: ",
"ElasticsearchError",
") => string"
],
"description": [],
"label": "getEsErrorMessage",
"source": {
"path": "x-pack/plugins/alerting/server/lib/errors/es_error_parser.ts",
"lineNumber": 37
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.parseDuration",
"type": "Function",
@ -211,7 +245,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 85
"lineNumber": 86
}
},
{
@ -222,7 +256,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 86
"lineNumber": 87
},
"signature": [
"Date"
@ -236,7 +270,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 87
"lineNumber": 88
},
"signature": [
"Date | null"
@ -250,7 +284,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 88
"lineNumber": 89
},
"signature": [
{
@ -271,7 +305,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 89
"lineNumber": 90
},
"signature": [
"Params"
@ -285,7 +319,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 90
"lineNumber": 91
},
"signature": [
"State"
@ -299,7 +333,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 91
"lineNumber": 92
}
},
{
@ -310,7 +344,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 92
"lineNumber": 93
},
"signature": [
"string | undefined"
@ -324,7 +358,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 93
"lineNumber": 94
}
},
{
@ -335,7 +369,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 94
"lineNumber": 95
},
"signature": [
"string[]"
@ -349,7 +383,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 95
"lineNumber": 96
},
"signature": [
"string | null"
@ -363,7 +397,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 96
"lineNumber": 97
},
"signature": [
"string | null"
@ -372,7 +406,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 78
"lineNumber": 79
},
"initialIsOpen": false
},
@ -443,6 +477,20 @@
},
">"
]
},
{
"tags": [],
"id": "def-server.AlertingApiRequestHandlerContext.areApiKeysEnabled",
"type": "Function",
"label": "areApiKeysEnabled",
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 49
},
"signature": [
"() => Promise<boolean>"
]
}
],
"source": {
@ -466,7 +514,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 219
"lineNumber": 220
},
"signature": [
{
@ -486,7 +534,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 220
"lineNumber": 221
},
"signature": [
{
@ -501,7 +549,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 218
"lineNumber": 219
},
"initialIsOpen": false
},
@ -531,7 +579,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 73
"lineNumber": 74
},
"signature": [
"(id: string) => Pick<",
@ -542,7 +590,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 68
"lineNumber": 69
},
"initialIsOpen": false
},
@ -571,7 +619,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 120
"lineNumber": 121
}
},
{
@ -582,7 +630,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 121
"lineNumber": 122
}
},
{
@ -593,7 +641,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 122
"lineNumber": 123
},
"signature": [
"{ params?: ",
@ -609,7 +657,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 125
"lineNumber": 126
},
"signature": [
{
@ -630,7 +678,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 126
"lineNumber": 127
},
"signature": [
"ActionGroupIds"
@ -644,7 +692,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 127
"lineNumber": 128
},
"signature": [
{
@ -665,7 +713,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 128
"lineNumber": 129
},
"signature": [
"ExecutorType",
@ -688,7 +736,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 139
"lineNumber": 140
}
},
{
@ -699,7 +747,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 140
"lineNumber": 141
},
"signature": [
"{ context?: ",
@ -737,7 +785,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 145
"lineNumber": 146
},
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
@ -746,7 +794,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 112
"lineNumber": 113
},
"initialIsOpen": false
},
@ -1138,7 +1186,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 178
"lineNumber": 179
},
"signature": [
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"apiKey\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"

83
api_docs/apm.json
View file

@ -58,6 +58,22 @@
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.ApmPluginSetup",
"type": "Type",
"label": "ApmPluginSetup",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
"lineNumber": 48
},
"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\"; }; }>; }"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.ApmPluginStart",
"type": "Type",
@ -66,7 +82,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/public/plugin.ts",
"lineNumber": 45
"lineNumber": 51
},
"signature": [
"void"
@ -140,7 +156,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 58
"lineNumber": 60
}
}
],
@ -148,7 +164,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 58
"lineNumber": 60
}
},
{
@ -168,7 +184,7 @@
"APMPluginStartDependencies",
", unknown>, plugins: Pick<",
"APMPluginSetupDependencies",
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">) => { config$: ",
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"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"
@ -195,7 +211,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 63
"lineNumber": 65
}
},
{
@ -206,12 +222,12 @@
"signature": [
"Pick<",
"APMPluginSetupDependencies",
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">"
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"cloud\" | \"observability\" | \"apmOss\" | \"licensing\" | \"spaces\" | \"taskManager\" | \"alerting\">"
],
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 64
"lineNumber": 66
}
}
],
@ -219,7 +235,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 62
"lineNumber": 64
}
},
{
@ -256,7 +272,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 208
"lineNumber": 200
}
}
],
@ -264,7 +280,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 208
"lineNumber": 200
}
},
{
@ -280,13 +296,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 227
"lineNumber": 219
}
}
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 48
"lineNumber": 50
},
"initialIsOpen": false
}
@ -361,7 +377,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 43
"lineNumber": 46
},
"signature": [
{
@ -382,7 +398,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 44
"lineNumber": 47
},
"signature": [
"ApmPluginRequestHandlerContext"
@ -396,7 +412,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 45
"lineNumber": 48
},
"signature": [
"{ query: { _inspect: boolean; }; }"
@ -410,7 +426,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 50
"lineNumber": 53
},
"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': ",
@ -426,7 +442,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 51
"lineNumber": 54
},
"signature": [
"Logger"
@ -440,7 +456,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 52
"lineNumber": 55
},
"signature": [
"{ setup: ",
@ -470,7 +486,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 56
"lineNumber": 59
},
"signature": [
"{ data: { setup: ",
@ -505,20 +521,35 @@
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
},
">; }; apmOss: { setup: ",
">; }; observability: { setup: { getScopedAnnotationsClient: (requestContext: ",
{
"pluginId": "apmOss",
"pluginId": "core",
"scope": "server",
"docId": "kibApmOssPluginApi",
"section": "def-server.APMOSSPluginSetup",
"text": "APMOSSPluginSetup"
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
}
]
},
{
"tags": [],
"id": "def-server.APMRouteHandlerResources.apmRuleRegistry",
"type": "Object",
"label": "apmRuleRegistry",
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 65
},
"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\"; }; }>"
]
}
],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 42
"lineNumber": 45
},
"initialIsOpen": false
}
@ -600,7 +631,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/apm/server/routes/typings.ts",
"lineNumber": 23
"lineNumber": 26
},
"signature": [
"{ response: any; duration: number; requestType: string; requestParams: Record<string, unknown>; esError: Error; }[]"

3
api_docs/apm.mdx
View file

@ -13,6 +13,9 @@ import apmObj from './apm.json';
## Client
### Setup
<DocDefinitionList data={[apmObj.client.setup]}/>
### Start
<DocDefinitionList data={[apmObj.client.start]}/>

32
api_docs/canvas.json
View file

@ -60,7 +60,7 @@
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 65
"lineNumber": 68
},
"signature": [
"CanvasApi"
@ -76,7 +76,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 66
"lineNumber": 69
},
"signature": [
"void"
@ -99,6 +99,32 @@
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
"objects": [
{
"id": "def-common.UI_SETTINGS",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.UI_SETTINGS.ENABLE_LABS_UI",
"type": "string",
"label": "ENABLE_LABS_UI",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/common/index.ts",
"lineNumber": 9
}
}
],
"description": [],
"label": "UI_SETTINGS",
"source": {
"path": "x-pack/plugins/canvas/common/index.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
]
}
}

5
api_docs/canvas.mdx
View file

@ -22,3 +22,8 @@ import canvasObj from './canvas.json';
### Interfaces
<DocDefinitionList data={canvasObj.client.interfaces}/>
## Common
### Objects
<DocDefinitionList data={canvasObj.common.objects}/>

7038
api_docs/cases.json
View file

File diff suppressed because it is too large Load diff

31
api_docs/cases.mdx
View file

@ -11,8 +11,39 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import casesObj from './cases.json';
## Client
### Start
<DocDefinitionList data={[casesObj.client.start]}/>
### Classes
<DocDefinitionList data={casesObj.client.classes}/>
### Interfaces
<DocDefinitionList data={casesObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={casesObj.client.misc}/>
## Server
### Interfaces
<DocDefinitionList data={casesObj.server.interfaces}/>
## Common
### Objects
<DocDefinitionList data={casesObj.common.objects}/>
### Functions
<DocDefinitionList data={casesObj.common.functions}/>
### Interfaces
<DocDefinitionList data={casesObj.common.interfaces}/>
### Enums
<DocDefinitionList data={casesObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={casesObj.common.misc}/>

38
api_docs/cloud.json
View file

@ -121,7 +121,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 35
"lineNumber": 36
},
"signature": [
"string | undefined"
@ -135,7 +135,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 36
"lineNumber": 37
},
"signature": [
"string | undefined"
@ -149,7 +149,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 37
"lineNumber": 38
},
"signature": [
"string | undefined"
@ -163,7 +163,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 38
"lineNumber": 39
},
"signature": [
"string | undefined"
@ -177,7 +177,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 39
"lineNumber": 40
},
"signature": [
"string | undefined"
@ -191,7 +191,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 40
"lineNumber": 41
},
"signature": [
"string | undefined"
@ -205,13 +205,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 41
"lineNumber": 42
}
}
],
"source": {
"path": "x-pack/plugins/cloud/public/plugin.ts",
"lineNumber": 34
"lineNumber": 35
},
"lifecycle": "setup",
"initialIsOpen": true
@ -239,7 +239,21 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 19
"lineNumber": 20
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.CloudSetup.deploymentId",
"type": "string",
"label": "deploymentId",
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
@ -253,7 +267,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 20
"lineNumber": 22
}
},
{
@ -264,7 +278,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 21
"lineNumber": 23
},
"signature": [
"{ url?: string | undefined; secretToken?: string | undefined; }"
@ -273,7 +287,7 @@
],
"source": {
"path": "x-pack/plugins/cloud/server/plugin.ts",
"lineNumber": 18
"lineNumber": 19
},
"lifecycle": "setup",
"initialIsOpen": true

683
api_docs/core.json
View file

File diff suppressed because it is too large Load diff

44
api_docs/core_application.json
View file

@ -1070,7 +1070,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 695
"lineNumber": 700
},
"signature": [
"Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>"
@ -1086,7 +1086,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 704
"lineNumber": 709
},
"signature": [
"Observable",
@ -1131,7 +1131,7 @@
"description": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 712
"lineNumber": 717
}
},
{
@ -1154,7 +1154,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 712
"lineNumber": 717
}
}
],
@ -1162,7 +1162,7 @@
"returnComment": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 712
"lineNumber": 717
}
},
{
@ -1189,7 +1189,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 750
"lineNumber": 755
}
}
],
@ -1197,7 +1197,7 @@
"returnComment": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 750
"lineNumber": 755
}
},
{
@ -1222,7 +1222,7 @@
"description": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 764
"lineNumber": 769
}
},
{
@ -1240,7 +1240,7 @@
"description": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 764
"lineNumber": 769
},
"signature": [
"string | undefined"
@ -1254,7 +1254,7 @@
"description": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 764
"lineNumber": 769
},
"signature": [
"boolean | undefined"
@ -1263,7 +1263,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 764
"lineNumber": 769
}
}
],
@ -1271,7 +1271,7 @@
"returnComment": [],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 764
"lineNumber": 769
}
},
{
@ -1284,7 +1284,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 769
"lineNumber": 774
},
"signature": [
"Observable",
@ -1294,7 +1294,7 @@
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 691
"lineNumber": 696
},
"initialIsOpen": false
},
@ -1541,6 +1541,22 @@
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.NavigateToAppOptions.openInNewTab",
"type": "CompoundType",
"label": "openInNewTab",
"description": [
"\nif true, will open the app in new tab, will share session information via window.open if base"
],
"source": {
"path": "src/core/public/application/types.ts",
"lineNumber": 692
},
"signature": [
"boolean | undefined"
]
}
],
"source": {

2
api_docs/core_chrome.json
View file

@ -2362,7 +2362,7 @@
"lineNumber": 10
},
"signature": [
"\"legacy\" | \"modern\""
"\"modern\" | \"legacy\""
],
"initialIsOpen": false
}

108
api_docs/core_http.json
View file

@ -2990,7 +2990,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 79
"lineNumber": 81
},
"signature": [
"T | undefined"
@ -3006,12 +3006,28 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 81
"lineNumber": 83
},
"signature": [
"Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
]
},
{
"tags": [],
"id": "def-server.CustomHttpResponseOptions.bypassErrorFormat",
"type": "CompoundType",
"label": "bypassErrorFormat",
"description": [
"Bypass the default error formatting"
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 85
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.CustomHttpResponseOptions.statusCode",
@ -3020,13 +3036,13 @@
"description": [],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 82
"lineNumber": 86
}
}
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 77
"lineNumber": 79
},
"initialIsOpen": false
},
@ -3051,7 +3067,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 101
"lineNumber": 105
},
"signature": [
"string | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | undefined"
@ -3067,7 +3083,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 103
"lineNumber": 107
},
"signature": [
"Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
@ -3076,7 +3092,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 99
"lineNumber": 103
},
"initialIsOpen": false
},
@ -3188,6 +3204,22 @@
"signature": [
"Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]> | undefined"
]
},
{
"tags": [],
"id": "def-server.HttpResponseOptions.bypassErrorFormat",
"type": "CompoundType",
"label": "bypassErrorFormat",
"description": [
"Bypass the default error formatting"
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 66
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
@ -3217,7 +3249,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 336
"lineNumber": 343
}
},
{
@ -3230,7 +3262,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 338
"lineNumber": 345
}
},
{
@ -3243,7 +3275,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 340
"lineNumber": 347
}
},
{
@ -3256,7 +3288,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 342
"lineNumber": 349
},
"signature": [
"\"http\" | \"https\" | \"socket\""
@ -3265,7 +3297,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 334
"lineNumber": 341
},
"initialIsOpen": false
},
@ -3634,7 +3666,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 308
"lineNumber": 315
},
"signature": [
"Pick<",
@ -3658,7 +3690,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 314
"lineNumber": 321
},
"signature": [
{
@ -3680,7 +3712,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 319
"lineNumber": 326
},
"signature": [
"() => ",
@ -3696,7 +3728,7 @@
],
"source": {
"path": "src/core/server/http/types.ts",
"lineNumber": 303
"lineNumber": 310
},
"initialIsOpen": false
},
@ -4057,7 +4089,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 65
"lineNumber": 66
}
},
{
@ -4070,7 +4102,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 72
"lineNumber": 73
},
"signature": [
{
@ -4093,7 +4125,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 79
"lineNumber": 80
},
"signature": [
{
@ -4116,7 +4148,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 86
"lineNumber": 87
},
"signature": [
{
@ -4139,7 +4171,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 93
"lineNumber": 94
},
"signature": [
{
@ -4162,7 +4194,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 100
"lineNumber": 101
},
"signature": [
{
@ -4185,7 +4217,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 106
"lineNumber": 107
},
"signature": [
{
@ -4200,7 +4232,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 61
"lineNumber": 62
},
"initialIsOpen": false
},
@ -4906,7 +4938,7 @@
"type": "number",
"label": "maxBytes",
"description": [
"\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayloadBytes`."
"\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`."
],
"source": {
"path": "src/core/server/http/router/route.ts",
@ -5743,7 +5775,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 71
"lineNumber": 73
},
"signature": [
"undefined | string | Record<string, any> | Buffer | ",
@ -5844,7 +5876,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 319
"lineNumber": 323
},
"signature": [
"{ custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | Stream | undefined>(options: CustomHttpResponseOptions<T>) => KibanaResponse<T>; badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; customError: (options: CustomHttpResponseOptions<ResponseError>) => KibanaResponse<ResponseError>; redirected: (options: RedirectResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>; ok: (options?: HttpResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>; accepted: (options?: HttpResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>; noContent: (options?: HttpResponseOptions) => KibanaResponse<undefined>; }"
@ -5882,7 +5914,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 325
"lineNumber": 329
},
"signature": [
"{ badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse<ResponseError>; customError: (options: CustomHttpResponseOptions<ResponseError>) => KibanaResponse<ResponseError>; redirected: (options: RedirectResponseOptions) => KibanaResponse<string | Record<string, any> | Buffer | Stream>; }"
@ -6100,7 +6132,7 @@
],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 89
"lineNumber": 93
},
"signature": [
"HttpResponseOptions & { headers: { location: string;}; }"
@ -6119,7 +6151,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 350
"lineNumber": 351
},
"signature": [
"(context: Context, request: ",
@ -6227,7 +6259,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 376
"lineNumber": 377
},
"signature": [
"(handler: ",
@ -6357,7 +6389,7 @@
],
"source": {
"path": "src/core/server/http/router/router.ts",
"lineNumber": 47
"lineNumber": 48
},
"signature": [
"(route: ",
@ -6511,7 +6543,7 @@
"description": [],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 290
"lineNumber": 294
},
"signature": [
"any"
@ -6525,7 +6557,7 @@
"description": [],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 291
"lineNumber": 295
},
"signature": [
"any"
@ -6539,7 +6571,7 @@
"description": [],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 292
"lineNumber": 296
},
"signature": [
"any"
@ -6567,7 +6599,7 @@
"description": [],
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 298
"lineNumber": 302
}
}
],
@ -6592,7 +6624,7 @@
"label": "custom",
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 297
"lineNumber": 301
},
"tags": [],
"returnComment": []
@ -6604,7 +6636,7 @@
"label": "kibanaResponseFactory",
"source": {
"path": "src/core/server/http/router/response.ts",
"lineNumber": 289
"lineNumber": 293
},
"initialIsOpen": false
},

702
api_docs/core_saved_objects.json
View file

File diff suppressed because it is too large Load diff

224
api_docs/dashboard.json
View file

@ -663,7 +663,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 32
"lineNumber": 37
},
"signature": [
"true"
@ -677,7 +677,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 33
"lineNumber": 38
},
"signature": [
"\"dashboard\""
@ -705,7 +705,27 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 35
"lineNumber": 41
}
},
{
"id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$2",
"type": "Object",
"label": "persistableStateService",
"isRequired": true,
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddablePersistableStateService",
"text": "EmbeddablePersistableStateService"
}
],
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 42
}
}
],
@ -713,7 +733,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 35
"lineNumber": 40
}
},
{
@ -727,7 +747,7 @@
"label": "isEditable",
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 37
"lineNumber": 45
},
"tags": [],
"returnComment": []
@ -743,7 +763,7 @@
"label": "getDisplayName",
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 42
"lineNumber": 50
},
"tags": [],
"returnComment": []
@ -769,7 +789,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 48
"lineNumber": 56
}
},
{
@ -793,7 +813,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 59
"lineNumber": 67
}
},
{
@ -830,7 +850,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 60
"lineNumber": 68
}
}
],
@ -880,15 +900,78 @@
"label": "create",
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 58
"lineNumber": 66
},
"tags": [],
"returnComment": []
},
{
"tags": [],
"id": "def-public.DashboardContainerFactoryDefinition.inject",
"type": "Function",
"label": "inject",
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 74
},
"signature": [
"(state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
", references: ",
"SavedObjectReference",
"[]) => ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
}
]
},
{
"tags": [],
"id": "def-public.DashboardContainerFactoryDefinition.extract",
"type": "Function",
"label": "extract",
"description": [],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 76
},
"signature": [
"(state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
") => { state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
"; references: ",
"SavedObjectReference",
"[]; }"
]
}
],
"source": {
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
"lineNumber": 29
"lineNumber": 34
},
"initialIsOpen": false
}
@ -1275,13 +1358,13 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 90
"lineNumber": 92
}
}
],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 89
"lineNumber": 91
},
"initialIsOpen": false
},
@ -1810,7 +1893,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 87
"lineNumber": 89
},
"signature": [
"UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">"
@ -1827,10 +1910,10 @@
],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 33
"lineNumber": 38
},
"signature": [
"Pick<RawSavedDashboardPanel730ToLatest, \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id?: string | undefined; readonly type: string; }"
"Pick<RawSavedDashboardPanel730ToLatest, \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
],
"initialIsOpen": false
}
@ -1947,7 +2030,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 120
"lineNumber": 123
},
"signature": [
"void"
@ -1970,7 +2053,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 123
"lineNumber": 126
},
"signature": [
"() => ",
@ -1983,6 +2066,20 @@
}
]
},
{
"tags": [],
"id": "def-public.DashboardStart.getDashboardContainerByValueRenderer",
"type": "Function",
"label": "getDashboardContainerByValueRenderer",
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 127
},
"signature": [
"() => React.FC<Props>"
]
},
{
"tags": [],
"id": "def-public.DashboardStart.dashboardUrlGenerator",
@ -1991,7 +2088,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 124
"lineNumber": 130
},
"signature": [
{
@ -2012,7 +2109,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 125
"lineNumber": 131
},
"signature": [
{
@ -2023,25 +2120,11 @@
"text": "DashboardFeatureFlagConfig"
}
]
},
{
"tags": [],
"id": "def-public.DashboardStart.DashboardContainerByValueRenderer",
"type": "Function",
"label": "DashboardContainerByValueRenderer",
"description": [],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 126
},
"signature": [
"React.FC<Props>"
]
}
],
"source": {
"path": "src/plugins/dashboard/public/plugin.tsx",
"lineNumber": 122
"lineNumber": 125
},
"lifecycle": "start",
"initialIsOpen": true
@ -2268,6 +2351,61 @@
}
],
"interfaces": [
{
"id": "def-common.DashboardContainerStateWithType",
"type": "Interface",
"label": "DashboardContainerStateWithType",
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerStateWithType",
"text": "DashboardContainerStateWithType"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DashboardContainerStateWithType.panels",
"type": "Object",
"label": "panels",
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 92
},
"signature": [
"{ [panelId: string]: ",
"DashboardPanelState",
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
" & { [k: string]: unknown; }>; }"
]
}
],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 91
},
"initialIsOpen": false
},
{
"id": "def-common.GridData",
"type": "Interface",
@ -2396,7 +2534,7 @@
"lineNumber": 70
},
"signature": [
"Pick<Pick<RawSavedDashboardPanel620, \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }"
"Pick<Pick<RawSavedDashboardPanel620, \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }"
],
"initialIsOpen": false
},
@ -2408,7 +2546,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 59
"lineNumber": 64
},
"signature": [
"Pick<RawSavedDashboardPanel610, \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }"
@ -2423,7 +2561,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 51
"lineNumber": 56
},
"signature": [
"Pick<RawSavedDashboardPanel620, \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
@ -2438,7 +2576,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 43
"lineNumber": 48
},
"signature": [
"Pick<RawSavedDashboardPanel620, \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
@ -2453,7 +2591,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 35
"lineNumber": 40
},
"signature": [
"Pick<Pick<RawSavedDashboardPanel620, \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
@ -2468,10 +2606,10 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 76
"lineNumber": 81
},
"signature": [
"Pick<RawSavedDashboardPanel730ToLatest, \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id?: string | undefined; readonly type: string; }"
"Pick<RawSavedDashboardPanel730ToLatest, \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
],
"initialIsOpen": false
},
@ -2483,7 +2621,7 @@
"description": [],
"source": {
"path": "src/plugins/dashboard/common/types.ts",
"lineNumber": 67
"lineNumber": 72
},
"signature": [
"Pick<RawSavedDashboardPanelTo60, \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }"

659
api_docs/data.json
View file

File diff suppressed because it is too large Load diff

657
api_docs/data_enhanced.json
View file

@ -13,8 +13,8 @@
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 17
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
"lineNumber": 11
},
"signature": [
"\"ese\""
@ -28,8 +28,8 @@
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 19
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
"lineNumber": 14
},
"signature": [
"\"eql\""
@ -46,7 +46,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/public/plugin.ts",
"lineNumber": 38
"lineNumber": 37
},
"signature": [
"void"
@ -108,12 +108,12 @@
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { search: Readonly<{} & { sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; pageSize: number; trackingInterval: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
"<Readonly<{} & { search: Readonly<{} & { sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; pageSize: number; trackingInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 33
"lineNumber": 26
}
}
],
@ -121,7 +121,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 33
"lineNumber": 26
}
},
{
@ -165,7 +165,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 38
"lineNumber": 31
}
},
{
@ -179,7 +179,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 38
"lineNumber": 31
}
}
],
@ -187,7 +187,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 38
"lineNumber": 31
}
},
{
@ -226,7 +226,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 80
"lineNumber": 54
}
},
{
@ -240,7 +240,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 80
"lineNumber": 54
}
}
],
@ -248,7 +248,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 80
"lineNumber": 54
}
},
{
@ -264,13 +264,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 86
"lineNumber": 60
}
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/server/plugin.ts",
"lineNumber": 27
"lineNumber": 20
},
"initialIsOpen": false
}
@ -286,8 +286,8 @@
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 17
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
"lineNumber": 11
},
"signature": [
"\"ese\""
@ -301,8 +301,8 @@
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 19
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
"lineNumber": 14
},
"signature": [
"\"eql\""
@ -314,619 +314,10 @@
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.pollSearch",
"type": "Function",
"children": [
{
"id": "def-common.pollSearch.$1",
"type": "Function",
"label": "search",
"isRequired": true,
"signature": [
"() => Promise<Response>"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 16
}
},
{
"id": "def-common.pollSearch.$2",
"type": "Function",
"label": "cancel",
"isRequired": false,
"signature": [
"(() => void) | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 17
}
},
{
"id": "def-common.pollSearch.$3",
"type": "Object",
"label": "{ pollInterval = 1000, abortSignal }",
"isRequired": true,
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.IAsyncSearchOptions",
"text": "IAsyncSearchOptions"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 18
}
}
],
"signature": [
"<Response extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<any>>(search: () => Promise<Response>, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ",
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.IAsyncSearchOptions",
"text": "IAsyncSearchOptions"
},
") => ",
"Observable",
"<Response>"
],
"description": [],
"label": "pollSearch",
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/poll_search.ts",
"lineNumber": 15
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.EqlSearchStrategyRequest",
"type": "Interface",
"label": "EqlSearchStrategyRequest",
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.EqlSearchStrategyRequest",
"text": "EqlSearchStrategyRequest"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchRequest",
"text": "IKibanaSearchRequest"
},
"<",
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.EqlRequestParams",
"text": "EqlRequestParams"
},
">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EqlSearchStrategyRequest.options",
"type": "Object",
"label": "options",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 24
},
"signature": [
"TransportRequestOptions",
" | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-common.IAsyncSearchOptions",
"type": "Interface",
"label": "IAsyncSearchOptions",
"signature": [
{
"pluginId": "dataEnhanced",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"section": "def-common.IAsyncSearchOptions",
"text": "IAsyncSearchOptions"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchOptions",
"text": "ISearchOptions"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IAsyncSearchOptions.pollInterval",
"type": "number",
"label": "pollInterval",
"description": [
"\nThe number of milliseconds to wait between receiving a response and sending another request"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 33
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-common.SearchSessionRequestInfo",
"type": "Interface",
"label": "SearchSessionRequestInfo",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.id",
"type": "string",
"label": "id",
"description": [
"\nID of the async search request"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 80
}
},
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.strategy",
"type": "string",
"label": "strategy",
"description": [
"\nSearch strategy used to submit the search request"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 84
}
},
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.status",
"type": "string",
"label": "status",
"description": [
"\nstatus"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 88
}
},
{
"tags": [],
"id": "def-common.SearchSessionRequestInfo.error",
"type": "string",
"label": "error",
"description": [
"\nAn optional error. Set if status is set to error."
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 92
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 76
},
"initialIsOpen": false
},
{
"id": "def-common.SearchSessionSavedObjectAttributes",
"type": "Interface",
"label": "SearchSessionSavedObjectAttributes",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.sessionId",
"type": "string",
"label": "sessionId",
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.name",
"type": "string",
"label": "name",
"description": [
"\nUser-facing session name to be displayed in session management"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.appId",
"type": "string",
"label": "appId",
"description": [
"\nApp that created the session. e.g 'discover'"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.created",
"type": "string",
"label": "created",
"description": [
"\nCreation time of the session"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 25
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.touched",
"type": "string",
"label": "touched",
"description": [
"\nLast touch time of the session"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 29
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.expires",
"type": "string",
"label": "expires",
"description": [
"\nExpiration time of the session. Expiration itself is managed by Elasticsearch."
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.completed",
"type": "CompoundType",
"label": "completed",
"description": [
"\nTime of transition into completed state,\n\nCan be \"null\" in case already completed session\ntransitioned into in-progress session"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 40
},
"signature": [
"string | null | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.status",
"type": "Enum",
"label": "status",
"description": [
"\nstatus"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 44
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionStatus",
"text": "SearchSessionStatus"
}
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId",
"type": "string",
"label": "urlGeneratorId",
"description": [
"\nurlGeneratorId"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 48
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.initialState",
"type": "Object",
"label": "initialState",
"description": [
"\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session."
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 53
},
"signature": [
"Record<string, unknown> | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.restoreState",
"type": "Object",
"label": "restoreState",
"description": [
"\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones."
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 58
},
"signature": [
"Record<string, unknown> | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.idMapping",
"type": "Object",
"label": "idMapping",
"description": [
"\nMapping of search request hashes to their corresponsing info (async search id, etc.)"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 62
},
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionRequestInfo",
"text": "SearchSessionRequestInfo"
},
">"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.persisted",
"type": "boolean",
"label": "persisted",
"description": [
"\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system."
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 67
}
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.realmType",
"type": "string",
"label": "realmType",
"description": [
"\nThe realm type/name & username uniquely identifies the user who created this search session"
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 71
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.realmName",
"type": "string",
"label": "realmName",
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 72
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SearchSessionSavedObjectAttributes.username",
"type": "string",
"label": "username",
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 73
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 12
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-common.SearchSessionStatus",
"type": "Enum",
"label": "SearchSessionStatus",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/status.ts",
"lineNumber": 9
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-common.ENHANCED_ES_SEARCH_STRATEGY",
"type": "string",
"label": "ENHANCED_ES_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 17
},
"signature": [
"\"ese\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.EQL_SEARCH_STRATEGY",
"type": "string",
"label": "EQL_SEARCH_STRATEGY",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 19
},
"signature": [
"\"eql\""
],
"initialIsOpen": false
},
{
"id": "def-common.EqlRequestParams",
"type": "Type",
"label": "EqlRequestParams",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 21
},
"signature": [
"EqlSearch<Record<string, unknown>>"
],
"initialIsOpen": false
},
{
"id": "def-common.EqlSearchStrategyResponse",
"type": "Type",
"label": "EqlSearchStrategyResponse",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/types.ts",
"lineNumber": 27
},
"signature": [
"IKibanaSearchResponse<ApiResponse<T, unknown>>"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SEARCH_SESSION_TYPE",
"type": "string",
"label": "SEARCH_SESSION_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 11
},
"signature": [
"\"search-session\""
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

14
api_docs/data_enhanced.mdx
View file

@ -27,17 +27,3 @@ import dataEnhancedObj from './data_enhanced.json';
### Consts, variables and types
<DocDefinitionList data={dataEnhancedObj.server.misc}/>
## Common
### Functions
<DocDefinitionList data={dataEnhancedObj.common.functions}/>
### Interfaces
<DocDefinitionList data={dataEnhancedObj.common.interfaces}/>
### Enums
<DocDefinitionList data={dataEnhancedObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={dataEnhancedObj.common.misc}/>

4
api_docs/data_query.json
View file

@ -889,7 +889,7 @@
"description": [],
"source": {
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"lineNumber": 21
"lineNumber": 22
}
}
],
@ -915,7 +915,7 @@
"label": "createSavedQueryService",
"source": {
"path": "src/plugins/data/public/query/saved_query/saved_query_service.ts",
"lineNumber": 20
"lineNumber": 21
},
"tags": [],
"returnComment": [],

2118
api_docs/data_search.json
View file

File diff suppressed because it is too large Load diff

2
api_docs/data_ui.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/dev_tools.json
View file

@ -141,7 +141,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/dev_tools/public/plugin.ts",
"lineNumber": 90
"lineNumber": 104
}
}
],

31
api_docs/discover.json
View file

@ -791,12 +791,12 @@
"description": [],
"source": {
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 76
"lineNumber": 77
},
"signature": [
"{ addDocView(docViewRaw: ",
"DocViewInput",
" | ",
"{ addDocView(docViewRaw: ComponentDocViewInput | ",
"RenderDocViewInput",
" | DirectiveDocViewInput | ",
"DocViewInputFn",
"): void; }"
]
@ -804,7 +804,7 @@
],
"source": {
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 75
"lineNumber": 76
},
"lifecycle": "setup",
"initialIsOpen": true
@ -824,7 +824,7 @@
"description": [],
"source": {
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 87
"lineNumber": 88
},
"signature": [
{
@ -846,7 +846,7 @@
],
"source": {
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 105
"lineNumber": 106
},
"signature": [
{
@ -862,7 +862,7 @@
],
"source": {
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 86
"lineNumber": 87
},
"lifecycle": "start",
"initialIsOpen": true
@ -987,6 +987,21 @@
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MAX_DOC_FIELDS_DISPLAYED",
"type": "string",
"label": "MAX_DOC_FIELDS_DISPLAYED",
"description": [],
"source": {
"path": "src/plugins/discover/common/index.ts",
"lineNumber": 21
},
"signature": [
"\"discover:maxDocFieldsDisplayed\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MODIFY_COLUMNS_ON_SWITCH",

10
api_docs/discover_enhanced.json
View file

@ -233,7 +233,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69
"lineNumber": 71
}
},
{
@ -253,7 +253,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69
"lineNumber": 71
}
}
],
@ -261,7 +261,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69
"lineNumber": 71
}
},
{
@ -277,7 +277,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71
"lineNumber": 73
}
}
],
@ -831,7 +831,7 @@
"lineNumber": 9
},
"signature": [
"{ exploreDataInChart: { enabled: boolean; }; }"
"{ exploreDataInChart: { enabled: boolean; }; exploreDataInContextMenu: { enabled: boolean; }; }"
]
}
],

163
api_docs/embeddable.json
View file

@ -3511,7 +3511,7 @@
"type": "Function",
"label": "navigateToEditor",
"signature": [
"(appId: string, options?: { path?: string | undefined; state: ",
"(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; state: ",
{
"pluginId": "embeddable",
"scope": "public",
@ -3560,6 +3560,20 @@
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.openInNewTab",
"type": "CompoundType",
"label": "openInNewTab",
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 118
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.options.state",
@ -3568,7 +3582,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 118
"lineNumber": 119
},
"signature": [
{
@ -3624,7 +3638,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 132
"lineNumber": 133
}
},
{
@ -3642,7 +3656,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 133
"lineNumber": 134
},
"signature": [
"string | undefined"
@ -3656,7 +3670,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 133
"lineNumber": 134
},
"signature": [
{
@ -3671,7 +3685,7 @@
],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 133
"lineNumber": 134
}
}
],
@ -3679,7 +3693,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
"lineNumber": 131
"lineNumber": 132
}
}
],
@ -4924,6 +4938,20 @@
"signature": [
"React.ComponentType<any>"
]
},
{
"tags": [],
"id": "def-public.openAddPanelFlyout.$1.options.showCreateNewMenu",
"type": "CompoundType",
"label": "showCreateNewMenu",
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
"lineNumber": 23
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
@ -5436,7 +5464,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 41
"lineNumber": 42
}
},
{
@ -5449,7 +5477,7 @@
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 47
"lineNumber": 48
},
"signature": [
"() => Promise<boolean>"
@ -5463,7 +5491,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 49
"lineNumber": 50
},
"signature": [
{
@ -5476,6 +5504,29 @@
"<TSavedObjectAttributes> | undefined"
]
},
{
"tags": [],
"id": "def-public.EmbeddableFactory.grouping",
"type": "Array",
"label": "grouping",
"description": [
"\nIndicates the grouping this factory should appear in a sub-menu. Example, this is used for grouping\noptions in the editors menu in Dashboard for creating new embeddables"
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 56
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.PresentableGrouping",
"text": "PresentableGrouping"
},
"<unknown> | undefined"
]
},
{
"tags": [],
"id": "def-public.EmbeddableFactory.isContainerType",
@ -5486,7 +5537,7 @@
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 57
"lineNumber": 64
}
},
{
@ -5504,7 +5555,43 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 63
"lineNumber": 70
}
},
{
"id": "def-public.EmbeddableFactory.getIconType",
"type": "Function",
"label": "getIconType",
"signature": [
"() => string"
],
"description": [
"\nReturns an EUI Icon type to be displayed in a menu."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 75
}
},
{
"id": "def-public.EmbeddableFactory.getDescription",
"type": "Function",
"label": "getDescription",
"signature": [
"() => string"
],
"description": [
"\nReturns a description about the embeddable."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 80
}
},
{
@ -5522,7 +5609,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 69
"lineNumber": 86
}
},
{
@ -5547,7 +5634,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 77
"lineNumber": 94
}
}
],
@ -5555,7 +5642,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 77
"lineNumber": 94
}
},
{
@ -5573,7 +5660,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 84
"lineNumber": 101
}
},
{
@ -5630,7 +5717,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 94
"lineNumber": 111
}
},
{
@ -5646,7 +5733,7 @@
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 95
"lineNumber": 112
}
},
{
@ -5683,7 +5770,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 96
"lineNumber": 113
}
}
],
@ -5691,7 +5778,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 93
"lineNumber": 110
}
},
{
@ -5748,7 +5835,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 106
"lineNumber": 123
}
},
{
@ -5785,7 +5872,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 107
"lineNumber": 124
}
}
],
@ -5793,13 +5880,13 @@
"returnComment": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 105
"lineNumber": 122
}
}
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 30
"lineNumber": 31
},
"initialIsOpen": false
},
@ -5818,7 +5905,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 19
"lineNumber": 20
}
},
{
@ -5829,7 +5916,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 20
"lineNumber": 21
},
"signature": [
"string | undefined"
@ -5838,7 +5925,7 @@
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 18
"lineNumber": 19
},
"initialIsOpen": false
},
@ -7096,7 +7183,7 @@
"description": [],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 24
"lineNumber": 25
},
"signature": [
"any"
@ -7105,7 +7192,7 @@
],
"source": {
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"lineNumber": 23
"lineNumber": 24
},
"initialIsOpen": false
},
@ -7594,7 +7681,7 @@
"lineNumber": 14
},
"signature": [
"Pick<EmbeddableFactory<I, O, E, T>, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<EmbeddableFactory<I, O, E, T>, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>"
"Pick<EmbeddableFactory<I, O, E, T>, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<EmbeddableFactory<I, O, E, T>, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
],
"initialIsOpen": false
},
@ -8443,6 +8530,22 @@
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.EmbeddableStart",
"type": "Type",
"label": "EmbeddableStart",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/embeddable/server/plugin.ts",
"lineNumber": 32
},
"signature": [
"PersistableStateService<EmbeddableStateWithType>"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {

3
api_docs/embeddable.mdx
View file

@ -42,6 +42,9 @@ import embeddableObj from './embeddable.json';
### Setup
<DocDefinitionList data={[embeddableObj.server.setup]}/>
### Start
<DocDefinitionList data={[embeddableObj.server.start]}/>
### Interfaces
<DocDefinitionList data={embeddableObj.server.interfaces}/>

16
api_docs/embeddable_enhanced.json
View file

@ -143,7 +143,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 36
"lineNumber": 35
},
"signature": [
{
@ -163,7 +163,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 37
"lineNumber": 36
},
"signature": [
{
@ -178,7 +178,7 @@
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 35
"lineNumber": 34
},
"initialIsOpen": false
},
@ -197,7 +197,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 41
"lineNumber": 40
},
"signature": [
{
@ -217,7 +217,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 42
"lineNumber": 41
},
"signature": [
{
@ -232,7 +232,7 @@
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 40
"lineNumber": 39
},
"initialIsOpen": false
}
@ -311,7 +311,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 46
"lineNumber": 45
},
"lifecycle": "setup",
"initialIsOpen": true
@ -325,7 +325,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 49
"lineNumber": 48
},
"lifecycle": "start",
"initialIsOpen": true

12
api_docs/es_ui_shared.json
View file

@ -1282,7 +1282,7 @@
"description": [],
"source": {
"path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts",
"lineNumber": 23
"lineNumber": 25
}
}
],
@ -1297,13 +1297,17 @@
},
"<any>"
],
"description": [],
"description": [
"\nFor errors returned by the new elasticsearch js client.\n"
],
"label": "handleEsError",
"source": {
"path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts",
"lineNumber": 23
"lineNumber": 25
},
"tags": [],
"tags": [
"throws"
],
"returnComment": [],
"initialIsOpen": false
},

1465
api_docs/expressions.json
View file

File diff suppressed because it is too large Load diff

22
api_docs/features.json
View file

@ -2014,6 +2014,22 @@
"path": "x-pack/plugins/features/server/plugin.ts",
"lineNumber": 48
}
},
{
"id": "def-server.PluginSetupContract.enableReportingUiCapabilities",
"type": "Function",
"label": "enableReportingUiCapabilities",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/features/server/plugin.ts",
"lineNumber": 56
}
}
],
"source": {
@ -2050,7 +2066,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/features/server/plugin.ts",
"lineNumber": 52
"lineNumber": 60
}
},
{
@ -2074,13 +2090,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/features/server/plugin.ts",
"lineNumber": 53
"lineNumber": 61
}
}
],
"source": {
"path": "x-pack/plugins/features/server/plugin.ts",
"lineNumber": 51
"lineNumber": 59
},
"initialIsOpen": false
}

290
api_docs/file_data_visualizer.json Normal file
View file

@ -0,0 +1,290 @@
{
"id": "fileDataVisualizer",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"start": {
"id": "def-public.FileDataVisualizerPluginStart",
"type": "Type",
"label": "FileDataVisualizerPluginStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/public/plugin.ts",
"lineNumber": 33
},
"signature": [
"{ getFileDataVisualizerComponent: typeof getFileDataVisualizerComponent; getMaxBytesFormatted: typeof getMaxBytesFormatted; }"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.DataVisualizerTableState",
"type": "Interface",
"label": "DataVisualizerTableState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DataVisualizerTableState.pageSize",
"type": "number",
"label": "pageSize",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.DataVisualizerTableState.pageIndex",
"type": "number",
"label": "pageIndex",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 16
}
},
{
"tags": [],
"id": "def-common.DataVisualizerTableState.sortField",
"type": "string",
"label": "sortField",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 17
}
},
{
"tags": [],
"id": "def-common.DataVisualizerTableState.sortDirection",
"type": "string",
"label": "sortDirection",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-common.DataVisualizerTableState.visibleFieldTypes",
"type": "Array",
"label": "visibleFieldTypes",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 19
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.DataVisualizerTableState.visibleFieldNames",
"type": "Array",
"label": "visibleFieldNames",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 20
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.DataVisualizerTableState.showDistributions",
"type": "boolean",
"label": "showDistributions",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 21
}
}
],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 14
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES",
"type": "number",
"label": "ABSOLUTE_MAX_FILE_SIZE_BYTES",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 14
},
"signature": [
"1073741274"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FILE_SIZE_DISPLAY_FORMAT",
"type": "string",
"label": "FILE_SIZE_DISPLAY_FORMAT",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 15
},
"signature": [
"\"0,0.[0] b\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.INDEX_META_DATA_CREATED_BY",
"type": "string",
"label": "INDEX_META_DATA_CREATED_BY",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 19
},
"signature": [
"\"file-data-visualizer\""
],
"initialIsOpen": false
},
{
"id": "def-common.InputData",
"type": "Type",
"label": "InputData",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 10
},
"signature": [
"any[]"
],
"initialIsOpen": false
},
{
"id": "def-common.JobFieldType",
"type": "Type",
"label": "JobFieldType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/types.ts",
"lineNumber": 12
},
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"unknown\" | \"geo_point\" | \"geo_shape\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MAX_FILE_SIZE",
"type": "string",
"label": "MAX_FILE_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"100MB\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MAX_FILE_SIZE_BYTES",
"type": "number",
"label": "MAX_FILE_SIZE_BYTES",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 12
},
"signature": [
"104857600"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MB",
"type": "number",
"label": "MB",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UI_SETTING_MAX_FILE_SIZE",
"type": "string",
"label": "UI_SETTING_MAX_FILE_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 8
},
"signature": [
"\"fileUpload:maxFileSize\""
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-common.JOB_FIELD_TYPES",
"type": "Object",
"label": "JOB_FIELD_TYPES",
"description": [],
"source": {
"path": "x-pack/plugins/file_data_visualizer/common/constants.ts",
"lineNumber": 21
},
"signature": [
"{ readonly BOOLEAN: \"boolean\"; readonly DATE: \"date\"; readonly GEO_POINT: \"geo_point\"; readonly GEO_SHAPE: \"geo_shape\"; readonly IP: \"ip\"; readonly KEYWORD: \"keyword\"; readonly NUMBER: \"number\"; readonly TEXT: \"text\"; readonly UNKNOWN: \"unknown\"; }"
],
"initialIsOpen": false
}
]
}
}

29
api_docs/file_data_visualizer.mdx Normal file
View file

@ -0,0 +1,29 @@
---
id: kibFileDataVisualizerPluginApi
slug: /kibana-dev-docs/fileDataVisualizerPluginApi
title: fileDataVisualizer
image: https://source.unsplash.com/400x175/?github
summary: API docs for the fileDataVisualizer plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileDataVisualizer']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import fileDataVisualizerObj from './file_data_visualizer.json';
## Client
### Start
<DocDefinitionList data={[fileDataVisualizerObj.client.start]}/>
## Common
### Objects
<DocDefinitionList data={fileDataVisualizerObj.common.objects}/>
### Interfaces
<DocDefinitionList data={fileDataVisualizerObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fileDataVisualizerObj.common.misc}/>

1206
api_docs/file_upload.json
View file

File diff suppressed because it is too large Load diff

3
api_docs/file_upload.mdx
View file

@ -19,9 +19,6 @@ import fileUploadObj from './file_upload.json';
### Interfaces
<DocDefinitionList data={fileUploadObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fileUploadObj.client.misc}/>
## Common
### Interfaces

2186
api_docs/fleet.json
View file

File diff suppressed because it is too large Load diff

23
api_docs/infra.json
View file

@ -193,10 +193,25 @@
"description": [],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 64
"lineNumber": 65
},
"signature": [
"{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; container?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }"
"{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; container?: string | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly inventory: Readonly<{} & { compositeSize: number; }>; }"
],
"initialIsOpen": false
},
{
"id": "def-server.InfraRequestHandlerContext",
"type": "Type",
"label": "InfraRequestHandlerContext",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/infra/server/types.ts",
"lineNumber": 24
},
"signature": [
"InfraMlRequestHandlerContext & InfraSpacesRequestHandlerContext"
],
"initialIsOpen": false
}
@ -217,7 +232,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 75
"lineNumber": 76
},
"signature": [
"(sourceId: string, sourceProperties: ",
@ -228,7 +243,7 @@
],
"source": {
"path": "x-pack/plugins/infra/server/plugin.ts",
"lineNumber": 74
"lineNumber": 75
},
"lifecycle": "setup",
"initialIsOpen": true

52
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

229
api_docs/lens.json
View file

@ -66,7 +66,13 @@
" extends ",
"FormattedIndexPatternColumn",
",",
"FieldBasedIndexPatternColumn"
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"description": [],
"tags": [],
@ -160,7 +166,13 @@
"text": "DateHistogramIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"description": [],
"tags": [],
@ -312,7 +324,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 73
"lineNumber": 74
},
"signature": [
"Record<string, Pick<",
@ -323,7 +335,7 @@
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 72
"lineNumber": 73
},
"initialIsOpen": false
},
@ -340,7 +352,13 @@
"text": "LastValueIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"description": [],
"tags": [],
@ -459,7 +477,7 @@
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 90
"lineNumber": 92
},
"signature": [
"React.ComponentType<",
@ -485,12 +503,12 @@
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 99
"lineNumber": 101
},
"signature": [
"(input: ",
"LensEmbeddableInput",
") => void"
", openInNewTab?: boolean | undefined) => void"
]
},
{
@ -503,7 +521,7 @@
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 103
"lineNumber": 105
},
"signature": [
"() => boolean"
@ -519,7 +537,7 @@
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 108
"lineNumber": 110
},
"signature": [
"() => Promise<",
@ -530,7 +548,7 @@
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 81
"lineNumber": 83
},
"initialIsOpen": false
},
@ -647,7 +665,13 @@
"text": "PercentileIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"description": [],
"tags": [],
@ -770,7 +794,13 @@
"text": "RangeIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"description": [],
"tags": [],
@ -953,7 +983,13 @@
"text": "TermsIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"description": [],
"tags": [],
@ -983,7 +1019,7 @@
"lineNumber": 58
},
"signature": [
"{ size: number; orderBy: { type: \"alphabetical\"; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }"
"{ size: number; orderBy: { type: \"alphabetical\"; fallback?: boolean | undefined; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }"
]
}
],
@ -1145,7 +1181,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 423
"lineNumber": 424
},
"signature": [
{
@ -1165,7 +1201,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 424
"lineNumber": 425
},
"signature": [
{
@ -1185,7 +1221,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 425
"lineNumber": 426
},
"signature": [
"\"hide\" | \"inside\" | \"outside\" | undefined"
@ -1199,7 +1235,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 426
"lineNumber": 427
},
"signature": [
"\"None\" | \"Zero\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined"
@ -1213,7 +1249,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 427
"lineNumber": 428
},
"signature": [
{
@ -1234,7 +1270,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 428
"lineNumber": 429
},
"signature": [
"string | undefined"
@ -1248,7 +1284,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 429
"lineNumber": 430
},
"signature": [
"string | undefined"
@ -1262,7 +1298,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 430
"lineNumber": 431
},
"signature": [
"string | undefined"
@ -1276,7 +1312,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 431
"lineNumber": 432
},
"signature": [
{
@ -1297,7 +1333,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 432
"lineNumber": 433
},
"signature": [
{
@ -1318,7 +1354,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 433
"lineNumber": 434
},
"signature": [
{
@ -1339,16 +1375,30 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 434
"lineNumber": 435
},
"signature": [
"\"LINEAR\" | \"CURVE_MONOTONE_X\" | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.hideEndzones",
"type": "CompoundType",
"label": "hideEndzones",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 436
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 422
"lineNumber": 423
},
"initialIsOpen": false
}
@ -1472,6 +1522,59 @@
],
"initialIsOpen": false
},
{
"id": "def-public.FieldBasedIndexPatternColumn",
"type": "Type",
"label": "FieldBasedIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 71
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.RangeIndexPatternColumn",
"text": "RangeIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TermsIndexPatternColumn",
"text": "TermsIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DateHistogramIndexPatternColumn",
"text": "DateHistogramIndexPatternColumn"
},
" | MetricColumn<\"min\"> | MetricColumn<\"max\"> | MetricColumn<\"average\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CardinalityIndexPatternColumn",
"text": "CardinalityIndexPatternColumn"
},
" | MetricColumn<\"sum\"> | MetricColumn<\"median\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PercentileIndexPatternColumn",
"text": "PercentileIndexPatternColumn"
}
],
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternColumn",
"type": "Type",
@ -1613,7 +1716,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 76
"lineNumber": 77
},
"signature": [
"{ columns: Record<string, IndexPatternColumn>; columnOrder: string[]; incompleteColumns?: Record<string, IncompleteColumn> | undefined; }"
@ -1705,7 +1808,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 419
"lineNumber": 420
},
"signature": [
"\"LINEAR\" | \"CURVE_MONOTONE_X\""
@ -2002,9 +2105,14 @@
"lineNumber": 22
},
"signature": [
"Pick<",
"CollectorSet",
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.UsageCollectionSetup",
"text": "UsageCollectionSetup"
},
" | undefined"
]
},
{
@ -2111,7 +2219,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 16
"lineNumber": 19
},
"initialIsOpen": false
},
@ -2120,7 +2228,15 @@
"type": "Function",
"label": "getEditPath",
"signature": [
"(id: string | undefined) => string"
"(id: string | undefined, timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => string"
],
"description": [],
"children": [
@ -2135,7 +2251,28 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 20
"lineNumber": 25
}
},
{
"id": "def-common.getEditPath.$2",
"type": "Object",
"label": "timeRange",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 25
}
}
],
@ -2143,7 +2280,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 20
"lineNumber": 25
},
"initialIsOpen": false
},
@ -2167,7 +2304,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 24
"lineNumber": 37
}
}
],
@ -2175,7 +2312,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 24
"lineNumber": 37
},
"initialIsOpen": false
}
@ -2622,7 +2759,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 9
"lineNumber": 12
},
"signature": [
"\"lens\""
@ -2637,7 +2774,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 13
"lineNumber": 16
},
"signature": [
"\"/api/lens\""
@ -2652,7 +2789,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 11
"lineNumber": 14
},
"signature": [
"\"lens\""
@ -2667,7 +2804,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 14
"lineNumber": 17
},
"signature": [
"\"edit_by_value\""
@ -2682,7 +2819,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 10
"lineNumber": 13
},
"signature": [
"\"lens\""
@ -2697,7 +2834,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 12
"lineNumber": 15
},
"signature": [
"\"Lens Visualizations\""
@ -2712,7 +2849,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 8
"lineNumber": 11
},
"signature": [
"\"lens\""

199
api_docs/license_api_guard.json Normal file
View file

@ -0,0 +1,199 @@
{
"id": "licenseApiGuard",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"id": "def-server.License",
"type": "Class",
"tags": [],
"label": "License",
"description": [],
"children": [
{
"id": "def-server.License.setup",
"type": "Function",
"label": "setup",
"signature": [
"({ pluginName, logger }: SetupSettings) => void"
],
"description": [],
"children": [
{
"id": "def-server.License.setup.$1",
"type": "Object",
"label": "{ pluginName, logger }",
"isRequired": true,
"signature": [
"SetupSettings"
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 41
}
},
{
"id": "def-server.License.start",
"type": "Function",
"label": "start",
"signature": [
"({ pluginId, minimumLicenseType, licensing }: StartSettings) => void"
],
"description": [],
"children": [
{
"id": "def-server.License.start.$1",
"type": "Object",
"label": "{ pluginId, minimumLicenseType, licensing }",
"isRequired": true,
"signature": [
"StartSettings"
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 46
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 46
}
},
{
"id": "def-server.License.guardApiRoute",
"type": "Function",
"label": "guardApiRoute",
"signature": [
"<Context extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", Params, Query, Body>(handler: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.RequestHandler",
"text": "RequestHandler"
},
"<Params, Query, Body, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
"Stream",
" | undefined>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<T>) => ",
"KibanaResponse"
],
"description": [],
"children": [
{
"id": "def-server.License.guardApiRoute.$1",
"type": "Function",
"label": "handler",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.RequestHandler",
"text": "RequestHandler"
},
"<Params, Query, Body, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
"Stream",
" | undefined>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.CustomHttpResponseOptions",
"text": "CustomHttpResponseOptions"
},
"<T>) => ",
"KibanaResponse",
"<T>; badRequest: (options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.ErrorHttpResponseOptions",
"text": "ErrorHttpResponseOptions"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 93
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 92
}
},
{
"id": "def-server.License.isEsSecurityEnabled",
"type": "boolean",
"label": "isEsSecurityEnabled",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 116
}
}
],
"source": {
"path": "x-pack/plugins/license_api_guard/server/license.ts",
"lineNumber": 33
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

18
api_docs/license_api_guard.mdx Normal file
View file

@ -0,0 +1,18 @@
---
id: kibLicenseApiGuardPluginApi
slug: /kibana-dev-docs/licenseApiGuardPluginApi
title: licenseApiGuard
image: https://source.unsplash.com/400x175/?github
summary: API docs for the licenseApiGuard plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import licenseApiGuardObj from './license_api_guard.json';
## Server
### Classes
<DocDefinitionList data={licenseApiGuardObj.server.classes}/>

4
api_docs/licensing.json
View file

@ -580,7 +580,7 @@
"lineNumber": 8
},
"signature": [
"\"valid\" | \"unavailable\" | \"invalid\" | \"expired\""
"\"valid\" | \"invalid\" | \"expired\" | \"unavailable\""
],
"initialIsOpen": false
},
@ -1731,7 +1731,7 @@
"lineNumber": 8
},
"signature": [
"\"valid\" | \"unavailable\" | \"invalid\" | \"expired\""
"\"valid\" | \"invalid\" | \"expired\" | \"unavailable\""
],
"initialIsOpen": false
},

513
api_docs/lists.json
View file

File diff suppressed because it is too large Load diff

384
api_docs/maps.json
View file

File diff suppressed because it is too large Load diff

98
api_docs/maps_ems.json
View file

@ -597,6 +597,21 @@
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.DEFAULT_EMS_DARKMAP_ID",
"type": "string",
"label": "DEFAULT_EMS_DARKMAP_ID",
"description": [],
"source": {
"path": "src/plugins/maps_ems/common/ems_defaults.ts",
"lineNumber": 18
},
"signature": [
"\"dark_map\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.DEFAULT_EMS_FILE_API_URL",
@ -638,7 +653,37 @@
"lineNumber": 12
},
"signature": [
"\"https://maps.elastic.co/v7.12\""
"\"https://maps.elastic.co/v7.13\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.DEFAULT_EMS_ROADMAP_DESATURATED_ID",
"type": "string",
"label": "DEFAULT_EMS_ROADMAP_DESATURATED_ID",
"description": [],
"source": {
"path": "src/plugins/maps_ems/common/ems_defaults.ts",
"lineNumber": 17
},
"signature": [
"\"road_map_desaturated\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.DEFAULT_EMS_ROADMAP_ID",
"type": "string",
"label": "DEFAULT_EMS_ROADMAP_ID",
"description": [],
"source": {
"path": "src/plugins/maps_ems/common/ems_defaults.ts",
"lineNumber": 16
},
"signature": [
"\"road_map\""
],
"initialIsOpen": false
},
@ -665,7 +710,7 @@
"description": [],
"source": {
"path": "src/plugins/maps_ems/config.ts",
"lineNumber": 54
"lineNumber": 57
},
"signature": [
"{ readonly name: string; readonly format: Readonly<{} & { type: string; }>; readonly fields: Readonly<{} & { description: string; name: string; }>[]; readonly meta: Readonly<{} & { feature_collection_path: string; }>; readonly url: string; readonly attribution: string; }"
@ -680,7 +725,7 @@
"description": [],
"source": {
"path": "src/plugins/maps_ems/config.ts",
"lineNumber": 86
"lineNumber": 89
},
"signature": [
"{ readonly includeElasticMapsService: boolean; readonly proxyElasticMapsServiceInMaps: boolean; readonly regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly manifestServiceUrl: string; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }"
@ -1014,6 +1059,21 @@
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.DEFAULT_EMS_DARKMAP_ID",
"type": "string",
"label": "DEFAULT_EMS_DARKMAP_ID",
"description": [],
"source": {
"path": "src/plugins/maps_ems/common/ems_defaults.ts",
"lineNumber": 18
},
"signature": [
"\"dark_map\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_EMS_FILE_API_URL",
@ -1055,7 +1115,37 @@
"lineNumber": 12
},
"signature": [
"\"https://maps.elastic.co/v7.12\""
"\"https://maps.elastic.co/v7.13\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_EMS_ROADMAP_DESATURATED_ID",
"type": "string",
"label": "DEFAULT_EMS_ROADMAP_DESATURATED_ID",
"description": [],
"source": {
"path": "src/plugins/maps_ems/common/ems_defaults.ts",
"lineNumber": 17
},
"signature": [
"\"road_map_desaturated\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_EMS_ROADMAP_ID",
"type": "string",
"label": "DEFAULT_EMS_ROADMAP_ID",
"description": [],
"source": {
"path": "src/plugins/maps_ems/common/ems_defaults.ts",
"lineNumber": 16
},
"signature": [
"\"road_map\""
],
"initialIsOpen": false
},

1302
api_docs/ml.json
View file

File diff suppressed because it is too large Load diff

20
api_docs/monitoring.json
View file

@ -27,7 +27,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 94
"lineNumber": 95
},
"signature": [
"() => any"
@ -41,7 +41,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 95
"lineNumber": 96
},
"signature": [
"() => void"
@ -55,7 +55,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 96
"lineNumber": 97
},
"signature": [
"(esClient: ",
@ -77,7 +77,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 97
"lineNumber": 98
},
"signature": [
"() => void"
@ -86,7 +86,7 @@
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 93
"lineNumber": 94
},
"initialIsOpen": false
}
@ -116,12 +116,12 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/config.ts",
"lineNumber": 92
"lineNumber": 93
},
"signature": [
"{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; metricbeat: Readonly<{} & { index: string; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; licensing: Readonly<{} & { api_polling_frequency: ",
"{ ui: { elasticsearch: MonitoringElasticsearchConfig; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; agent: Readonly<{} & { interval: string; }>; licensing: Readonly<{} & { api_polling_frequency: ",
"Duration",
"; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
"; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
],
"initialIsOpen": false
}
@ -142,7 +142,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 101
"lineNumber": 102
},
"signature": [
"() => any"
@ -151,7 +151,7 @@
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 100
"lineNumber": 101
},
"lifecycle": "setup",
"initialIsOpen": true

830
api_docs/observability.json
View file

File diff suppressed because it is too large Load diff

6
api_docs/observability.mdx
View file

@ -22,6 +22,9 @@ import observabilityObj from './observability.json';
### Functions
<DocDefinitionList data={observabilityObj.client.functions}/>
### Classes
<DocDefinitionList data={observabilityObj.client.classes}/>
### Interfaces
<DocDefinitionList data={observabilityObj.client.interfaces}/>
@ -42,6 +45,9 @@ import observabilityObj from './observability.json';
### Classes
<DocDefinitionList data={observabilityObj.server.classes}/>
### Interfaces
<DocDefinitionList data={observabilityObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={observabilityObj.server.misc}/>

38
api_docs/osquery.json
View file

@ -16,7 +16,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/osquery/public/types.ts",
"lineNumber": 18
"lineNumber": 20
},
"lifecycle": "setup",
"initialIsOpen": true
@ -30,7 +30,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/osquery/public/types.ts",
"lineNumber": 20
"lineNumber": 22
},
"lifecycle": "start",
"initialIsOpen": true
@ -52,7 +52,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/osquery/server/types.ts",
"lineNumber": 16
"lineNumber": 17
},
"lifecycle": "setup",
"initialIsOpen": true
@ -66,7 +66,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/osquery/server/types.ts",
"lineNumber": 18
"lineNumber": 19
},
"lifecycle": "start",
"initialIsOpen": true
@ -78,6 +78,21 @@
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.BASE_PATH",
"type": "string",
"label": "BASE_PATH",
"description": [],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"/app/osquery\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_DARK_MODE",
@ -108,6 +123,21 @@
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.OSQUERY_INTEGRATION_NAME",
"type": "string",
"label": "OSQUERY_INTEGRATION_NAME",
"description": [],
"source": {
"path": "x-pack/plugins/osquery/common/constants.ts",
"lineNumber": 10
},
"signature": [
"\"osquery_manager\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PLUGIN_ID",

825
api_docs/presentation_util.json
View file

File diff suppressed because one or more lines are too long

5
api_docs/presentation_util.mdx
View file

@ -31,6 +31,11 @@ import presentationUtilObj from './presentation_util.json';
### Consts, variables and types
<DocDefinitionList data={presentationUtilObj.client.misc}/>
## Server
### Consts, variables and types
<DocDefinitionList data={presentationUtilObj.server.misc}/>
## Common
### Objects

4
api_docs/remote_clusters.json
View file

@ -56,13 +56,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/remote_clusters/server/plugin.ts",
"lineNumber": 23
"lineNumber": 25
}
}
],
"source": {
"path": "x-pack/plugins/remote_clusters/server/plugin.ts",
"lineNumber": 22
"lineNumber": 24
},
"lifecycle": "setup",
"initialIsOpen": true

265
api_docs/reporting.json
View file

@ -584,7 +584,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 107
"lineNumber": 99
}
}
],
@ -592,7 +592,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 107
"lineNumber": 99
}
},
{
@ -608,7 +608,7 @@
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { home, management, licensing, uiActions, share }: ",
"<object, unknown>, setupDeps: ",
"ReportingPublicPluginSetupDendencies",
") => ",
{
@ -639,13 +639,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 112
"lineNumber": 110
}
},
{
"id": "def-public.ReportingPublicPlugin.setup.$2",
"type": "Object",
"label": "{ home, management, licensing, uiActions, share }",
"label": "setupDeps",
"isRequired": true,
"signature": [
"ReportingPublicPluginSetupDendencies"
@ -653,7 +653,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 113
"lineNumber": 110
}
}
],
@ -661,7 +661,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 111
"lineNumber": 110
}
},
{
@ -705,7 +705,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 175
"lineNumber": 190
}
}
],
@ -713,7 +713,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 175
"lineNumber": 190
}
},
{
@ -729,13 +729,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 194
"lineNumber": 209
}
}
],
"source": {
"path": "x-pack/plugins/reporting/public/plugin.ts",
"lineNumber": 85
"lineNumber": 81
},
"initialIsOpen": false
}
@ -772,7 +772,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/public/index.ts",
"lineNumber": 23
"lineNumber": 24
},
"signature": [
"ReportingSetup"
@ -790,6 +790,27 @@
"label": "ReportingCore",
"description": [],
"children": [
{
"tags": [],
"id": "def-server.ReportingCore.getStartContract",
"type": "Function",
"label": "getStartContract",
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 70
},
"signature": [
"() => ",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingSetup",
"text": "ReportingSetup"
}
]
},
{
"id": "def-server.ReportingCore.Unnamed",
"type": "Function",
@ -810,7 +831,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 69
"lineNumber": 72
}
},
{
@ -826,14 +847,14 @@
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
"ByteSizeValue",
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
],
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 69
"lineNumber": 72
}
}
],
@ -841,7 +862,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 69
"lineNumber": 72
}
},
{
@ -866,7 +887,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 79
"lineNumber": 90
}
}
],
@ -874,7 +895,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 79
"lineNumber": 90
}
},
{
@ -899,7 +920,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 93
"lineNumber": 104
}
}
],
@ -907,7 +928,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 93
"lineNumber": 104
}
},
{
@ -923,7 +944,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 106
"lineNumber": 117
}
},
{
@ -939,7 +960,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 117
"lineNumber": 128
}
},
{
@ -955,7 +976,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 124
"lineNumber": 135
}
},
{
@ -992,7 +1013,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 131
"lineNumber": 142
}
}
],
@ -1000,7 +1021,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 131
"lineNumber": 142
}
},
{
@ -1011,14 +1032,14 @@
"() => void"
],
"description": [
"\nRegisters reporting as an Elasticsearch feature for the purpose of toggling visibility based on roles."
"\nIf xpack.reporting.roles.enabled === true, register Reporting as a feature\nthat is controlled by user role names"
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 139
"lineNumber": 151
}
},
{
@ -1041,7 +1062,23 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 159
"lineNumber": 185
}
},
{
"id": "def-server.ReportingCore.getDeprecatedAllowedRoles",
"type": "Function",
"label": "getDeprecatedAllowedRoles",
"signature": [
"() => false | string[]"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 197
}
},
{
@ -1059,7 +1096,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 169
"lineNumber": 204
}
},
{
@ -1076,7 +1113,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 177
"lineNumber": 212
}
},
{
@ -1114,7 +1151,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 181
"lineNumber": 216
}
}
],
@ -1122,7 +1159,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 181
"lineNumber": 216
}
},
{
@ -1140,7 +1177,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 185
"lineNumber": 220
}
},
{
@ -1158,7 +1195,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 189
"lineNumber": 224
}
},
{
@ -1176,7 +1213,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 199
"lineNumber": 234
}
},
{
@ -1193,30 +1230,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 208
}
},
{
"id": "def-server.ReportingCore.getElasticsearchService",
"type": "Function",
"label": "getElasticsearchService",
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchServiceSetup",
"text": "ElasticsearchServiceSetup"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 216
"lineNumber": 243
}
},
{
@ -1263,7 +1277,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 225
"lineNumber": 255
}
}
],
@ -1271,7 +1285,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 225
"lineNumber": 255
}
},
{
@ -1311,7 +1325,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 231
"lineNumber": 261
}
},
{
@ -1325,7 +1339,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 231
"lineNumber": 261
}
}
],
@ -1333,7 +1347,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 231
"lineNumber": 261
}
},
{
@ -1366,7 +1380,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 245
"lineNumber": 275
}
},
{
@ -1380,7 +1394,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 245
"lineNumber": 275
}
},
{
@ -1394,7 +1408,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 245
"lineNumber": 275
}
}
],
@ -1402,7 +1416,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 245
"lineNumber": 275
}
},
{
@ -1450,7 +1464,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 265
"lineNumber": 295
}
},
{
@ -1464,7 +1478,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 265
"lineNumber": 295
}
}
],
@ -1472,7 +1486,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 265
"lineNumber": 295
}
},
{
@ -1496,7 +1510,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 275
"lineNumber": 305
}
},
{
@ -1520,7 +1534,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 280
"lineNumber": 310
}
},
{
@ -1543,7 +1557,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 285
"lineNumber": 315
}
}
],
@ -1551,7 +1565,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 285
"lineNumber": 315
}
},
{
@ -1574,7 +1588,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 289
"lineNumber": 319
}
}
],
@ -1582,7 +1596,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 289
"lineNumber": 319
}
},
{
@ -1598,7 +1612,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 293
"lineNumber": 323
}
}
],
@ -1630,23 +1644,30 @@
"section": "def-server.Plugin",
"text": "Plugin"
},
"<object, object, ",
"<",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingSetupDeps",
"text": "ReportingSetupDeps"
"section": "def-server.ReportingSetup",
"text": "ReportingSetup"
},
", ",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingStartDeps",
"text": "ReportingStartDeps"
"section": "def-server.ReportingSetup",
"text": "ReportingSetup"
},
">"
", ",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingSetupDeps",
"text": "ReportingSetupDeps"
}
],
"children": [
{
@ -1661,7 +1682,7 @@
{
"id": "def-server.ReportingPlugin.Unnamed.$1",
"type": "Object",
"label": "context",
"label": "initContext",
"isRequired": true,
"signature": [
{
@ -1671,14 +1692,14 @@
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
"<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
"ByteSizeValue",
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
],
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 31
"lineNumber": 30
}
}
],
@ -1686,7 +1707,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 31
"lineNumber": 30
}
},
{
@ -1710,7 +1731,14 @@
"section": "def-server.ReportingSetupDeps",
"text": "ReportingSetupDeps"
},
") => {}"
") => ",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingSetup",
"text": "ReportingSetup"
}
],
"description": [],
"children": [
@ -1732,7 +1760,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 37
"lineNumber": 34
}
},
{
@ -1752,7 +1780,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 37
"lineNumber": 34
}
}
],
@ -1760,7 +1788,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 37
"lineNumber": 34
}
},
{
@ -1784,7 +1812,14 @@
"section": "def-server.ReportingStartDeps",
"text": "ReportingStartDeps"
},
") => {}"
") => ",
{
"pluginId": "reporting",
"scope": "server",
"docId": "kibReportingPluginApi",
"section": "def-server.ReportingSetup",
"text": "ReportingSetup"
}
],
"description": [],
"children": [
@ -1858,7 +1893,7 @@
"section": "def-server.ReportingConfig",
"text": "ReportingConfig"
},
" extends Config<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
" extends Config<Readonly<{ encryptionKey?: string | undefined; } & { enabled: boolean; index: string; capture: Readonly<{} & { browser: Readonly<{} & { type: string; chromium: Readonly<{ inspect?: boolean | undefined; disableSandbox?: boolean | undefined; } & { proxy: Readonly<{ server?: string | undefined; bypass?: string[] | undefined; } & { enabled: boolean; }>; }>; autoDownload: boolean; }>; timeouts: Readonly<{} & { openUrl: number | moment.Duration; waitForElements: number | moment.Duration; renderComplete: number | moment.Duration; }>; networkPolicy: Readonly<{} & { enabled: boolean; rules: Readonly<{ host?: string | undefined; protocol?: string | undefined; } & { allow: boolean; }>[]; }>; zoom: number; viewport: Readonly<{} & { height: number; width: number; }>; loadDelay: number | moment.Duration; maxAttempts: number; }>; roles: Readonly<{} & { enabled: boolean; allow: string[]; }>; kibanaServer: Readonly<{ port?: number | undefined; hostname?: string | undefined; protocol?: string | undefined; } & {}>; queue: Readonly<{} & { timeout: number | moment.Duration; pollInterval: number | moment.Duration; indexInterval: string; pollEnabled: boolean; pollIntervalErrorMultiplier: number; }>; csv: Readonly<{} & { scroll: Readonly<{} & { size: number; duration: string; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; enablePanelActionDownload: boolean; maxSizeBytes: number | ",
"ByteSizeValue",
"; useByteOrderMarkEncoding: boolean; }>; poll: Readonly<{} & { jobCompletionNotifier: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; jobsRefresh: Readonly<{} & { interval: number; intervalErrorMultiplier: number; }>; }>; }>>"
],
@ -2006,9 +2041,14 @@
"lineNumber": 34
},
"signature": [
"Pick<",
"CollectorSet",
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.UsageCollectionSetup",
"text": "UsageCollectionSetup"
},
" | undefined"
]
}
],
@ -2075,7 +2115,36 @@
],
"enums": [],
"misc": [],
"objects": []
"objects": [],
"start": {
"id": "def-server.ReportingSetup",
"type": "Interface",
"label": "ReportingSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.ReportingSetup.usesUiCapabilities",
"type": "Function",
"label": "usesUiCapabilities",
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/types.ts",
"lineNumber": 43
},
"signature": [
"() => boolean"
]
}
],
"source": {
"path": "x-pack/plugins/reporting/server/types.ts",
"lineNumber": 42
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [

3
api_docs/reporting.mdx
View file

@ -24,6 +24,9 @@ import reportingObj from './reporting.json';
## Server
### Start
<DocDefinitionList data={[reportingObj.server.start]}/>
### Classes
<DocDefinitionList data={reportingObj.server.classes}/>

869
api_docs/rule_registry.json
View file

File diff suppressed because one or more lines are too long

24
api_docs/rule_registry.mdx
View file

@ -11,14 +11,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import ruleRegistryObj from './rule_registry.json';
## Client
### Classes
<DocDefinitionList data={ruleRegistryObj.client.classes}/>
### Interfaces
<DocDefinitionList data={ruleRegistryObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={ruleRegistryObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[ruleRegistryObj.server.setup]}/>
### Objects
<DocDefinitionList data={ruleRegistryObj.server.objects}/>
### Functions
<DocDefinitionList data={ruleRegistryObj.server.functions}/>
@ -30,9 +38,15 @@ import ruleRegistryObj from './rule_registry.json';
## Common
### Objects
<DocDefinitionList data={ruleRegistryObj.common.objects}/>
### Functions
<DocDefinitionList data={ruleRegistryObj.common.functions}/>
### Enums
<DocDefinitionList data={ruleRegistryObj.common.enums}/>
### Interfaces
<DocDefinitionList data={ruleRegistryObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={ruleRegistryObj.common.misc}/>

78
api_docs/saved_objects_management.json
View file

File diff suppressed because one or more lines are too long

166
api_docs/security.json
View file

@ -449,7 +449,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security/public/plugin.tsx",
"lineNumber": 168
"lineNumber": 171
},
"signature": [
"{ authc: AuthenticationServiceSetup; sessionTimeout: ISessionTimeout; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
@ -471,12 +471,12 @@
"description": [],
"source": {
"path": "x-pack/plugins/security/public/plugin.tsx",
"lineNumber": 169
"lineNumber": 172
},
"signature": [
"{ navControlService: ",
"SecurityNavControlServiceStart",
"; }"
"; authc: AuthenticationServiceSetup; }"
],
"lifecycle": "start",
"initialIsOpen": true
@ -490,8 +490,19 @@
"id": "def-server.AuditEvent",
"type": "Interface",
"label": "AuditEvent",
"signature": [
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.AuditEvent",
"text": "AuditEvent"
},
" extends ",
"LogMeta"
],
"description": [
"\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.6/index.html\n\nIf you add additional fields to the schema ensure you update the Kibana Filebeat module:\nhttps://github.com/elastic/beats/tree/master/filebeat/module/kibana\n"
"\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.9/index.html\n\nIf you add additional fields to the schema ensure you update the Kibana Filebeat module:\nhttps://github.com/elastic/beats/tree/master/filebeat/module/kibana\n"
],
"tags": [
"public"
@ -502,66 +513,12 @@
"id": "def-server.AuditEvent.message",
"type": "string",
"label": "message",
"description": [
"\nHuman readable message describing action, outcome and user.\n"
],
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 27
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-server.AuditEvent.event",
"type": "Object",
"label": "event",
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 28
},
"signature": [
"{ action: string; category?: ",
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.EventCategory",
"text": "EventCategory"
},
" | undefined; type?: ",
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.EventType",
"text": "EventType"
},
" | undefined; outcome?: ",
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.EventOutcome",
"text": "EventOutcome"
},
" | undefined; }"
]
},
{
"tags": [],
"id": "def-server.AuditEvent.user",
"type": "Object",
"label": "user",
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 34
},
"signature": [
"{ name: string; roles?: readonly string[] | undefined; } | undefined"
]
},
{
"tags": [],
"id": "def-server.AuditEvent.kibana",
@ -570,53 +527,11 @@
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 38
"lineNumber": 22
},
"signature": [
"{ space_id?: string | undefined; session_id?: string | undefined; saved_object?: { type: string; id: string; } | undefined; authentication_provider?: string | undefined; authentication_type?: string | undefined; authentication_realm?: string | undefined; lookup_realm?: string | undefined; add_to_spaces?: readonly string[] | undefined; delete_from_spaces?: readonly string[] | undefined; } | undefined"
]
},
{
"tags": [],
"id": "def-server.AuditEvent.error",
"type": "Object",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 80
},
"signature": [
"{ code?: string | undefined; message?: string | undefined; } | undefined"
]
},
{
"tags": [],
"id": "def-server.AuditEvent.http",
"type": "Object",
"label": "http",
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 84
},
"signature": [
"{ request?: { method?: string | undefined; } | undefined; } | undefined"
]
},
{
"tags": [],
"id": "def-server.AuditEvent.url",
"type": "Object",
"label": "url",
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 89
},
"signature": [
"{ domain?: string | undefined; path?: string | undefined; port?: number | undefined; query?: string | undefined; scheme?: string | undefined; } | undefined"
]
}
],
"source": {
@ -1183,45 +1098,26 @@
"initialIsOpen": false
}
],
"enums": [
"enums": [],
"misc": [
{
"id": "def-server.EventCategory",
"type": "Enum",
"label": "EventCategory",
"tags": [],
"description": [],
"id": "def-server.ROUTE_TAG_CAN_REDIRECT",
"type": "string",
"label": "ROUTE_TAG_CAN_REDIRECT",
"description": [
"\nIf the route is marked with this tag Security can safely assume that the calling party that sends\nrequest to this route can handle redirect responses. It's particularly important if we want the\nspecific route to be able to initiate or participate in the authentication handshake that may\ninvolve redirects and will eventually redirect authenticated user to this route."
],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 98
},
"initialIsOpen": false
},
{
"id": "def-server.EventOutcome",
"type": "Enum",
"label": "EventOutcome",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 111
},
"initialIsOpen": false
},
{
"id": "def-server.EventType",
"type": "Enum",
"label": "EventType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/security/server/audit/audit_events.ts",
"lineNumber": 104
"path": "x-pack/plugins/security/server/routes/tags.ts",
"lineNumber": 21
},
"signature": [
"\"security:canRedirect\""
],
"initialIsOpen": false
}
],
"misc": [],
"objects": []
},
"common": {

4
api_docs/security.mdx
View file

@ -27,6 +27,6 @@ import securityObj from './security.json';
### Interfaces
<DocDefinitionList data={securityObj.server.interfaces}/>
### Enums
<DocDefinitionList data={securityObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={securityObj.server.misc}/>

160
api_docs/security_solution.json
View file

@ -33,13 +33,7 @@
"text": "PluginSetup"
},
", ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
"PluginStart",
", ",
"SetupPlugins"
],
@ -71,7 +65,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 79
"lineNumber": 78
}
}
],
@ -79,7 +73,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 79
"lineNumber": 78
}
},
{
@ -98,13 +92,7 @@
"<",
"StartPlugins",
", ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
"PluginStart",
">, plugins: ",
"SetupPlugins",
") => ",
@ -134,19 +122,13 @@
"<",
"StartPlugins",
", ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
"PluginStart",
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 103
"lineNumber": 102
}
},
{
@ -160,7 +142,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 103
"lineNumber": 102
}
}
],
@ -168,7 +150,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 103
"lineNumber": 102
}
},
{
@ -207,7 +189,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 346
"lineNumber": 343
}
},
{
@ -221,7 +203,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 346
"lineNumber": 343
}
}
],
@ -229,7 +211,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 346
"lineNumber": 343
}
},
{
@ -245,13 +227,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 391
"lineNumber": 388
}
}
],
"source": {
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"lineNumber": 75
"lineNumber": 74
},
"initialIsOpen": false
}
@ -276,7 +258,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/public/types.ts",
"lineNumber": 68
"lineNumber": 70
},
"signature": [
"() => Promise<",
@ -287,24 +269,10 @@
],
"source": {
"path": "x-pack/plugins/security_solution/public/types.ts",
"lineNumber": 67
"lineNumber": 69
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.PluginStart",
"type": "Interface",
"label": "PluginStart",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/security_solution/public/types.ts",
"lineNumber": 71
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
@ -453,7 +421,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 145
"lineNumber": 146
}
}
],
@ -461,7 +429,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 145
"lineNumber": 146
}
},
{
@ -521,7 +489,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 157
"lineNumber": 158
}
},
{
@ -535,7 +503,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 157
"lineNumber": 158
}
}
],
@ -543,7 +511,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 157
"lineNumber": 158
}
},
{
@ -582,7 +550,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 338
"lineNumber": 341
}
},
{
@ -596,7 +564,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 338
"lineNumber": 341
}
}
],
@ -604,7 +572,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 338
"lineNumber": 341
}
},
{
@ -620,13 +588,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 412
"lineNumber": 415
}
}
],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 129
"lineNumber": 130
},
"initialIsOpen": false
}
@ -1484,7 +1452,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 105
"lineNumber": 106
},
"lifecycle": "setup",
"initialIsOpen": true
@ -1498,7 +1466,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 108
"lineNumber": 109
},
"lifecycle": "start",
"initialIsOpen": true
@ -1554,7 +1522,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_array.ts",
"lineNumber": 16
"lineNumber": 17
}
}
],
@ -1575,9 +1543,11 @@
"label": "DefaultArray",
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_array.ts",
"lineNumber": 16
"lineNumber": 17
},
"tags": [],
"tags": [
"deprecated"
],
"returnComment": [],
"initialIsOpen": false
},
@ -1596,7 +1566,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/exact_check.ts",
"lineNumber": 30
"lineNumber": 31
}
},
{
@ -1613,7 +1583,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/exact_check.ts",
"lineNumber": 31
"lineNumber": 32
}
}
],
@ -1634,21 +1604,25 @@
"label": "exactCheck",
"source": {
"path": "x-pack/plugins/security_solution/common/exact_check.ts",
"lineNumber": 29
"lineNumber": 30
},
"tags": [],
"tags": [
"deprecated"
],
"returnComment": [],
"initialIsOpen": false
},
{
"tags": [],
"tags": [
"deprecated"
],
"id": "def-common.foldLeftRight",
"type": "Function",
"label": "foldLeftRight",
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/test_utils.ts",
"lineNumber": 29
"lineNumber": 38
},
"signature": [
"<T>(ma: ",
@ -1674,7 +1648,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/format_errors.ts",
"lineNumber": 11
"lineNumber": 14
}
}
],
@ -1687,9 +1661,11 @@
"label": "formatErrors",
"source": {
"path": "x-pack/plugins/security_solution/common/format_errors.ts",
"lineNumber": 11
"lineNumber": 14
},
"tags": [],
"tags": [
"deprecated"
],
"returnComment": [],
"initialIsOpen": false
},
@ -1711,7 +1687,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/test_utils.ts",
"lineNumber": 36
"lineNumber": 46
}
}
],
@ -1728,9 +1704,11 @@
"label": "getPaths",
"source": {
"path": "x-pack/plugins/security_solution/common/test_utils.ts",
"lineNumber": 36
"lineNumber": 46
},
"tags": [],
"tags": [
"deprecated"
],
"returnComment": [],
"initialIsOpen": false
},
@ -1749,7 +1727,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/test_utils.ts",
"lineNumber": 49
"lineNumber": 60
}
}
],
@ -1762,9 +1740,11 @@
"label": "removeExternalLinkText",
"source": {
"path": "x-pack/plugins/security_solution/common/test_utils.ts",
"lineNumber": 49
"lineNumber": 60
},
"tags": [],
"tags": [
"deprecated"
],
"returnComment": [],
"initialIsOpen": false
},
@ -1914,7 +1894,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_version_number.ts",
"lineNumber": 24
"lineNumber": 25
},
"signature": [
"number"
@ -1924,7 +1904,9 @@
],
"objects": [
{
"tags": [],
"tags": [
"deprecated"
],
"id": "def-common.DefaultStringArray",
"type": "Object",
"label": "DefaultStringArray",
@ -1933,7 +1915,7 @@
],
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_string_array.ts",
"lineNumber": 16
"lineNumber": 17
},
"signature": [
"Type",
@ -1942,7 +1924,9 @@
"initialIsOpen": false
},
{
"tags": [],
"tags": [
"deprecated"
],
"id": "def-common.DefaultUuid",
"type": "Object",
"label": "DefaultUuid",
@ -1951,7 +1935,7 @@
],
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_uuid.ts",
"lineNumber": 19
"lineNumber": 20
},
"signature": [
"Type",
@ -1960,7 +1944,9 @@
"initialIsOpen": false
},
{
"tags": [],
"tags": [
"deprecated"
],
"id": "def-common.DefaultVersionNumber",
"type": "Object",
"label": "DefaultVersionNumber",
@ -1969,7 +1955,7 @@
],
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/default_version_number.ts",
"lineNumber": 16
"lineNumber": 17
},
"signature": [
"Type",
@ -1978,7 +1964,9 @@
"initialIsOpen": false
},
{
"tags": [],
"tags": [
"deprecated"
],
"id": "def-common.NonEmptyString",
"type": "Object",
"label": "NonEmptyString",
@ -1987,7 +1975,7 @@
],
"source": {
"path": "x-pack/plugins/security_solution/common/detection_engine/schemas/types/non_empty_string.ts",
"lineNumber": 15
"lineNumber": 16
},
"signature": [
"Type",

3
api_docs/security_solution.mdx
View file

@ -16,9 +16,6 @@ import securitySolutionObj from './security_solution.json';
### Setup
<DocDefinitionList data={[securitySolutionObj.client.setup]}/>
### Start
<DocDefinitionList data={[securitySolutionObj.client.start]}/>
### Classes
<DocDefinitionList data={securitySolutionObj.client.classes}/>

2
api_docs/share.json
View file

@ -490,7 +490,7 @@
},
" extends Pick<",
"EuiContextMenuPanelItemDescriptorEntry",
", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"disabled\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">"
", \"onClick\" | \"key\" | \"size\" | \"className\" | \"aria-label\" | \"disabled\" | \"data-test-subj\" | \"target\" | \"href\" | \"icon\" | \"rel\" | \"buttonRef\" | \"toolTipContent\" | \"toolTipTitle\" | \"toolTipPosition\" | \"layoutAlign\" | \"panel\">"
],
"description": [],
"tags": [

50
api_docs/task_manager.json
View file

@ -78,7 +78,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 55
"lineNumber": 58
}
}
],
@ -86,7 +86,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 55
"lineNumber": 58
}
},
{
@ -131,7 +131,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 62
"lineNumber": 65
}
}
],
@ -139,7 +139,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 62
"lineNumber": 65
}
},
{
@ -183,7 +183,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 109
"lineNumber": 113
}
}
],
@ -191,18 +191,50 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 109
"lineNumber": 113
}
}
],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 44
"lineNumber": 47
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-server.asInterval",
"type": "Function",
"label": "asInterval",
"signature": [
"(ms: number) => string"
],
"description": [],
"children": [
{
"id": "def-server.asInterval.$1",
"type": "number",
"label": "ms",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "x-pack/plugins/task_manager/server/lib/intervals.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/task_manager/server/lib/intervals.ts",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-server.isUnrecoverableError",
"type": "Function",
@ -760,7 +792,7 @@
"lineNumber": 31
},
"signature": [
"{ addMiddleware: (middleware: Middleware) => void; } & Pick<TaskTypeDictionary, \"registerTaskDefinitions\">"
"{ index: string; addMiddleware: (middleware: Middleware) => void; } & Pick<TaskTypeDictionary, \"registerTaskDefinitions\">"
],
"lifecycle": "setup",
"initialIsOpen": true
@ -773,7 +805,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/task_manager/server/plugin.ts",
"lineNumber": 36
"lineNumber": 39
},
"signature": [
"Pick<TaskScheduling, \"schedule\" | \"runNow\" | \"ensureScheduled\"> & Pick<TaskStore, \"remove\" | \"get\" | \"fetch\"> & { removeIfExists: TaskStore['remove']; }"

42
api_docs/telemetry_collection_manager.json
View file

@ -55,9 +55,13 @@
"lineNumber": 57
},
"signature": [
"Pick<",
"CollectorSet",
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\">"
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.UsageCollectionSetup",
"text": "UsageCollectionSetup"
}
]
},
{
@ -364,15 +368,9 @@
"lineNumber": 23
},
"signature": [
"(config: ",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.StatsGetterConfig",
"text": "StatsGetterConfig"
},
") => Promise<string[] | ",
"{ (config: ",
"UnencryptedStatsGetterConfig",
"): Promise<",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
@ -380,7 +378,9 @@
"section": "def-server.UsageStatsPayload",
"text": "UsageStatsPayload"
},
"[]>"
"[]>; (config: ",
"EncryptedStatsGetterConfig",
"): Promise<string[]>; }"
]
},
{
@ -445,15 +445,9 @@
"lineNumber": 29
},
"signature": [
"(config: ",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
"docId": "kibTelemetryCollectionManagerPluginApi",
"section": "def-server.StatsGetterConfig",
"text": "StatsGetterConfig"
},
") => Promise<string[] | ",
"{ (config: ",
"UnencryptedStatsGetterConfig",
"): Promise<",
{
"pluginId": "telemetryCollectionManager",
"scope": "server",
@ -461,7 +455,9 @@
"section": "def-server.UsageStatsPayload",
"text": "UsageStatsPayload"
},
"[]>"
"[]>; (config: ",
"EncryptedStatsGetterConfig",
"): Promise<string[]>; }"
]
},
{

4
api_docs/telemetry_management_section.json
View file

@ -194,7 +194,7 @@
"description": [],
"source": {
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
"lineNumber": 35
"lineNumber": 38
},
"signature": [
"(enabled: boolean) => void"
@ -203,7 +203,7 @@
],
"source": {
"path": "src/plugins/telemetry_management_section/public/plugin.tsx",
"lineNumber": 34
"lineNumber": 37
},
"lifecycle": "setup",
"initialIsOpen": true

12
api_docs/timelines.json
View file

@ -22,7 +22,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/timelines/public/types.ts",
"lineNumber": 4
"lineNumber": 11
},
"signature": [
"((props: ",
@ -35,7 +35,7 @@
],
"source": {
"path": "x-pack/plugins/timelines/public/types.ts",
"lineNumber": 3
"lineNumber": 10
},
"lifecycle": "setup",
"initialIsOpen": true
@ -57,7 +57,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/timelines/server/types.ts",
"lineNumber": 2
"lineNumber": 9
},
"lifecycle": "setup",
"initialIsOpen": true
@ -71,7 +71,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/timelines/server/types.ts",
"lineNumber": 4
"lineNumber": 11
},
"lifecycle": "start",
"initialIsOpen": true
@ -91,7 +91,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/timelines/common/index.ts",
"lineNumber": 1
"lineNumber": 8
},
"signature": [
"\"timelines\""
@ -106,7 +106,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/timelines/common/index.ts",
"lineNumber": 2
"lineNumber": 9
},
"signature": [
"\"timelines\""

52
api_docs/triggers_actions_ui.json
View file

@ -1085,7 +1085,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 234
"lineNumber": 235
}
},
{
@ -1096,7 +1096,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 235
"lineNumber": 236
}
},
{
@ -1107,7 +1107,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 236
"lineNumber": 237
}
},
{
@ -1118,7 +1118,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 237
"lineNumber": 238
},
"signature": [
"string | ((docLinks: ",
@ -1140,7 +1140,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 238
"lineNumber": 239
},
"signature": [
"(alertParams: Params) => ",
@ -1161,7 +1161,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 239
"lineNumber": 240
},
"signature": [
"React.FunctionComponent<any> | React.LazyExoticComponent<React.ComponentType<",
@ -1183,7 +1183,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 242
"lineNumber": 243
}
},
{
@ -1194,7 +1194,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 243
"lineNumber": 244
},
"signature": [
"string | undefined"
@ -1203,7 +1203,7 @@
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 233
"lineNumber": 234
},
"initialIsOpen": false
},
@ -1232,7 +1232,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 216
"lineNumber": 217
},
"signature": [
"Params"
@ -1246,7 +1246,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 217
"lineNumber": 218
}
},
{
@ -1257,7 +1257,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 218
"lineNumber": 219
}
},
{
@ -1268,7 +1268,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 219
"lineNumber": 220
},
"signature": [
"\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""
@ -1282,7 +1282,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 220
"lineNumber": 221
},
"signature": [
"<Key extends keyof Params>(property: Key, value: Params[Key] | undefined) => void"
@ -1296,7 +1296,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 221
"lineNumber": 222
},
"signature": [
"<Prop extends \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"tags\" | \"muteAll\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">(key: Prop, value: Pick<",
@ -1318,7 +1318,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 225
"lineNumber": 226
},
"signature": [
{
@ -1338,7 +1338,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 226
"lineNumber": 227
}
},
{
@ -1349,7 +1349,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 227
"lineNumber": 228
},
"signature": [
{
@ -1370,7 +1370,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 228
"lineNumber": 229
},
"signature": [
"MetaData | undefined"
@ -1384,7 +1384,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 229
"lineNumber": 230
},
"signature": [
{
@ -1404,7 +1404,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 230
"lineNumber": 231
},
"signature": [
{
@ -1419,7 +1419,7 @@
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 211
"lineNumber": 212
},
"initialIsOpen": false
},
@ -1546,7 +1546,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 247
"lineNumber": 248
},
"signature": [
"any"
@ -1555,7 +1555,7 @@
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 246
"lineNumber": 247
},
"initialIsOpen": false
},
@ -1934,7 +1934,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 160
"lineNumber": 161
},
"signature": [
"PreConfiguredActionConnector",
@ -1997,7 +1997,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 178
"lineNumber": 179
},
"signature": [
"AsActionVariables<\"params\" | \"state\"> & Partial<AsActionVariables<\"context\">>"

2
api_docs/ui_actions.json
View file

@ -1616,7 +1616,7 @@
"type": "Function",
"label": "getDisplayNameTooltip",
"signature": [
"(context: Context) => string"
"((context: Context) => string) | undefined"
],
"description": [
"\nReturns tooltip text which should be displayed when user hovers this object.\nShould return empty string if tooltip should not be displayed."

154
api_docs/ui_actions_enhanced.json
View file

@ -266,7 +266,7 @@
"section": "def-public.Presentable",
"text": "Presentable"
},
"<FactoryContext>, \"id\" | \"getDisplayName\" | \"order\" | \"MenuItem\" | \"getIconType\" | \"getDisplayNameTooltip\" | \"isCompatible\" | \"grouping\">,",
"<FactoryContext>, \"id\" | \"getDisplayName\" | \"grouping\" | \"getIconType\" | \"order\" | \"MenuItem\" | \"getDisplayNameTooltip\" | \"isCompatible\">,",
{
"pluginId": "kibanaUtils",
"scope": "public",
@ -1629,7 +1629,7 @@
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 246
"lineNumber": 251
}
},
{
@ -1660,7 +1660,7 @@
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 246
"lineNumber": 251
}
},
{
@ -1676,7 +1676,7 @@
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 246
"lineNumber": 251
}
}
],
@ -1684,7 +1684,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 246
"lineNumber": 251
}
},
{
@ -1711,7 +1711,7 @@
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 277
"lineNumber": 282
}
}
],
@ -1719,7 +1719,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 277
"lineNumber": 282
}
},
{
@ -1746,7 +1746,7 @@
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 297
"lineNumber": 302
}
}
],
@ -1754,7 +1754,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"lineNumber": 297
"lineNumber": 302
}
}
],
@ -2031,7 +2031,7 @@
"section": "def-public.BaseActionFactoryContext",
"text": "BaseActionFactoryContext"
},
">>) => JSX.Element"
">>) => JSX.Element | null"
],
"description": [],
"label": "ActionWizard",
@ -2293,7 +2293,7 @@
"section": "def-public.Presentable",
"text": "Presentable"
},
"<FactoryContext>, \"id\" | \"getDisplayName\" | \"order\" | \"MenuItem\" | \"getIconType\" | \"getDisplayNameTooltip\" | \"isCompatible\" | \"grouping\">>,",
"<FactoryContext>, \"id\" | \"getDisplayName\" | \"grouping\" | \"getIconType\" | \"order\" | \"MenuItem\" | \"getDisplayNameTooltip\" | \"isCompatible\">>,",
{
"pluginId": "kibanaUtils",
"scope": "public",
@ -2919,6 +2919,122 @@
},
"initialIsOpen": false
},
{
"id": "def-public.DrilldownTemplate",
"type": "Interface",
"label": "DrilldownTemplate",
"description": [
"\nTemplate for a pre-configured new drilldown, this gives ability to create a\ndrilldown from a template instead of user creating a drilldown from scratch.\nThis is used in \"drilldown cloning\" functionality, where drilldowns can be\ncloned from one dashboard panel to another."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DrilldownTemplate.id",
"type": "string",
"label": "id",
"description": [
"\nAny string that uniquely identifies this item in a list of `DrilldownTemplate[]`."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 93
}
},
{
"tags": [],
"id": "def-public.DrilldownTemplate.icon",
"type": "string",
"label": "icon",
"description": [
"\nEUI icon display next to the description."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 98
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.DrilldownTemplate.description",
"type": "string",
"label": "description",
"description": [
"\nA user facing text that provides information about the source of this template."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 103
}
},
{
"tags": [],
"id": "def-public.DrilldownTemplate.factoryId",
"type": "string",
"label": "factoryId",
"description": [
"\nDrilldown type, dynamic action factory ID."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 108
}
},
{
"tags": [],
"id": "def-public.DrilldownTemplate.name",
"type": "string",
"label": "name",
"description": [
"\nSuggested new name of the cloned drilldown. If a drilldown with such suggested\nname already exists at current place, a suffix like \" (copy 1)\" will be added."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 114
}
},
{
"tags": [],
"id": "def-public.DrilldownTemplate.triggers",
"type": "Array",
"label": "triggers",
"description": [
"\nPre-selected triggers."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 119
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.DrilldownTemplate.config",
"type": "Unknown",
"label": "config",
"description": [
"\nPreliminary configuration of the new drilldown, to be used in the dynamicaction factory."
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 124
},
"signature": [
"unknown"
]
}
],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"lineNumber": 89
},
"initialIsOpen": false
},
{
"id": "def-public.DynamicActionManagerParams",
"type": "Interface",
@ -3252,24 +3368,18 @@
"children": [
{
"tags": [],
"id": "def-public.StartContract.FlyoutManageDrilldowns",
"id": "def-public.StartContract.DrilldownManager",
"type": "Function",
"label": "FlyoutManageDrilldowns",
"label": "DrilldownManager",
"description": [],
"source": {
"path": "x-pack/plugins/ui_actions_enhanced/public/plugin.ts",
"lineNumber": 60
},
"signature": [
"React.FC<ConnectedFlyoutManageDrilldownsProps<",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.BaseActionFactoryContext",
"text": "BaseActionFactoryContext"
},
">>"
"React.FC<",
"PublicDrilldownManagerProps",
">"
]
}
],

8
api_docs/vis_type_timeseries.json
View file

@ -26,7 +26,7 @@
"description": [],
"source": {
"path": "src/plugins/vis_type_timeseries/common/types.ts",
"lineNumber": 74
"lineNumber": 76
}
}
],
@ -40,7 +40,7 @@
"label": "isVisSeriesData",
"source": {
"path": "src/plugins/vis_type_timeseries/common/types.ts",
"lineNumber": 74
"lineNumber": 76
},
"tags": [],
"returnComment": [],
@ -61,7 +61,7 @@
"description": [],
"source": {
"path": "src/plugins/vis_type_timeseries/common/types.ts",
"lineNumber": 71
"lineNumber": 73
}
}
],
@ -74,7 +74,7 @@
"label": "isVisTableData",
"source": {
"path": "src/plugins/vis_type_timeseries/common/types.ts",
"lineNumber": 71
"lineNumber": 73
},
"tags": [],
"returnComment": [],

593
api_docs/visualizations.json
View file

@ -2,6 +2,439 @@
"id": "visualizations",
"client": {
"classes": [
{
"id": "def-public.BaseVisType",
"type": "Class",
"tags": [],
"label": "BaseVisType",
"description": [],
"signature": [
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.BaseVisType",
"text": "BaseVisType"
},
"<TVisParams>"
],
"children": [
{
"tags": [],
"id": "def-public.BaseVisType.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 25
}
},
{
"tags": [],
"id": "def-public.BaseVisType.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 26
}
},
{
"tags": [],
"id": "def-public.BaseVisType.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 27
}
},
{
"tags": [],
"id": "def-public.BaseVisType.note",
"type": "string",
"label": "note",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 28
}
},
{
"tags": [],
"id": "def-public.BaseVisType.getSupportedTriggers",
"type": "Function",
"label": "getSupportedTriggers",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 29
},
"signature": [
"(() => string[]) | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.icon",
"type": "CompoundType",
"label": "icon",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 30
},
"signature": [
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.image",
"type": "string",
"label": "image",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 31
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.stage",
"type": "CompoundType",
"label": "stage",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 32
},
"signature": [
"\"experimental\" | \"beta\" | \"production\""
]
},
{
"tags": [],
"id": "def-public.BaseVisType.group",
"type": "Enum",
"label": "group",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 33
},
"signature": [
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.VisGroups",
"text": "VisGroups"
}
]
},
{
"tags": [],
"id": "def-public.BaseVisType.titleInWizard",
"type": "string",
"label": "titleInWizard",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 34
}
},
{
"tags": [],
"id": "def-public.BaseVisType.options",
"type": "Object",
"label": "options",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 35
},
"signature": [
"VisTypeOptions"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.visConfig",
"type": "Any",
"label": "visConfig",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 36
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.editorConfig",
"type": "Any",
"label": "editorConfig",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 37
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.hidden",
"type": "boolean",
"label": "hidden",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-public.BaseVisType.requiresSearch",
"type": "boolean",
"label": "requiresSearch",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 39
}
},
{
"tags": [],
"id": "def-public.BaseVisType.hierarchicalData",
"type": "CompoundType",
"label": "hierarchicalData",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 40
},
"signature": [
"boolean | ((vis: { params: TVisParams; }) => boolean)"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.setup",
"type": "Function",
"label": "setup",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 41
},
"signature": [
"((vis: ",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.Vis",
"text": "Vis"
},
"<TVisParams>) => Promise<",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.Vis",
"text": "Vis"
},
"<TVisParams>>) | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.getUsedIndexPattern",
"type": "Function",
"label": "getUsedIndexPattern",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 42
},
"signature": [
"((visParams: ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.VisParams",
"text": "VisParams"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[] | Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[]>) | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.inspectorAdapters",
"type": "CompoundType",
"label": "inspectorAdapters",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 43
},
"signature": [
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
" | (() => ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
") | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.toExpressionAst",
"type": "Function",
"label": "toExpressionAst",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 44
},
"signature": [
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.VisToExpressionAst",
"text": "VisToExpressionAst"
},
"<TVisParams>"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.getInfoMessage",
"type": "Function",
"label": "getInfoMessage",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 45
},
"signature": [
"((vis: ",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.Vis",
"text": "Vis"
},
"<",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.VisParams",
"text": "VisParams"
},
">) => React.ReactNode) | undefined"
]
},
{
"tags": [],
"id": "def-public.BaseVisType.schemas",
"type": "Object",
"label": "schemas",
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 46
},
"signature": [
"Schemas"
]
},
{
"id": "def-public.BaseVisType.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.BaseVisType.Unnamed.$1",
"type": "Object",
"label": "opts",
"isRequired": true,
"signature": [
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.VisTypeDefinition",
"text": "VisTypeDefinition"
},
"<TVisParams>"
],
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 48
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 48
}
}
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
"lineNumber": 24
},
"initialIsOpen": false
},
{
"id": "def-public.PersistedState",
"type": "Class",
@ -361,7 +794,13 @@
"lineNumber": 74
},
"signature": [
"BaseVisType",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.BaseVisType",
"text": "BaseVisType"
},
"<TVisParams>"
]
},
@ -806,7 +1245,7 @@
{
"id": "def-public.VisualizationContainer.$1",
"type": "Object",
"label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n}",
"label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n error,\n}",
"isRequired": true,
"signature": [
"VisualizationContainerProps"
@ -814,18 +1253,20 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/components/visualization_container.tsx",
"lineNumber": 23
"lineNumber": 27
}
}
],
"signature": [
"({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, }: VisualizationContainerProps) => JSX.Element"
"({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, error, }: ",
"VisualizationContainerProps",
") => JSX.Element"
],
"description": [],
"label": "VisualizationContainer",
"source": {
"path": "src/plugins/visualizations/public/components/visualization_container.tsx",
"lineNumber": 23
"lineNumber": 27
},
"tags": [],
"returnComment": [],
@ -984,7 +1425,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 30
"lineNumber": 25
},
"signature": [
{
@ -1005,7 +1446,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 31
"lineNumber": 26
},
"signature": [
{
@ -1026,7 +1467,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 32
"lineNumber": 27
},
"signature": [
{
@ -1042,7 +1483,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 29
"lineNumber": 24
},
"initialIsOpen": false
},
@ -1153,7 +1594,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 36
"lineNumber": 31
},
"signature": [
"string[]"
@ -1167,7 +1608,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 37
"lineNumber": 32
},
"signature": [
"node_modules/utility-types/dist/utility-types",
@ -1182,7 +1623,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 38
"lineNumber": 33
}
},
{
@ -1193,7 +1634,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 39
"lineNumber": 34
}
},
{
@ -1204,7 +1645,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 40
"lineNumber": 35
}
},
{
@ -1215,7 +1656,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 41
"lineNumber": 36
},
"signature": [
{
@ -1236,7 +1677,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 42
"lineNumber": 37
}
},
{
@ -1247,7 +1688,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 43
"lineNumber": 38
},
"signature": [
"unknown"
@ -1261,7 +1702,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 44
"lineNumber": 39
},
"signature": [
"boolean | undefined"
@ -1275,7 +1716,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 45
"lineNumber": 40
},
"signature": [
"boolean | undefined"
@ -1289,7 +1730,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 46
"lineNumber": 41
},
"signature": [
"any"
@ -1303,7 +1744,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 47
"lineNumber": 42
},
"signature": [
"boolean | undefined"
@ -1317,7 +1758,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 48
"lineNumber": 43
},
"signature": [
"React.ReactNode"
@ -1326,7 +1767,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 35
"lineNumber": 30
},
"initialIsOpen": false
},
@ -2220,13 +2661,7 @@
"lineNumber": 44
},
"signature": [
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.VisualizationStage",
"text": "VisualizationStage"
}
"\"experimental\" | \"beta\" | \"production\""
]
},
{
@ -2281,7 +2716,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 83
"lineNumber": 78
}
},
{
@ -2294,7 +2729,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 87
"lineNumber": 82
}
},
{
@ -2307,7 +2742,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 91
"lineNumber": 86
},
"signature": [
"string | undefined"
@ -2323,7 +2758,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 95
"lineNumber": 90
},
"signature": [
"string | undefined"
@ -2339,7 +2774,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 99
"lineNumber": 94
},
"signature": [
"(() => string[]) | undefined"
@ -2355,7 +2790,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 105
"lineNumber": 100
},
"signature": [
"((visParams: ",
@ -2393,7 +2828,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 107
"lineNumber": 102
},
"signature": [
"boolean | undefined"
@ -2409,7 +2844,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 111
"lineNumber": 106
},
"signature": [
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"
@ -2425,7 +2860,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 115
"lineNumber": 110
},
"signature": [
"string | undefined"
@ -2443,7 +2878,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 120
"lineNumber": 115
},
"signature": [
"\"experimental\" | \"beta\" | \"production\" | undefined"
@ -2461,7 +2896,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 126
"lineNumber": 121
},
"signature": [
{
@ -2484,7 +2919,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 132
"lineNumber": 127
},
"signature": [
"string | undefined"
@ -2500,7 +2935,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 138
"lineNumber": 133
},
"signature": [
"boolean | undefined"
@ -2514,7 +2949,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 139
"lineNumber": 134
},
"signature": [
"boolean | ((vis: { params: TVisParams; }) => boolean) | undefined"
@ -2528,7 +2963,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 140
"lineNumber": 135
},
"signature": [
{
@ -2559,7 +2994,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 147
"lineNumber": 142
},
"signature": [
"((vis: ",
@ -2591,7 +3026,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 153
"lineNumber": 148
},
"signature": [
{
@ -2612,7 +3047,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 155
"lineNumber": 150
},
"signature": [
"((vis: ",
@ -2642,7 +3077,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 156
"lineNumber": 151
},
"signature": [
"boolean | undefined"
@ -2656,7 +3091,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 158
"lineNumber": 153
},
"signature": [
"Partial<",
@ -2674,7 +3109,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 164
"lineNumber": 159
},
"signature": [
"DefaultEditorConfig<TVisParams> | CustomEditorConfig"
@ -2690,7 +3125,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 170
"lineNumber": 165
},
"signature": [
"Record<string, any>"
@ -2699,7 +3134,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 79
"lineNumber": 74
},
"initialIsOpen": false
},
@ -2782,13 +3217,7 @@
"lineNumber": 19
},
"signature": [
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.VisualizationStage",
"text": "VisualizationStage"
}
"\"experimental\" | \"beta\" | \"production\""
]
},
{
@ -3033,8 +3462,8 @@
"tags": [],
"description": [],
"source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts",
"lineNumber": 23
"path": "src/plugins/visualizations/public/vis_types/vis_groups_enum.ts",
"lineNumber": 9
},
"initialIsOpen": false
}
@ -3155,10 +3584,10 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/index.ts",
"lineNumber": 31
"lineNumber": 30
},
"signature": [
"{ readonly type: \"visualization\"; readonly id: string; destroy: () => void; readonly parent?: ",
"{ readonly type: \"visualization\"; readonly id: string; getDescription: () => string; destroy: () => void; readonly parent?: ",
{
"pluginId": "embeddable",
"scope": "public",
@ -3182,7 +3611,7 @@
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
"> | undefined; render: (domNode: HTMLElement) => Promise<void>; getDescription: () => string; getInspectorAdapters: () => ",
"> | undefined; render: (domNode: HTMLElement) => Promise<void>; getInspectorAdapters: () => ",
{
"pluginId": "inspector",
"scope": "common",
@ -3209,7 +3638,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/index.ts",
"lineNumber": 30
"lineNumber": 29
},
"signature": [
"{ readonly type: \"visualization\"; create: (input: ",
@ -3340,7 +3769,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 74
"lineNumber": 76
},
"signature": [
"{ createBaseVisualization: <TVisParams>(config: ",
@ -3377,9 +3806,21 @@
"text": "VisualizationsStart"
},
" extends { get: <TVisParams>(visualization: string) => ",
"BaseVisType",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.BaseVisType",
"text": "BaseVisType"
},
"<TVisParams> | undefined; all: () => ",
"BaseVisType",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.BaseVisType",
"text": "BaseVisType"
},
"<",
{
"pluginId": "visualizations",
@ -3408,7 +3849,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 77
"lineNumber": 79
},
"signature": [
{
@ -3431,7 +3872,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 78
"lineNumber": 80
},
"signature": [
"(visType: string, visState: ",
@ -3477,7 +3918,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 79
"lineNumber": 81
},
"signature": [
"(savedVis: ",
@ -3515,7 +3956,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 80
"lineNumber": 82
},
"signature": [
"(vis: ",
@ -3552,7 +3993,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 81
"lineNumber": 83
},
"signature": [
"typeof ",
@ -3567,7 +4008,7 @@
"description": [],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 82
"lineNumber": 84
},
"signature": [
"{ createVisEmbeddableFromObject: (vis: ",
@ -3609,7 +4050,7 @@
],
"source": {
"path": "src/plugins/visualizations/public/plugin.ts",
"lineNumber": 76
"lineNumber": 78
},
"lifecycle": "start",
"initialIsOpen": true

2
docs/developer/plugin-list.asciidoc
View file

@ -125,7 +125,7 @@ in Kibana, e.g. visualizations. It has the form of a flyout panel.
|{kib-repo}blob/{branch}/src/plugins/kibana_usage_collection/README.md[kibanaUsageCollection]
|This plugin registers the basic usage collectors from Kibana:
|This plugin registers the Platform Usage Collectors in Kibana.
|{kib-repo}blob/{branch}/src/plugins/kibana_utils/README.md[kibanaUtils]

2
docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
View file

File diff suppressed because one or more lines are too long

26
src/plugins/kibana_usage_collection/README.md
View file

@ -1,14 +1,18 @@
# Kibana Usage Collection
This plugin registers the basic usage collectors from Kibana:
This plugin registers the Platform Usage Collectors in Kibana.
- [Application Usage](./server/collectors/application_usage/README.md)
- Core Metrics
- [Config Usage](./server/collectors/config_usage/README.md)
- CSP configuration
- Kibana: Number of Saved Objects per type
- Localization data
- [User-changed UI Settings](./server/collectors/management/README.md)
- Ops stats
- UI Counts
- UI Metrics
| Collector name | Description | Extended documentation |
|----------------|:------------|:----------------------:|
| **Application Usage** | Measures how popular an App in Kibana is by reporting the on-screen time and the number of general clicks that happen in it. | [Link](./server/collectors/application_usage/README.md) |
| **Core Metrics** | Collects the usage reported by the core APIs | - |
| **Config Usage** | Reports the non-default values set via `kibana.yml` config file or CLI options. It `[redacts]` any potential PII-sensitive values. | [Link](./server/collectors/config_usage/README.md) |
| **User-changed UI Settings** | Reports all the UI Settings that have been overwritten by the user. It `[redacts]` any potential PII-sensitive values. | [Link](./server/collectors/management/README.md) |
| **CSP configuration** | Reports the key values regarding the CSP configuration. | - |
| **Kibana** | It reports the number of Saved Objects per type. It is limited to `dashboard`, `visualization`, `search`, `index-pattern`, `graph-workspace` and `timelion-sheet`.<br> It exists for legacy purposes, and may still be used by Monitoring via Metricbeat. | - |
| **Saved Objects Counts** | Number of Saved Objects per type. | - |
| **Localization data** | Localization settings: setup locale and installed translation files. | - |
| **Ops stats** | Operation metrics from the system. | - |
| **UI Counters** | Daily aggregation of the number of times an event occurs in the UI. | [Link](../usage_collection/README.mdx#ui-counters) |
| **UI Metrics** | Deprecated. Old form of UI Counters. It reports the _count of the repetitions since the cluster's first start_ of any UI events that may have happened. | - |
| **Usage Counters** | Daily aggregation of the number of times an event occurs on the Server. | [Link](../usage_collection/README.mdx#usage-counters) |

5
src/plugins/kibana_usage_collection/server/collectors/index.ts
View file

@ -9,7 +9,10 @@
export { registerUiMetricUsageCollector } from './ui_metric';
export { registerManagementUsageCollector } from './management';
export { registerApplicationUsageCollector } from './application_usage';
export { registerKibanaUsageCollector } from './kibana';
export {
registerKibanaUsageCollector,
registerSavedObjectsCountUsageCollector,
} from './saved_objects_counts';
export { registerOpsStatsCollector } from './ops_stats';
export { registerCloudProviderUsageCollector } from './cloud';
export { registerCspCollector } from './csp';

60
src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.test.ts
View file

@ -1,60 +0,0 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import { elasticsearchServiceMock } from '../../../../../../src/core/server/mocks';
import { getSavedObjectsCounts } from './get_saved_object_counts';
export function mockGetSavedObjectsCounts<TBody>(params: TBody) {
const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;
esClient.search.mockResolvedValue(
// @ts-expect-error we only care about the response body
{ body: { ...params } }
);
return esClient;
}
describe('getSavedObjectsCounts', () => {
test('Get all the saved objects equal to 0 because no results were found', async () => {
const esClient = mockGetSavedObjectsCounts({});
const results = await getSavedObjectsCounts(esClient, '.kibana');
expect(results).toStrictEqual({
dashboard: { total: 0 },
visualization: { total: 0 },
search: { total: 0 },
index_pattern: { total: 0 },
graph_workspace: { total: 0 },
timelion_sheet: { total: 0 },
});
});
test('Merge the zeros with the results', async () => {
const esClient = mockGetSavedObjectsCounts({
aggregations: {
types: {
buckets: [
{ key: 'dashboard', doc_count: 1 },
{ key: 'timelion-sheet', doc_count: 2 },
{ key: 'index-pattern', value: 2 }, // Malformed on purpose
{ key: 'graph_workspace', doc_count: 3 }, // already snake_cased
],
},
},
});
const results = await getSavedObjectsCounts(esClient, '.kibana');
expect(results).toStrictEqual({
dashboard: { total: 1 },
visualization: { total: 0 },
search: { total: 0 },
index_pattern: { total: 0 },
graph_workspace: { total: 3 },
timelion_sheet: { total: 2 },
});
});
});

75
src/plugins/kibana_usage_collection/server/collectors/kibana/get_saved_object_counts.ts
View file

@ -1,75 +0,0 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
/**
* Moved from /x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_kibana_usage_collector.ts
*
* The PR https://github.com/elastic/kibana/pull/62665 proved what the issue https://github.com/elastic/kibana/issues/58249
* was claiming: the structure and payload for common telemetry bits differs between Monitoring and OSS/X-Pack collections.
*
* Unifying this logic from Monitoring that makes sense to have in OSS here and we will import it on the monitoring side to reuse it.
*/
import { snakeCase } from 'lodash';
import { ElasticsearchClient } from 'src/core/server';
const TYPES = [
'dashboard',
'visualization',
'search',
'index-pattern',
'graph-workspace',
'timelion-sheet',
];
export interface KibanaSavedObjectCounts {
dashboard: { total: number };
visualization: { total: number };
search: { total: number };
index_pattern: { total: number };
graph_workspace: { total: number };
timelion_sheet: { total: number };
}
export async function getSavedObjectsCounts(
esClient: ElasticsearchClient,
kibanaIndex: string // Typically '.kibana'. We might need a way to obtain it from the SavedObjects client (or the SavedObjects client to provide a way to run aggregations?)
): Promise<KibanaSavedObjectCounts> {
const savedObjectCountSearchParams = {
index: kibanaIndex,
ignoreUnavailable: true,
filterPath: 'aggregations.types.buckets',
body: {
size: 0,
query: {
terms: { type: TYPES },
},
aggs: {
types: {
terms: { field: 'type', size: TYPES.length },
},
},
},
};
const { body } = await esClient.search(savedObjectCountSearchParams);
const buckets: Array<{ key: string; doc_count: number }> =
// @ts-expect-error @elastic/elasticsearch Aggregate does not include `buckets`
body.aggregations?.types?.buckets || [];
// Initialise the object with all zeros for all the types
const allZeros: KibanaSavedObjectCounts = TYPES.reduce(
(acc, type) => ({ ...acc, [snakeCase(type)]: { total: 0 } }),
{} as KibanaSavedObjectCounts
);
// Add the doc_count from each bucket
return buckets.reduce(
(acc, { key, doc_count: total }) => (total ? { ...acc, [snakeCase(key)]: { total } } : acc),
allZeros
);
}

76
src/plugins/kibana_usage_collection/server/collectors/kibana/kibana_usage_collector.ts
View file

@ -1,76 +0,0 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import { Observable } from 'rxjs';
import { take } from 'rxjs/operators';
import { SharedGlobalConfig } from 'kibana/server';
import { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
import { getSavedObjectsCounts, KibanaSavedObjectCounts } from './get_saved_object_counts';
interface KibanaUsage extends KibanaSavedObjectCounts {
index: string;
}
export function getKibanaUsageCollector(
usageCollection: UsageCollectionSetup,
legacyConfig$: Observable<SharedGlobalConfig>
) {
return usageCollection.makeUsageCollector<KibanaUsage>({
type: 'kibana',
isReady: () => true,
schema: {
index: { type: 'keyword', _meta: { description: 'The index storing the saved objects' } },
dashboard: {
total: { type: 'long', _meta: { description: 'Total number of dashboard saved objects' } },
},
visualization: {
total: {
type: 'long',
_meta: { description: 'Total number of visualization saved objects' },
},
},
search: {
total: { type: 'long', _meta: { description: 'Total number of search saved objects' } },
},
index_pattern: {
total: {
type: 'long',
_meta: { description: 'Total number of index_pattern saved objects' },
},
},
graph_workspace: {
total: {
type: 'long',
_meta: { description: 'Total number of graph_workspace saved objects' },
},
},
timelion_sheet: {
total: {
type: 'long',
_meta: { description: 'Total number of timelion_sheet saved objects' },
},
},
},
async fetch({ esClient }) {
const {
kibana: { index },
} = await legacyConfig$.pipe(take(1)).toPromise();
return {
index,
...(await getSavedObjectsCounts(esClient, index)),
};
},
});
}
export function registerKibanaUsageCollector(
usageCollection: UsageCollectionSetup,
legacyConfig$: Observable<SharedGlobalConfig>
) {
usageCollection.registerCollector(getKibanaUsageCollector(usageCollection, legacyConfig$));
}

80
src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.test.ts Normal file
View file

@ -0,0 +1,80 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import { elasticsearchServiceMock } from '../../../../../../src/core/server/mocks';
import { getSavedObjectsCounts } from './get_saved_object_counts';
function mockGetSavedObjectsCounts<TBody>(params: TBody) {
const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;
esClient.search.mockResolvedValue(
// @ts-expect-error we only care about the response body
{ body: { ...params } }
);
return esClient;
}
describe('getSavedObjectsCounts', () => {
test('should not fail if no body returned', async () => {
const esClient = mockGetSavedObjectsCounts({});
const results = await getSavedObjectsCounts(esClient, '.kibana');
expect(results).toStrictEqual([]);
expect(esClient.search).toHaveBeenCalledWith({
index: '.kibana',
ignoreUnavailable: true,
filterPath: 'aggregations.types.buckets',
body: {
size: 0,
query: { match_all: {} },
aggs: { types: { terms: { field: 'type' } } },
},
});
});
test('should match all when no types specified', async () => {
const esClient = mockGetSavedObjectsCounts({});
await getSavedObjectsCounts(esClient, '.kibana');
expect(esClient.search).toHaveBeenCalledWith({
index: '.kibana',
ignoreUnavailable: true,
filterPath: 'aggregations.types.buckets',
body: {
size: 0,
query: { match_all: {} },
aggs: { types: { terms: { field: 'type' } } },
},
});
});
test('should terms query when types are specified', async () => {
const esClient = mockGetSavedObjectsCounts({});
await getSavedObjectsCounts(esClient, '.kibana', ['type_one', 'type_two']);
expect(esClient.search).toHaveBeenCalledWith({
index: '.kibana',
ignoreUnavailable: true,
filterPath: 'aggregations.types.buckets',
body: {
size: 0,
query: { terms: { type: ['type_one', 'type_two'] } },
aggs: { types: { terms: { field: 'type' } } },
},
});
});
test('return the buckets as they are', async () => {
const buckets = [
{ key: 'type_one', doc_count: 1 },
{ key: 'type-two', doc_count: 2 },
];
const esClient = mockGetSavedObjectsCounts({ aggregations: { types: { buckets } } });
const results = await getSavedObjectsCounts(esClient, '.kibana');
expect(results).toStrictEqual(buckets);
});
});

31
src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/get_saved_object_counts.ts Normal file
View file

@ -0,0 +1,31 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import { ElasticsearchClient } from 'src/core/server';
export async function getSavedObjectsCounts(
esClient: ElasticsearchClient,
kibanaIndex: string, // Typically '.kibana'. We might need a way to obtain it from the SavedObjects client (or the SavedObjects client to provide a way to run aggregations?)
onlyTypes: string[] = []
): Promise<Array<{ key: string; doc_count: number }>> {
const query = onlyTypes.length ? { terms: { type: onlyTypes } } : { match_all: {} };
const savedObjectCountSearchParams = {
index: kibanaIndex,
ignoreUnavailable: true,
filterPath: 'aggregations.types.buckets',
body: {
size: 0,
query,
aggs: { types: { terms: { field: 'type' } } },
},
};
const { body } = await esClient.search(savedObjectCountSearchParams);
// @ts-expect-error @elastic/elasticsearch Aggregate does not include `buckets`
return body.aggregations?.types?.buckets || [];
}

1
src/plugins/kibana_usage_collection/server/collectors/kibana/index.ts → src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/index.ts
View file

@ -7,3 +7,4 @@
*/
export { registerKibanaUsageCollector } from './kibana_usage_collector';
export { registerSavedObjectsCountUsageCollector } from './saved_objects_count_collector';

54
src/plugins/kibana_usage_collection/server/collectors/kibana/index.test.ts → src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.test.ts
View file

@ -16,11 +16,11 @@ import {
createCollectorFetchContextMock,
createUsageCollectionSetupMock,
} from '../../../../usage_collection/server/mocks';
import { registerKibanaUsageCollector } from './';
import { getKibanaSavedObjectCounts, registerKibanaUsageCollector } from './kibana_usage_collector';
const logger = loggingSystemMock.createLogger();
describe('telemetry_kibana', () => {
describe('kibana_usage', () => {
let collector: Collector<unknown>;
const usageCollectionMock = createUsageCollectionSetupMock();
@ -60,3 +60,53 @@ describe('telemetry_kibana', () => {
});
});
});
function mockGetSavedObjectsCounts<TBody>(params: TBody) {
const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;
esClient.search.mockResolvedValue(
// @ts-expect-error we only care about the response body
{ body: { ...params } }
);
return esClient;
}
describe('getKibanaSavedObjectCounts', () => {
test('Get all the saved objects equal to 0 because no results were found', async () => {
const esClient = mockGetSavedObjectsCounts({});
const results = await getKibanaSavedObjectCounts(esClient, '.kibana');
expect(results).toStrictEqual({
dashboard: { total: 0 },
visualization: { total: 0 },
search: { total: 0 },
index_pattern: { total: 0 },
graph_workspace: { total: 0 },
timelion_sheet: { total: 0 },
});
});
test('Merge the zeros with the results', async () => {
const esClient = mockGetSavedObjectsCounts({
aggregations: {
types: {
buckets: [
{ key: 'dashboard', doc_count: 1 },
{ key: 'timelion-sheet', doc_count: 2 },
{ key: 'index-pattern', value: 2 }, // Malformed on purpose
{ key: 'graph_workspace', doc_count: 3 }, // already snake_cased
],
},
},
});
const results = await getKibanaSavedObjectCounts(esClient, '.kibana');
expect(results).toStrictEqual({
dashboard: { total: 1 },
visualization: { total: 0 },
search: { total: 0 },
index_pattern: { total: 0 },
graph_workspace: { total: 3 },
timelion_sheet: { total: 2 },
});
});
});

110
src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/kibana_usage_collector.ts Normal file
View file

@ -0,0 +1,110 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import type { Observable } from 'rxjs';
import type { ElasticsearchClient, SharedGlobalConfig } from 'src/core/server';
import type { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
import { take } from 'rxjs/operators';
import { snakeCase } from 'lodash';
import { getSavedObjectsCounts } from './get_saved_object_counts';
interface KibanaSavedObjectCounts {
dashboard: { total: number };
visualization: { total: number };
search: { total: number };
index_pattern: { total: number };
graph_workspace: { total: number };
timelion_sheet: { total: number };
}
interface KibanaUsage extends KibanaSavedObjectCounts {
index: string;
}
const TYPES = [
'dashboard',
'visualization',
'search',
'index-pattern',
'graph-workspace',
'timelion-sheet',
];
export async function getKibanaSavedObjectCounts(
esClient: ElasticsearchClient,
kibanaIndex: string
): Promise<KibanaSavedObjectCounts> {
const buckets = await getSavedObjectsCounts(esClient, kibanaIndex, TYPES);
const allZeros = (Object.fromEntries(
TYPES.map((type) => [snakeCase(type), { total: 0 }])
) as unknown) as KibanaSavedObjectCounts;
return buckets.reduce((acc, { key, doc_count: total = 0 }) => {
const type = snakeCase(key) as keyof KibanaSavedObjectCounts;
acc[type].total += total;
return acc;
}, allZeros);
}
export function registerKibanaUsageCollector(
usageCollection: UsageCollectionSetup,
legacyConfig$: Observable<SharedGlobalConfig>
) {
usageCollection.registerCollector(
usageCollection.makeUsageCollector<KibanaUsage>({
type: 'kibana',
isReady: () => true,
schema: {
index: { type: 'keyword', _meta: { description: 'The index storing the saved objects' } },
dashboard: {
total: {
type: 'long',
_meta: { description: 'Total number of dashboard saved objects' },
},
},
visualization: {
total: {
type: 'long',
_meta: { description: 'Total number of visualization saved objects' },
},
},
search: {
total: { type: 'long', _meta: { description: 'Total number of search saved objects' } },
},
index_pattern: {
total: {
type: 'long',
_meta: { description: 'Total number of index_pattern saved objects' },
},
},
graph_workspace: {
total: {
type: 'long',
_meta: { description: 'Total number of graph_workspace saved objects' },
},
},
timelion_sheet: {
total: {
type: 'long',
_meta: { description: 'Total number of timelion_sheet saved objects' },
},
},
},
async fetch({ esClient }) {
const {
kibana: { index },
} = await legacyConfig$.pipe(take(1)).toPromise();
return {
index,
...(await getKibanaSavedObjectCounts(esClient, index)),
};
},
})
);
}

66
src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.test.ts Normal file
View file

@ -0,0 +1,66 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import { pluginInitializerContextConfigMock } from '../../../../../core/server/mocks';
import {
createCollectorFetchContextMock,
createUsageCollectionSetupMock,
} from '../../../../usage_collection/server/mocks';
import { registerSavedObjectsCountUsageCollector } from './saved_objects_count_collector';
describe('saved_objects_count_collector', () => {
const usageCollectionMock = createUsageCollectionSetupMock();
const legacyConfig$ = pluginInitializerContextConfigMock({}).legacy.globalConfig$;
beforeAll(() => registerSavedObjectsCountUsageCollector(usageCollectionMock, legacyConfig$));
afterAll(() => jest.clearAllTimers());
test('registered collector is set', () => {
expect(usageCollectionMock.makeUsageCollector).toHaveBeenCalled();
expect(usageCollectionMock.registerCollector).toHaveBeenCalled();
expect(usageCollectionMock.makeUsageCollector.mock.calls[0][0].type).toBe(
'saved_objects_counts'
);
});
test('should return an empty array when no results are returned', async () => {
const collector = usageCollectionMock.makeUsageCollector.mock.results[0].value;
expect(await collector.fetch(createCollectorFetchContextMock())).toStrictEqual({
by_type: [],
});
});
test('should return some values when the aggregations return something', async () => {
const fetchContextMock = createCollectorFetchContextMock();
fetchContextMock.esClient.search = jest.fn().mockImplementation(() => ({
body: {
aggregations: {
types: {
buckets: [
{ key: 'type_one', doc_count: 20 },
{ key: 'type_two', doc_count: 45 },
{ key: 'type-three', doc_count: 66 },
{ key: 'type-four', doc_count: 0 },
],
},
},
},
}));
const collector = usageCollectionMock.makeUsageCollector.mock.results[0].value;
expect(await collector.fetch(fetchContextMock)).toStrictEqual({
by_type: [
{ type: 'type_one', count: 20 },
{ type: 'type_two', count: 45 },
{ type: 'type-three', count: 66 },
{ type: 'type-four', count: 0 },
],
});
});
});

60
src/plugins/kibana_usage_collection/server/collectors/saved_objects_counts/saved_objects_count_collector.ts Normal file
View file

@ -0,0 +1,60 @@
/*
* 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 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import type { Observable } from 'rxjs';
import { take } from 'rxjs/operators';
import type { SharedGlobalConfig } from 'src/core/server';
import type { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
import { getSavedObjectsCounts } from './get_saved_object_counts';
interface SavedObjectsCountUsageByType {
type: string;
count: number;
}
interface SavedObjectsCountUsage {
by_type: SavedObjectsCountUsageByType[];
}
export function registerSavedObjectsCountUsageCollector(
usageCollection: UsageCollectionSetup,
legacyConfig$: Observable<SharedGlobalConfig>
) {
usageCollection.registerCollector(
usageCollection.makeUsageCollector<SavedObjectsCountUsage>({
type: 'saved_objects_counts',
isReady: () => true,
schema: {
by_type: {
type: 'array',
items: {
type: { type: 'keyword', _meta: { description: 'The SavedObjects type' } },
count: {
type: 'long',
_meta: {
description:
'How many SavedObjects of that type are stored in the cluster across all Spaces',
},
},
},
},
},
async fetch({ esClient }) {
const {
kibana: { index },
} = await legacyConfig$.pipe(take(1)).toPromise();
const buckets = await getSavedObjectsCounts(esClient, index);
return {
by_type: buckets.map(({ key: type, doc_count: count }) => {
return { type, count };
}),
};
},
})
);
}

4
src/plugins/kibana_usage_collection/server/plugin.test.ts
View file

@ -69,6 +69,10 @@ describe('kibana_usage_collection', () => {
"isReady": true,
"type": "kibana",
},
Object {
"isReady": true,
"type": "saved_objects_counts",
},
Object {
"isReady": false,
"type": "stack_management",

10
src/plugins/kibana_usage_collection/server/plugin.ts
View file

@ -6,22 +6,22 @@
* Side Public License, v 1.
*/
import { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
import type { UsageCollectionSetup } from 'src/plugins/usage_collection/server';
import { Subject, Observable } from 'rxjs';
import {
import type {
PluginInitializerContext,
CoreSetup,
Plugin,
ISavedObjectsRepository,
IUiSettingsClient,
SharedGlobalConfig,
SavedObjectsClient,
CoreStart,
SavedObjectsServiceSetup,
OpsMetrics,
Logger,
CoreUsageDataStart,
} from '../../../core/server';
} from 'src/core/server';
import { SavedObjectsClient } from '../../../core/server';
import {
registerApplicationUsageCollector,
registerKibanaUsageCollector,
@ -38,6 +38,7 @@ import {
registerConfigUsageCollector,
registerUsageCountersRollups,
registerUsageCountersUsageCollector,
registerSavedObjectsCountUsageCollector,
} from './collectors';
interface KibanaUsageCollectionPluginsDepsSetup {
@ -112,6 +113,7 @@ export class KibanaUsageCollectionPlugin implements Plugin {
registerOpsStatsCollector(usageCollection, metric$);
registerKibanaUsageCollector(usageCollection, this.legacyConfig$);
registerSavedObjectsCountUsageCollector(usageCollection, this.legacyConfig$);
registerManagementUsageCollector(usageCollection, getUiSettingsClient);
registerUiMetricUsageCollector(usageCollection, registerType, getSavedObjectsClient);
registerApplicationUsageCollector(

163
src/plugins/telemetry/schema/oss_plugins.json
View file

@ -7600,76 +7600,6 @@
}
}
},
"kibana": {
"properties": {
"index": {
"type": "keyword",
"_meta": {
"description": "The index storing the saved objects"
}
},
"dashboard": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of dashboard saved objects"
}
}
}
},
"visualization": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of visualization saved objects"
}
}
}
},
"search": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of search saved objects"
}
}
}
},
"index_pattern": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of index_pattern saved objects"
}
}
}
},
"graph_workspace": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of graph_workspace saved objects"
}
}
}
},
"timelion_sheet": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of timelion_sheet saved objects"
}
}
}
}
}
},
"localization": {
"properties": {
"locale": {
@ -8351,6 +8281,99 @@
}
}
},
"kibana": {
"properties": {
"index": {
"type": "keyword",
"_meta": {
"description": "The index storing the saved objects"
}
},
"dashboard": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of dashboard saved objects"
}
}
}
},
"visualization": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of visualization saved objects"
}
}
}
},
"search": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of search saved objects"
}
}
}
},
"index_pattern": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of index_pattern saved objects"
}
}
}
},
"graph_workspace": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of graph_workspace saved objects"
}
}
}
},
"timelion_sheet": {
"properties": {
"total": {
"type": "long",
"_meta": {
"description": "Total number of timelion_sheet saved objects"
}
}
}
}
}
},
"saved_objects_counts": {
"properties": {
"by_type": {
"type": "array",
"items": {
"properties": {
"type": {
"type": "keyword",
"_meta": {
"description": "The SavedObjects type"
}
},
"count": {
"type": "long",
"_meta": {
"description": "How many SavedObjects of that type are stored in the cluster across all Spaces"
}
}
}
}
}
}
},
"ui_counters": {
"properties": {
"dailyEvents": {

9
test/api_integration/apis/telemetry/telemetry_local.ts
View file

@ -127,6 +127,15 @@ export default function ({ getService }: FtrProviderContext) {
expect(stats.stack_stats.data[0].doc_count).to.be(0);
expect(stats.stack_stats.data[0].ecs_index_count).to.be(0);
expect(stats.stack_stats.data[0].size_in_bytes).to.be.a('number');
expect(stats.stack_stats.kibana.plugins.saved_objects_counts).to.be.an('object');
expect(stats.stack_stats.kibana.plugins.saved_objects_counts.by_type).to.be.an('array');
expect(stats.stack_stats.kibana.plugins.saved_objects_counts.by_type).to.eql([
{ type: 'config', count: 2 },
{ type: 'dashboard', count: 2 },
{ type: 'index-pattern', count: 2 },
{ type: 'visualization', count: 2 },
]);
});
it('should validate mandatory fields exist', () => {