mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
2545 lines
No EOL
94 KiB
JSON
2545 lines
No EOL
94 KiB
JSON
{
|
|
"id": "@kbn/analytics-client",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.createAnalytics",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createAnalytics",
|
|
"description": [
|
|
"\nCreates an {@link AnalyticsClient}."
|
|
],
|
|
"signature": [
|
|
"(initContext: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AnalyticsClientInitContext",
|
|
"text": "AnalyticsClientInitContext"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.IAnalyticsClient",
|
|
"text": "IAnalyticsClient"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.createAnalytics.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [
|
|
"The initial context to create the client {@link AnalyticsClientInitContext }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AnalyticsClientInitContext",
|
|
"text": "AnalyticsClientInitContext"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AnalyticsClientInitContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AnalyticsClientInitContext",
|
|
"description": [
|
|
"\nGeneral settings of the analytics client"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AnalyticsClientInitContext.isDev",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isDev",
|
|
"description": [
|
|
"\nBoolean indicating if it's running in developer mode."
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AnalyticsClientInitContext.sendTo",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sendTo",
|
|
"description": [
|
|
"\nSpecify if the shippers should send their data to the production or staging environments."
|
|
],
|
|
"signature": [
|
|
"\"staging\" | \"production\""
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AnalyticsClientInitContext.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [
|
|
"\nApplication-provided logger."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "server",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-server.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ContextProviderOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ContextProviderOpts",
|
|
"description": [
|
|
"\nDefinition of a context provider"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.ContextProviderOpts",
|
|
"text": "ContextProviderOpts"
|
|
},
|
|
"<Context>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ContextProviderOpts.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nThe name of the provider."
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ContextProviderOpts.context$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context$",
|
|
"description": [
|
|
"\nObservable that emits the custom context."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<Context>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ContextProviderOpts.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema declaring and documenting the expected output in the context$\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<Context>]: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaValue",
|
|
"text": "SchemaValue"
|
|
},
|
|
"<Context[Key]>; }"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.Event",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Event",
|
|
"description": [
|
|
"\nDefinition of the full event structure"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.Event",
|
|
"text": "Event"
|
|
},
|
|
"<Properties>"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.Event.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [
|
|
"\nThe time the event was generated in ISO format."
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.Event.event_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "event_type",
|
|
"description": [
|
|
"\nThe event type."
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.Event.properties",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [
|
|
"\nThe specific properties of the event type."
|
|
],
|
|
"signature": [
|
|
"Properties"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.Event.context",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"\nThe {@link EventContext} enriched during the processing pipeline."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.EventContext",
|
|
"text": "EventContext"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EventContext",
|
|
"description": [
|
|
"\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}."
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.cluster_uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cluster_uuid",
|
|
"description": [
|
|
"\nThe UUID of the cluster"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.cluster_name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cluster_name",
|
|
"description": [
|
|
"\nThe name of the cluster."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.license_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "license_id",
|
|
"description": [
|
|
"\nThe license ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.userId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "userId",
|
|
"description": [
|
|
"\nThe unique user ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.cloudId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudId",
|
|
"description": [
|
|
"\nThe Cloud ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.isElasticCloudUser",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isElasticCloudUser",
|
|
"description": [
|
|
"\n`true` if the user is logged in via the Elastic Cloud authentication provider."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThe product's version."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.pageName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pageName",
|
|
"description": [
|
|
"\nThe name of the current page."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.applicationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "applicationId",
|
|
"description": [
|
|
"\nThe current application ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.entityId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "entityId",
|
|
"description": [
|
|
"\nThe current entity ID (dashboard ID, visualization ID, etc.)."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventContext.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: unknown",
|
|
"description": [
|
|
"\nAdditional keys are allowed."
|
|
],
|
|
"signature": [
|
|
"[key: string]: unknown"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventTypeOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EventTypeOpts",
|
|
"description": [
|
|
"\nDefinition of an Event Type."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.EventTypeOpts",
|
|
"text": "EventTypeOpts"
|
|
},
|
|
"<EventTypeData>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventTypeOpts.eventType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "eventType",
|
|
"description": [
|
|
"\nThe event type's unique name."
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventTypeOpts.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema declaring and documenting the expected structure of this event type.\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<EventTypeData>]: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaValue",
|
|
"text": "SchemaValue"
|
|
},
|
|
"<EventTypeData[Key]>; }"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IAnalyticsClient",
|
|
"description": [
|
|
"\nAnalytics client's public APIs"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.reportEvent",
|
|
"type": "Function",
|
|
"tags": [
|
|
"track-adoption"
|
|
],
|
|
"label": "reportEvent",
|
|
"description": [
|
|
"\nReports a telemetry event."
|
|
],
|
|
"signature": [
|
|
"<EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": true,
|
|
"references": [
|
|
{
|
|
"plugin": "@kbn/ebt-tools",
|
|
"path": "packages/kbn-ebt-tools/src/performance_metric_events/helpers.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_clicks.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-server-internal",
|
|
"path": "packages/core/root/core-root-server-internal/src/server.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/analytics/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/analytics/types.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/analytics/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "fleet",
|
|
"path": "x-pack/plugins/fleet/server/services/fleet_usage_sender.ts"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-mocks",
|
|
"path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-mocks",
|
|
"path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/analytics/analytics.stub.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-root-browser-internal",
|
|
"path": "packages/core/root/core-root-browser-internal/src/core_system.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-mocks",
|
|
"path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-mocks",
|
|
"path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/analytics/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/analytics/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-mocks",
|
|
"path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.test.mocks.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_clicks.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_clicks.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_clicks.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_clicks.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.test.mocks.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.reportEvent.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "eventType",
|
|
"description": [
|
|
"The event type registered via the `registerEventType` API."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.reportEvent.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "eventData",
|
|
"description": [
|
|
"The properties matching the schema declared in the `registerEventType` API."
|
|
],
|
|
"signature": [
|
|
"EventTypeData"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerEventType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEventType",
|
|
"description": [
|
|
"\nRegisters the event type that will be emitted via the reportEvent API."
|
|
],
|
|
"signature": [
|
|
"<EventTypeData>(eventTypeOps: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.EventTypeOpts",
|
|
"text": "EventTypeOpts"
|
|
},
|
|
"<EventTypeData>) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerEventType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "eventTypeOps",
|
|
"description": [
|
|
"The definition of the event type {@link EventTypeOpts }."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.EventTypeOpts",
|
|
"text": "EventTypeOpts"
|
|
},
|
|
"<EventTypeData>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerShipper",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerShipper",
|
|
"description": [
|
|
"\nSet up the shipper that will be used to report the telemetry events."
|
|
],
|
|
"signature": [
|
|
"<Shipper extends ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.IShipper",
|
|
"text": "IShipper"
|
|
},
|
|
", ShipperConfig>(Shipper: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.ShipperClassConstructor",
|
|
"text": "ShipperClassConstructor"
|
|
},
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.RegisterShipperOpts",
|
|
"text": "RegisterShipperOpts"
|
|
},
|
|
" | undefined) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerShipper.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "Shipper",
|
|
"description": [
|
|
"The {@link IShipper } class to instantiate the shipper."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.ShipperClassConstructor",
|
|
"text": "ShipperClassConstructor"
|
|
},
|
|
"<Shipper, ShipperConfig>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerShipper.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "shipperConfig",
|
|
"description": [
|
|
"The config specific to the Shipper to instantiate."
|
|
],
|
|
"signature": [
|
|
"ShipperConfig"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerShipper.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [
|
|
"Additional options to register the shipper {@link RegisterShipperOpts }."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.RegisterShipperOpts",
|
|
"text": "RegisterShipperOpts"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled."
|
|
],
|
|
"signature": [
|
|
"(optInConfig: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.OptInConfig",
|
|
"text": "OptInConfig"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.optIn.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optInConfig",
|
|
"description": [
|
|
"{@link OptInConfig }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.OptInConfig",
|
|
"text": "OptInConfig"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerContextProvider",
|
|
"type": "Function",
|
|
"tags": [
|
|
"track-adoption"
|
|
],
|
|
"label": "registerContextProvider",
|
|
"description": [
|
|
"\nRegisters the context provider to enrich any reported events."
|
|
],
|
|
"signature": [
|
|
"<Context>(contextProviderOpts: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.ContextProviderOpts",
|
|
"text": "ContextProviderOpts"
|
|
},
|
|
"<Context>) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": true,
|
|
"references": [
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-execution-context-browser-internal",
|
|
"path": "packages/core/execution-context/core-execution-context-browser-internal/src/execution_context_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-elasticsearch-server-internal",
|
|
"path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/register_analytics_context_provider.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-environment-server-internal",
|
|
"path": "packages/core/environment/core-environment-server-internal/src/environment_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-plugins-server-internal",
|
|
"path": "packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts"
|
|
},
|
|
{
|
|
"plugin": "licensing",
|
|
"path": "x-pack/plugins/licensing/common/register_analytics_context_provider.ts"
|
|
},
|
|
{
|
|
"plugin": "cloud",
|
|
"path": "x-pack/plugins/cloud/common/register_cloud_deployment_id_analytics_context.ts"
|
|
},
|
|
{
|
|
"plugin": "telemetry",
|
|
"path": "src/plugins/telemetry/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.ts"
|
|
},
|
|
{
|
|
"plugin": "telemetry",
|
|
"path": "src/plugins/telemetry/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-mocks",
|
|
"path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/analytics/register_user_context.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-execution-context-browser-internal",
|
|
"path": "packages/core/execution-context/core-execution-context-browser-internal/src/execution_context_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-execution-context-browser-internal",
|
|
"path": "packages/core/execution-context/core-execution-context-browser-internal/src/execution_context_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-mocks",
|
|
"path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-mocks",
|
|
"path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-elasticsearch-server-internal",
|
|
"path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/register_analytics_context_provider.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-status-server-internal",
|
|
"path": "packages/core/status/core-status-server-internal/src/status_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.test.mocks.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-browser-internal",
|
|
"path": "packages/core/analytics/core-analytics-browser-internal/src/track_viewport_size.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.test.mocks.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-analytics-server-internal",
|
|
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.test.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.registerContextProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contextProviderOpts",
|
|
"description": [
|
|
"{@link ContextProviderOpts }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.ContextProviderOpts",
|
|
"text": "ContextProviderOpts"
|
|
},
|
|
"<Context>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.removeContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeContextProvider",
|
|
"description": [
|
|
"\nRemoves the context provider and stop enriching the events from its context."
|
|
],
|
|
"signature": [
|
|
"(contextProviderName: string) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.removeContextProvider.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "contextProviderName",
|
|
"description": [
|
|
"The name of the context provider to remove."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"\nObservable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.TelemetryCounter",
|
|
"text": "TelemetryCounter"
|
|
},
|
|
">"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IAnalyticsClient.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nStops the client."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IShipper",
|
|
"description": [
|
|
"\nBasic structure of a Shipper"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.reportEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportEvents",
|
|
"description": [
|
|
"\nAdapts and ships the event to the persisting/analytics solution."
|
|
],
|
|
"signature": [
|
|
"(events: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.Event",
|
|
"text": "Event"
|
|
},
|
|
"<Record<string, unknown>>[]) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.reportEvents.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "events",
|
|
"description": [
|
|
"batched events {@link Event }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.Event",
|
|
"text": "Event"
|
|
},
|
|
"<Record<string, unknown>>[]"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nStops/restarts the shipping mechanism based on the value of isOptedIn"
|
|
],
|
|
"signature": [
|
|
"(isOptedIn: boolean) => void"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.optIn.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isOptedIn",
|
|
"description": [
|
|
"`true` for resume sending events. `false` to stop."
|
|
],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.extendContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extendContext",
|
|
"description": [
|
|
"\nPerform any necessary calls to the persisting/analytics solution to set the event's context."
|
|
],
|
|
"signature": [
|
|
"((newContext: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.EventContext",
|
|
"text": "EventContext"
|
|
},
|
|
") => void) | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.extendContext.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newContext",
|
|
"description": [
|
|
"The full new context to set {@link EventContext }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.EventContext",
|
|
"text": "EventContext"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"\nObservable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.TelemetryCounter",
|
|
"text": "TelemetryCounter"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.IShipper.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nShutdown the shipper."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "packages/analytics/client/src/shippers/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.OptInConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OptInConfig",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.OptInConfig.global",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "global",
|
|
"description": [
|
|
"\nControls the global enabled/disabled behaviour of the client and shippers."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.OptInConfigPerType",
|
|
"text": "OptInConfigPerType"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.OptInConfig.event_types",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "event_types",
|
|
"description": [
|
|
"\nControls if an event type should be disabled for a specific type of shipper."
|
|
],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.OptInConfigPerType",
|
|
"text": "OptInConfigPerType"
|
|
},
|
|
" | undefined> | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.OptInConfigPerType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OptInConfigPerType",
|
|
"description": [
|
|
"\nSets whether a type of event is enabled/disabled globally or per shipper."
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.OptInConfigPerType.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [
|
|
"\nThe event type is globally enabled."
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.OptInConfigPerType.shippers",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "shippers",
|
|
"description": [
|
|
"\nControls if an event type should be disabled for a specific type of shipper."
|
|
],
|
|
"signature": [
|
|
"Record<string, boolean | undefined> | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.RegisterShipperOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegisterShipperOpts",
|
|
"description": [
|
|
"\nOptional options to register a shipper"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaArray",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SchemaArray",
|
|
"description": [
|
|
"\nSchema to represent an array"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaArray",
|
|
"text": "SchemaArray"
|
|
},
|
|
"<Value, Base> extends ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMeta",
|
|
"text": "SchemaMeta"
|
|
},
|
|
"<Base>"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaArray.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The type must be an array"
|
|
],
|
|
"signature": [
|
|
"\"array\""
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaArray.items",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "items",
|
|
"description": [
|
|
"The schema of the items in the array is defined in the `items` property"
|
|
],
|
|
"signature": [
|
|
"{ type: \"pass_through\"; _meta: { description: string; } & ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMetaOptional",
|
|
"text": "SchemaMetaOptional"
|
|
},
|
|
"<Value>; } | (unknown extends Value ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaArray",
|
|
"text": "SchemaArray"
|
|
},
|
|
"<Value, Value> | ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaObject",
|
|
"text": "SchemaObject"
|
|
},
|
|
"<Value> | ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value> : NonNullable<Value> extends (infer U)[] | readonly (infer U)[] ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaArray",
|
|
"text": "SchemaArray"
|
|
},
|
|
"<U, Value> : NonNullable<Value> extends Date ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value> : NonNullable<Value> extends object ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaObject",
|
|
"text": "SchemaObject"
|
|
},
|
|
"<Value> : ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value>)"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaChildValue",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SchemaChildValue",
|
|
"description": [
|
|
"\nSchema to define a primitive value"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value>"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaChildValue.type",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The type of the value"
|
|
],
|
|
"signature": [
|
|
"NonNullable<Value> extends string | Date ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AllowedSchemaStringTypes",
|
|
"text": "AllowedSchemaStringTypes"
|
|
},
|
|
" : NonNullable<Value> extends number ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AllowedSchemaNumberTypes",
|
|
"text": "AllowedSchemaNumberTypes"
|
|
},
|
|
" : NonNullable<Value> extends boolean ? \"boolean\" : ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AllowedSchemaTypes",
|
|
"text": "AllowedSchemaTypes"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaChildValue._meta",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "_meta",
|
|
"description": [
|
|
"Meta properties of the value: description and is optional"
|
|
],
|
|
"signature": [
|
|
"{ description: string; } & ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMetaOptional",
|
|
"text": "SchemaMetaOptional"
|
|
},
|
|
"<Value>"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaMeta",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SchemaMeta",
|
|
"description": [
|
|
"\nSchema meta with optional description"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMeta",
|
|
"text": "SchemaMeta"
|
|
},
|
|
"<Value>"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaMeta._meta",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "_meta",
|
|
"description": [
|
|
"Meta properties of the pass through: description and is optional"
|
|
],
|
|
"signature": [
|
|
"({ description?: string | undefined; } & ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMetaOptional",
|
|
"text": "SchemaMetaOptional"
|
|
},
|
|
"<Value>) | undefined"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SchemaObject",
|
|
"description": [
|
|
"\nSchema to represent an object"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaObject",
|
|
"text": "SchemaObject"
|
|
},
|
|
"<Value> extends ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMeta",
|
|
"text": "SchemaMeta"
|
|
},
|
|
"<Value>"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaObject.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [
|
|
"\nThe schemas of the keys of the object are defined in the `properties` object."
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<Value>]: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaValue",
|
|
"text": "SchemaValue"
|
|
},
|
|
"<Value[Key]>; }"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ShipperClassConstructor",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShipperClassConstructor",
|
|
"description": [
|
|
"\nConstructor of a {@link IShipper}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.ShipperClassConstructor",
|
|
"text": "ShipperClassConstructor"
|
|
},
|
|
"<Shipper, Config>"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ShipperClassConstructor.shipperName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "shipperName",
|
|
"description": [
|
|
"\nThe shipper's unique name"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ShipperClassConstructor.new",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "new",
|
|
"description": [
|
|
"\nThe constructor"
|
|
],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ShipperClassConstructor.new.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [
|
|
"The shipper's custom config"
|
|
],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ShipperClassConstructor.new.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [
|
|
"Common context {@link AnalyticsClientInitContext }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AnalyticsClientInitContext",
|
|
"text": "AnalyticsClientInitContext"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TelemetryCounter",
|
|
"description": [
|
|
"\nShape of the events emitted by the telemetryCounter$ observable"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounter.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\n{@link TelemetryCounterType}"
|
|
],
|
|
"signature": [
|
|
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounter.source",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [
|
|
"\nWho emitted the event? It can be \"client\" or the name of the shipper."
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounter.event_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "event_type",
|
|
"description": [
|
|
"\nThe event type the success/failure/drop event refers to."
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounter.code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "code",
|
|
"description": [
|
|
"\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounter.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [
|
|
"\nThe number of events that this counter refers to."
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AllowedSchemaBooleanTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AllowedSchemaBooleanTypes",
|
|
"description": [
|
|
"Types matching boolean values"
|
|
],
|
|
"signature": [
|
|
"\"boolean\""
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AllowedSchemaNumberTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AllowedSchemaNumberTypes",
|
|
"description": [
|
|
"Types matching number values"
|
|
],
|
|
"signature": [
|
|
"\"date\" | \"long\" | \"double\" | \"short\" | \"byte\" | \"float\" | \"integer\""
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AllowedSchemaStringTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AllowedSchemaStringTypes",
|
|
"description": [
|
|
"Types matching string values"
|
|
],
|
|
"signature": [
|
|
"\"date\" | \"keyword\" | \"text\""
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.AllowedSchemaTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AllowedSchemaTypes",
|
|
"description": [
|
|
"\nPossible type values in the schema"
|
|
],
|
|
"signature": [
|
|
"\"boolean\" | \"date\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"short\" | \"byte\" | \"float\" | \"integer\""
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.EventType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EventType",
|
|
"description": [
|
|
"\nEvent Type used for indexed structures. Only used to improve the readability of the types"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.PossibleSchemaTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PossibleSchemaTypes",
|
|
"description": [
|
|
"\nHelper to ensure the declared types match the schema types"
|
|
],
|
|
"signature": [
|
|
"Value extends string | Date ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AllowedSchemaStringTypes",
|
|
"text": "AllowedSchemaStringTypes"
|
|
},
|
|
" : Value extends number ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AllowedSchemaNumberTypes",
|
|
"text": "AllowedSchemaNumberTypes"
|
|
},
|
|
" : Value extends boolean ? \"boolean\" : ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.AllowedSchemaTypes",
|
|
"text": "AllowedSchemaTypes"
|
|
}
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.RootSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RootSchema",
|
|
"description": [
|
|
"\nSchema definition to match the structure of the properties provided.\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<Base>]: ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaValue",
|
|
"text": "SchemaValue"
|
|
},
|
|
"<Base[Key]>; }"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaMetaOptional",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SchemaMetaOptional",
|
|
"description": [
|
|
"\nEnforces { optional: true } if the value can be undefined"
|
|
],
|
|
"signature": [
|
|
"unknown extends Value ? { optional?: boolean | undefined; } : undefined extends Value ? { optional: true; } : { optional?: false | undefined; }"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.SchemaValue",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SchemaValue",
|
|
"description": [
|
|
"\nType that defines all the possible values that the Schema accepts.\nThese types definitions are helping to identify earlier the possible missing `properties` nesting when\nmanually defining the schemas."
|
|
],
|
|
"signature": [
|
|
"{ type: \"pass_through\"; _meta: { description: string; } & ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaMetaOptional",
|
|
"text": "SchemaMetaOptional"
|
|
},
|
|
"<Value>; } | (unknown extends Value ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaArray",
|
|
"text": "SchemaArray"
|
|
},
|
|
"<unknown, Value> | ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaObject",
|
|
"text": "SchemaObject"
|
|
},
|
|
"<Value> | ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value> : NonNullable<Value> extends (infer U)[] | readonly (infer U)[] ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaArray",
|
|
"text": "SchemaArray"
|
|
},
|
|
"<U, Value> : NonNullable<Value> extends Date ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value> : NonNullable<Value> extends object ? ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaObject",
|
|
"text": "SchemaObject"
|
|
},
|
|
"<Value> : ",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.SchemaChildValue",
|
|
"text": "SchemaChildValue"
|
|
},
|
|
"<Value>)"
|
|
],
|
|
"path": "packages/analytics/client/src/schema/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.ShipperName",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ShipperName",
|
|
"description": [
|
|
"\nShipper Name used for indexed structures. Only used to improve the readability of the types"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/analytics/client/src/analytics_client/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/analytics-client",
|
|
"id": "def-common.TelemetryCounterType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TelemetryCounterType",
|
|
"description": [
|
|
"\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason."
|
|
],
|
|
"signature": [
|
|
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
|
|
],
|
|
"path": "packages/analytics/client/src/events/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |