2021-03-04 02:12:24 +01:00
{
"id" : "telemetry" ,
"client" : {
2021-04-29 17:45:21 +02:00
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
2021-04-28 12:22:37 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "TelemetryPluginConfig" ,
"description" : [
"\nPublic-exposed configuration"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-28 12:22:37 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.enabled" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "enabled" ,
"description" : [
"Is the plugin enabled?"
2021-04-28 12:22:37 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.banner" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "banner" ,
"description" : [
"The banner is expected to be shown when needed"
2021-04-28 12:22:37 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.allowChangingOptInStatus" ,
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "allowChangingOptInStatus" ,
"description" : [
"Does the cluster allow changing the opt-in/out status via the UI?"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.optIn" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "optIn" ,
"description" : [
"Is the cluster opted-in?"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.TelemetryPluginConfig.sendUsageTo" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-08-09 18:51:00 +02:00
"label" : "sendUsageTo" ,
2021-04-29 17:45:21 +02:00
"description" : [
2021-08-09 18:51:00 +02:00
"Specify if telemetry should send usage to the prod or staging remote telemetry service"
] ,
"signature" : [
"\"prod\" | \"staging\""
2021-04-29 17:45:21 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.sendUsageFrom" ,
2021-04-28 12:22:37 +02:00
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "sendUsageFrom" ,
"description" : [
"Should the telemetry payloads be sent from the server or the browser?"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"\"browser\" | \"server\""
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.telemetryNotifyUserAboutOptInDefault" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "telemetryNotifyUserAboutOptInDefault" ,
"description" : [
"Should notify the user about the opt-in status?"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginConfig.userCanChangeSettings" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "userCanChangeSettings" ,
"description" : [
"Does the user have enough privileges to change the settings?"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-29 17:45:21 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryServicePublicApis" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "TelemetryServicePublicApis" ,
"description" : [
"\nPublicly exposed APIs from the Telemetry Service"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-29 17:45:21 +02:00
"children" : [
2021-04-28 12:22:37 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryServicePublicApis.getIsOptedIn" ,
2021-04-28 12:22:37 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "getIsOptedIn" ,
"description" : [
"Is the cluster opted-in to telemetry?"
2021-04-28 12:22:37 +02:00
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"() => boolean | null"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryServicePublicApis.userCanChangeSettings" ,
2021-04-28 12:22:37 +02:00
"type" : "boolean" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-28 12:22:37 +02:00
"label" : "userCanChangeSettings" ,
2021-04-29 17:45:21 +02:00
"description" : [
"Is the user allowed to change the opt-in/out status?"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
2021-06-08 22:26:37 +02:00
{
"parentPluginId" : "telemetry" ,
"id" : "def-public.TelemetryServicePublicApis.canSendTelemetry" ,
"type" : "Function" ,
"tags" : [ ] ,
"label" : "canSendTelemetry" ,
"description" : [
"Can phone-home telemetry calls be made? This depends on whether we have opted-in or if we are rendering a report"
] ,
"signature" : [
"() => boolean"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-06-08 22:26:37 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-06-08 22:26:37 +02:00
} ,
2021-04-28 12:22:37 +02:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryServicePublicApis.getCanChangeOptInStatus" ,
2021-04-28 12:22:37 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "getCanChangeOptInStatus" ,
"description" : [
"Is the cluster allowed to change the opt-in/out status?"
2021-04-28 12:22:37 +02:00
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"() => boolean"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryServicePublicApis.fetchExample" ,
2021-04-28 12:22:37 +02:00
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "fetchExample" ,
"description" : [
"Fetches an unencrypted telemetry payload so we can show it to the user"
2021-04-28 12:22:37 +02:00
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"() => Promise<unknown[]>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryServicePublicApis.setOptIn" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "setOptIn" ,
"description" : [
"\nOverwrite the opt-in status.\nIt will send a final request to the remote telemetry cluster to report about the opt-in/out change."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"(optedIn: boolean) => Promise<boolean>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "telemetry" ,
2021-08-09 18:51:00 +02:00
"id" : "def-public.TelemetryServicePublicApis.setOptIn.$1" ,
2021-05-20 22:11:31 +02:00
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "optedIn" ,
"description" : [
"Whether the user is opting-in (`true`) or out (`false`)."
] ,
2021-08-09 18:51:00 +02:00
"signature" : [
"boolean"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-08-09 18:51:00 +02:00
"deprecated" : false ,
"isRequired" : true
2021-05-20 22:11:31 +02:00
}
2021-08-09 18:51:00 +02:00
] ,
"returnComment" : [ ]
2021-04-29 17:45:21 +02:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ] ,
"start" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginStart" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "TelemetryPluginStart" ,
"description" : [
"\nPublic's start exposed APIs by the telemetry plugin"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-29 17:45:21 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginStart.telemetryService" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "telemetryService" ,
"description" : [
"{@link TelemetryServicePublicApis}"
] ,
"signature" : [
{
"pluginId" : "telemetry" ,
"scope" : "public" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-public.TelemetryServicePublicApis" ,
"text" : "TelemetryServicePublicApis"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-29 17:45:21 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginStart.telemetryNotifications" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "telemetryNotifications" ,
"description" : [
"Notification helpers"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ setOptedInNoticeSeen: () => Promise<void>; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-29 17:45:21 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginStart.telemetryConstants" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "telemetryConstants" ,
"description" : [
"Set of publicly exposed telemetry constants"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ getPrivacyStatementUrl: () => string; }"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-29 17:45:21 +02:00
}
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
} ,
"setup" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginSetup" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "TelemetryPluginSetup" ,
"description" : [
"\nPublic's setup exposed APIs by the telemetry plugin"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-29 17:45:21 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-public.TelemetryPluginSetup.telemetryService" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "telemetryService" ,
"description" : [
"{@link TelemetryService}"
] ,
"signature" : [
{
"pluginId" : "telemetry" ,
"scope" : "public" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-public.TelemetryServicePublicApis" ,
"text" : "TelemetryServicePublicApis"
}
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/public/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-29 17:45:21 +02:00
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryBasePayload" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "DataTelemetryBasePayload" ,
"description" : [
"\nCommon counters for the {@link DataTelemetryDocument}s"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-29 17:45:21 +02:00
"children" : [
2021-03-04 02:12:24 +01:00
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryBasePayload.index_count" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "index_count" ,
"description" : [
"How many indices match the declared pattern"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryBasePayload.ecs_index_count" ,
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "ecs_index_count" ,
"description" : [
"How many indices match the declared pattern follow ECS conventions"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"number | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryBasePayload.doc_count" ,
2021-03-04 02:12:24 +01:00
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "doc_count" ,
"description" : [
"How many documents are among all the identified indices"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"number | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryBasePayload.size_in_bytes" ,
2021-03-04 02:12:24 +01:00
"type" : "number" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "size_in_bytes" ,
"description" : [
"Total size in bytes among all the identified indices"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"number | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-03-04 02:12:24 +01:00
}
] ,
"initialIsOpen" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryDocument" ,
2021-04-28 12:22:37 +02:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "DataTelemetryDocument" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nDepending on the type of index, we'll populate different keys as we identify them."
] ,
2021-04-29 17:45:21 +02:00
"signature" : [
{
"pluginId" : "telemetry" ,
"scope" : "server" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-server.DataTelemetryDocument" ,
"text" : "DataTelemetryDocument"
} ,
" extends " ,
{
"pluginId" : "telemetry" ,
"scope" : "server" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-server.DataTelemetryBasePayload" ,
"text" : "DataTelemetryBasePayload"
}
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-28 12:22:37 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryDocument.data_stream" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "data_stream" ,
"description" : [
"For data-stream indices. Reporting their details"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ dataset?: string | undefined; type?: string | undefined; } | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryDocument.package" ,
"type" : "Object" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "package" ,
"description" : [
"When available, reporting the package details"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"{ name: string; } | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryDocument.shipper" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "shipper" ,
"description" : [
"What's the process indexing the data? (i.e.: \"beats\", \"logstash\")"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"string | undefined"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.DataTelemetryDocument.pattern_name" ,
"type" : "CompoundType" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "pattern_name" ,
"description" : [
"When the data comes from a matching index-pattern, the name of the pattern"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-08-30 17:02:04 +02:00
"\"search\" | \"logstash\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"metricbeat\" | \"apm\" | \"functionbeat\" | \"heartbeat\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"zeek\" | \"sigma_doc\" | \"ecs-corelight\" | \"suricata\" | \"wazuh\" | \"meow\" | \"host_risk_score\" | undefined"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.NodeUsage" ,
2021-04-28 12:22:37 +02:00
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "NodeUsage" ,
2021-05-06 23:59:11 +02:00
"description" : [
"\nData returned by GET /_nodes/usage, but flattened as an array of {@link estypes.NodeUsageInformation}\nwith the node ID set in the field `node_id`."
] ,
2021-04-29 17:45:21 +02:00
"signature" : [
{
"pluginId" : "telemetry" ,
"scope" : "server" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-server.NodeUsage" ,
"text" : "NodeUsage"
} ,
" extends " ,
2021-06-08 22:26:37 +02:00
"NodesUsageNodeUsage"
2021-04-29 17:45:21 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_nodes_usage.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-04-28 12:22:37 +02:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-04-29 17:45:21 +02:00
"id" : "def-server.NodeUsage.node_id" ,
"type" : "string" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-04-29 17:45:21 +02:00
"label" : "node_id" ,
"description" : [
"\nThe Node ID as reported by ES"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_nodes_usage.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false
2021-04-28 12:22:37 +02:00
}
] ,
"initialIsOpen" : false
2021-03-04 02:12:24 +01:00
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.DataTelemetryPayload" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "DataTelemetryPayload" ,
2021-04-29 17:45:21 +02:00
"description" : [
"\nThe Data Telemetry is reported as an array of {@link DataTelemetryDocument}"
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
{
"pluginId" : "telemetry" ,
"scope" : "server" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-server.DataTelemetryDocument" ,
"text" : "DataTelemetryDocument"
} ,
"[]"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"initialIsOpen" : false
2021-03-06 16:05:27 +01:00
} ,
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-03-06 16:05:27 +01:00
"id" : "def-server.TelemetryLocalStats" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 23:59:11 +02:00
"label" : "TelemetryLocalStats" ,
2021-04-29 17:45:21 +02:00
"description" : [
"\nThe payload structure as composed by the OSS telemetry collection mechanism."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
2021-05-20 22:11:31 +02:00
"{ timestamp: string; cluster_uuid: string; cluster_name: string; version: string; cluster_stats: Pick<" ,
"ClusterStatsResponse" ,
", \"status\" | \"indices\" | \"nodes\" | \"cluster_uuid\" | \"timestamp\">; collection: string; stack_stats: { data: " ,
{
"pluginId" : "telemetry" ,
"scope" : "server" ,
"docId" : "kibTelemetryPluginApi" ,
"section" : "def-server.DataTelemetryPayload" ,
"text" : "DataTelemetryPayload"
} ,
" | undefined; kibana: { count: number; indices: number; os: {}; versions: { version: string; count: number; }[]; plugins: { [plugin: string]: Record<string, unknown>; }; } | undefined; }; }"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/telemetry_collection/get_local_stats.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-06 16:05:27 +01:00
"initialIsOpen" : false
2021-03-04 02:12:24 +01:00
}
] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.TelemetryPluginSetup" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "TelemetryPluginSetup" ,
2021-04-29 17:45:21 +02:00
"description" : [
"\nServer's setup exposed APIs by the telemetry plugin"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.TelemetryPluginSetup.getTelemetryUrl" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getTelemetryUrl" ,
"description" : [
"\nResolves into the telemetry Url used to send telemetry.\nThe url is wrapped with node's [URL constructor](https://nodejs.org/api/url.html)."
] ,
"signature" : [
"() => Promise<" ,
"URL" ,
">"
2021-05-06 23:59:11 +02:00
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.TelemetryPluginStart" ,
"type" : "Interface" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "TelemetryPluginStart" ,
2021-04-29 17:45:21 +02:00
"description" : [
"\nServer's start exposed APIs by the telemetry plugin"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/plugin.ts" ,
2021-05-06 23:59:11 +02:00
"deprecated" : false ,
2021-03-04 02:12:24 +01:00
"children" : [
{
2021-05-06 23:59:11 +02:00
"parentPluginId" : "telemetry" ,
2021-03-04 02:12:24 +01:00
"id" : "def-server.TelemetryPluginStart.getIsOptedIn" ,
"type" : "Function" ,
2021-05-06 23:59:11 +02:00
"tags" : [ ] ,
2021-03-04 02:12:24 +01:00
"label" : "getIsOptedIn" ,
"description" : [
"\nResolves `true` if the user has opted into send Elastic usage data.\nResolves `false` if the user explicitly opted out of sending usage data to Elastic\nor did not choose to opt-in or out -yet- after a minor or major upgrade (only when previously opted-out)."
] ,
2021-05-06 23:59:11 +02:00
"signature" : [
"() => Promise<boolean>"
] ,
2021-08-05 18:26:16 +02:00
"path" : "src/plugins/telemetry/server/plugin.ts" ,
2021-05-20 22:11:31 +02:00
"deprecated" : false ,
2021-08-09 18:51:00 +02:00
"children" : [ ] ,
"returnComment" : [ ]
2021-03-04 02:12:24 +01:00
}
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}