{ "id": "@kbn/ebt", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper", "type": "Class", "tags": [], "label": "ElasticV3BrowserShipper", "description": [ "\nElastic V3 shipper to use in the browser." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ElasticV3BrowserShipper", "text": "ElasticV3BrowserShipper" }, " implements ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.IShipper", "text": "IShipper" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.shipperName", "type": "string", "tags": [], "label": "shipperName", "description": [ "Shipper's unique name" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.telemetryCounter$", "type": "Object", "tags": [], "label": "telemetryCounter$", "description": [ "Observable to emit the stats of the processed events." ], "signature": [ "Subject", "<", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.TelemetryCounter", "text": "TelemetryCounter" }, ">" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [ "\nCreates a new instance of the {@link ElasticV3BrowserShipper}." ], "signature": [ "any" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.Unnamed.$1", "type": "Object", "tags": [], "label": "options", "description": [ "{@link ElasticV3ShipperOptions }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ElasticV3ShipperOptions", "text": "ElasticV3ShipperOptions" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.Unnamed.$2", "type": "Object", "tags": [], "label": "initContext", "description": [ "{@link AnalyticsClientInitContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.extendContext", "type": "Function", "tags": [], "label": "extendContext", "description": [ "\nUses the `cluster_uuid` and `license_id` from the context to hold them in memory for the generation of the headers\nused later on in the HTTP request." ], "signature": [ "(newContext: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" }, ") => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.extendContext.$1", "type": "Object", "tags": [], "label": "newContext", "description": [ "The full new context to set {@link EventContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.optIn", "type": "Function", "tags": [], "label": "optIn", "description": [ "\nWhen `false`, it flushes the internal queue and stops sending events." ], "signature": [ "(isOptedIn: boolean) => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.optIn.$1", "type": "boolean", "tags": [], "label": "isOptedIn", "description": [ "`true` for resume sending events. `false` to stop." ], "signature": [ "boolean" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.reportEvents", "type": "Function", "tags": [], "label": "reportEvents", "description": [ "\nEnqueues the events to be sent to in a batched approach." ], "signature": [ "(events: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]) => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.reportEvents.$1", "type": "Array", "tags": [], "label": "events", "description": [ "batched events {@link Event }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.flush", "type": "Function", "tags": [], "label": "flush", "description": [ "\nTriggers a flush of the internal queue to attempt to send any events held in the queue\nand resolves the returned promise once the queue is emptied." ], "signature": [ "() => Promise" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3BrowserShipper.shutdown", "type": "Function", "tags": [], "label": "shutdown", "description": [ "\nShuts down the shipper.\nTriggers a flush of the internal queue to attempt to send any events held in the queue." ], "signature": [ "() => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/browser/src/browser_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper", "type": "Class", "tags": [], "label": "ElasticV3ServerShipper", "description": [ "\nElastic V3 shipper to use on the server side." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ElasticV3ServerShipper", "text": "ElasticV3ServerShipper" }, " implements ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.IShipper", "text": "IShipper" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.shipperName", "type": "string", "tags": [], "label": "shipperName", "description": [ "Shipper's unique name" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.telemetryCounter$", "type": "Object", "tags": [], "label": "telemetryCounter$", "description": [ "Observable to emit the stats of the processed events." ], "signature": [ "Subject", "<", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.TelemetryCounter", "text": "TelemetryCounter" }, ">" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [ "\nCreates a new instance of the {@link ElasticV3ServerShipper}." ], "signature": [ "any" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.Unnamed.$1", "type": "Object", "tags": [], "label": "options", "description": [ "{@link ElasticV3ShipperOptions }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ElasticV3ShipperOptions", "text": "ElasticV3ShipperOptions" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.Unnamed.$2", "type": "Object", "tags": [], "label": "initContext", "description": [ "{@link AnalyticsClientInitContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.extendContext", "type": "Function", "tags": [], "label": "extendContext", "description": [ "\nUses the `cluster_uuid` and `license_id` from the context to hold them in memory for the generation of the headers\nused later on in the HTTP request." ], "signature": [ "(newContext: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" }, ") => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.extendContext.$1", "type": "Object", "tags": [], "label": "newContext", "description": [ "The full new context to set {@link EventContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" } ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.optIn", "type": "Function", "tags": [], "label": "optIn", "description": [ "\nWhen `false`, it flushes the internal queue and stops sending events." ], "signature": [ "(isOptedIn: boolean) => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.optIn.$1", "type": "boolean", "tags": [], "label": "isOptedIn", "description": [ "`true` for resume sending events. `false` to stop." ], "signature": [ "boolean" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.reportEvents", "type": "Function", "tags": [], "label": "reportEvents", "description": [ "\nEnqueues the events to be sent via the leaky bucket algorithm." ], "signature": [ "(events: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]) => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.reportEvents.$1", "type": "Array", "tags": [], "label": "events", "description": [ "batched events {@link Event }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.flush", "type": "Function", "tags": [], "label": "flush", "description": [ "\nTriggers a flush of the internal queue to attempt to send any events held in the queue\nand resolves the returned promise once the queue is emptied." ], "signature": [ "() => Promise" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ServerShipper.shutdown", "type": "Function", "tags": [], "label": "shutdown", "description": [ "\nShuts down the shipper.\nTriggers a flush of the internal queue to attempt to send any events held in the queue." ], "signature": [ "() => void" ], "path": "packages/analytics/ebt/shippers/elastic_v3/server/src/server_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper", "type": "Class", "tags": [], "label": "FullStoryShipper", "description": [ "\nFullStory shipper." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.FullStoryShipper", "text": "FullStoryShipper" }, " implements ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.IShipper", "text": "IShipper" } ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.shipperName", "type": "string", "tags": [], "label": "shipperName", "description": [ "Shipper's unique name" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [ "\nCreates a new instance of the FullStoryShipper." ], "signature": [ "any" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [ "{@link FullStoryShipperConfig }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.FullStoryShipperConfig", "text": "FullStoryShipperConfig" } ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.Unnamed.$2", "type": "Object", "tags": [], "label": "initContext", "description": [ "{@link AnalyticsClientInitContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" } ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.extendContext", "type": "Function", "tags": [], "label": "extendContext", "description": [ "\nCalls `fs.identify`, `fs.setUserVars` and `fs.setVars` depending on the fields provided in the newContext." ], "signature": [ "(newContext: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" }, ") => void" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.extendContext.$1", "type": "Object", "tags": [], "label": "newContext", "description": [ "The full new context to set {@link EventContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" } ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.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/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.optIn.$1", "type": "boolean", "tags": [], "label": "isOptedIn", "description": [ "`true` for resume sending events. `false` to stop." ], "signature": [ "boolean" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.reportEvents", "type": "Function", "tags": [], "label": "reportEvents", "description": [ "\nFilters the events by the eventTypesAllowlist from the config.\nThen it transforms the event into a FS valid format and calls `fs.event`." ], "signature": [ "(events: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]) => void" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.reportEvents.$1", "type": "Array", "tags": [], "label": "events", "description": [ "batched events {@link Event }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.flush", "type": "Function", "tags": [], "label": "flush", "description": [ "\nFlushes all internal queues of the shipper.\nIt doesn't really do anything inside because this shipper doesn't hold any internal queues." ], "signature": [ "() => Promise" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipper.shutdown", "type": "Function", "tags": [], "label": "shutdown", "description": [ "\nShuts down the shipper." ], "signature": [ "() => void" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.AnalyticsClientInitContext", "type": "Interface", "tags": [], "label": "AnalyticsClientInitContext", "description": [ "\nGeneral settings of the analytics client" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.AnalyticsClientInitContext.isDev", "type": "boolean", "tags": [], "label": "isDev", "description": [ "\nBoolean indicating if it's running in developer mode." ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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": [ "\"production\" | \"staging\"" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.AnalyticsClientInitContext.logger", "type": "Object", "tags": [], "label": "logger", "description": [ "\nApplication-provided logger." ], "signature": [ { "pluginId": "@kbn/logging", "scope": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.Logger", "text": "Logger" } ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ContextProviderOpts", "type": "Interface", "tags": [], "label": "ContextProviderOpts", "description": [ "\nDefinition of a context provider" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ContextProviderOpts", "text": "ContextProviderOpts" }, "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ContextProviderOpts.name", "type": "string", "tags": [], "label": "name", "description": [ "\nThe name of the provider." ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ContextProviderOpts.context$", "type": "Object", "tags": [], "label": "context$", "description": [ "\nObservable that emits the custom context." ], "signature": [ "Observable", "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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]: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ShipperOptions", "type": "Interface", "tags": [], "label": "ElasticV3ShipperOptions", "description": [ "\nOptions for the Elastic V3 shipper" ], "path": "packages/analytics/ebt/shippers/elastic_v3/common/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ShipperOptions.channelName", "type": "string", "tags": [], "label": "channelName", "description": [ "\nThe name of the channel to stream all the events to." ], "path": "packages/analytics/ebt/shippers/elastic_v3/common/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ShipperOptions.version", "type": "string", "tags": [], "label": "version", "description": [ "\nThe product's version." ], "path": "packages/analytics/ebt/shippers/elastic_v3/common/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ShipperOptions.sendTo", "type": "CompoundType", "tags": [], "label": "sendTo", "description": [ "\nProvide it to override the Analytics client's default configuration." ], "signature": [ "\"production\" | \"staging\" | undefined" ], "path": "packages/analytics/ebt/shippers/elastic_v3/common/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ElasticV3ShipperOptions.debug", "type": "CompoundType", "tags": [], "label": "debug", "description": [ "\nShould show debug information about the requests it makes to the V3 API." ], "signature": [ "boolean | undefined" ], "path": "packages/analytics/ebt/shippers/elastic_v3/common/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.Event", "type": "Interface", "tags": [], "label": "Event", "description": [ "\nDefinition of the full event structure" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, "" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.Event.timestamp", "type": "string", "tags": [], "label": "timestamp", "description": [ "\nThe time the event was generated in ISO format." ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.Event.event_type", "type": "string", "tags": [], "label": "event_type", "description": [ "\nThe event type." ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.Event.properties", "type": "Uncategorized", "tags": [], "label": "properties", "description": [ "\nThe specific properties of the event type." ], "signature": [ "Properties" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.Event.context", "type": "Object", "tags": [], "label": "context", "description": [ "\nThe {@link EventContext} enriched during the processing pipeline." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" } ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.cluster_uuid", "type": "string", "tags": [], "label": "cluster_uuid", "description": [ "\nThe UUID of the cluster" ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.cluster_name", "type": "string", "tags": [], "label": "cluster_name", "description": [ "\nThe name of the cluster." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.license_id", "type": "string", "tags": [], "label": "license_id", "description": [ "\nThe license ID." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.userId", "type": "string", "tags": [], "label": "userId", "description": [ "\nThe unique user ID." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.cloudId", "type": "string", "tags": [], "label": "cloudId", "description": [ "\nThe Cloud ID." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.version", "type": "string", "tags": [], "label": "version", "description": [ "\nThe product's version." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.pageName", "type": "string", "tags": [], "label": "pageName", "description": [ "\nThe name of the current page." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.applicationId", "type": "string", "tags": [], "label": "applicationId", "description": [ "\nThe current application ID." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventContext.Unnamed", "type": "IndexSignature", "tags": [], "label": "[key: string]: unknown", "description": [ "\nAdditional keys are allowed." ], "signature": [ "[key: string]: unknown" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.EventTypeOpts", "type": "Interface", "tags": [], "label": "EventTypeOpts", "description": [ "\nDefinition of an Event Type." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventTypeOpts", "text": "EventTypeOpts" }, "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.EventTypeOpts.eventType", "type": "string", "tags": [], "label": "eventType", "description": [ "\nThe event type's unique name." ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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]: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipperConfig", "type": "Interface", "tags": [], "label": "FullStoryShipperConfig", "description": [ "\nFullStory shipper configuration." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.FullStoryShipperConfig", "text": "FullStoryShipperConfig" }, " extends ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.FullStorySnippetConfig", "text": "FullStorySnippetConfig" } ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipperConfig.eventTypesAllowlist", "type": "Array", "tags": [], "label": "eventTypesAllowlist", "description": [ "\nFullStory's custom events rate limit is very aggressive.\nIf this setting is provided, it'll only send the event types specified in this list." ], "signature": [ "string[] | undefined" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStoryShipperConfig.pageVarsDebounceTimeMs", "type": "number", "tags": [], "label": "pageVarsDebounceTimeMs", "description": [ "\nFullStory only allows calling setVars('page') once per navigation.\nThis setting defines how much time to hold from calling the API while additional lazy context is being resolved." ], "signature": [ "number | undefined" ], "path": "packages/analytics/ebt/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStorySnippetConfig", "type": "Interface", "tags": [], "label": "FullStorySnippetConfig", "description": [ "\nFullStory basic configuration." ], "path": "packages/analytics/ebt/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStorySnippetConfig.fullStoryOrgId", "type": "string", "tags": [], "label": "fullStoryOrgId", "description": [ "\nThe FullStory account id." ], "path": "packages/analytics/ebt/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStorySnippetConfig.host", "type": "string", "tags": [], "label": "host", "description": [ "\nThe host to send the data to. Used to overcome AdBlockers by using custom DNSs.\nIf not specified, it defaults to `fullstory.com`." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStorySnippetConfig.scriptUrl", "type": "string", "tags": [], "label": "scriptUrl", "description": [ "\nThe URL to load the FullStory client from. Falls back to `edge.fullstory.com/s/fs.js` if not specified." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStorySnippetConfig.debug", "type": "CompoundType", "tags": [], "label": "debug", "description": [ "\nWhether the debug logs should be printed to the console." ], "signature": [ "boolean | undefined" ], "path": "packages/analytics/ebt/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.FullStorySnippetConfig.namespace", "type": "string", "tags": [], "label": "namespace", "description": [ "\nThe name of the variable where the API is stored: `window[namespace]`. Defaults to `FS`." ], "signature": [ "string | undefined" ], "path": "packages/analytics/ebt/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient", "type": "Interface", "tags": [], "label": "IAnalyticsClient", "description": [ "\nAnalytics client's public APIs" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.reportEvent", "type": "Function", "tags": [ "track-adoption" ], "label": "reportEvent", "description": [ "\nReports a telemetry event." ], "signature": [ "(eventType: string, eventData: EventTypeData) => void" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": true, "references": [ { "plugin": "@kbn/core-notifications-browser-internal", "path": "packages/core/notifications/core-notifications-browser-internal/src/toasts/telemetry/event_reporter.ts" }, { "plugin": "@kbn/core-notifications-browser-internal", "path": "packages/core/notifications/core-notifications-browser-internal/src/toasts/telemetry/event_reporter.ts" }, { "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/events/kibana_started.ts" }, { "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.ts" }, { "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.ts" }, { "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.ts" }, { "plugin": "actions", "path": "x-pack/plugins/actions/server/lib/action_executor.ts" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "@kbn/cloud", "path": "packages/cloud/connection_details/kibana/kibana_connection_details_provider.tsx" }, { "plugin": "observabilityAIAssistant", "path": "x-pack/plugins/observability_solution/observability_ai_assistant/server/utils/recall/recall_and_score.ts" }, { "plugin": "observabilityAIAssistant", "path": "x-pack/plugins/observability_solution/observability_ai_assistant/public/analytics/index.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": "integrationAssistant", "path": "x-pack/plugins/integration_assistant/public/services/telemetry/service.ts" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/telemetry/fleet_usage_sender.ts" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/telemetry/fleet_usage_sender.ts" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/telemetry/fleet_usage_sender.ts" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/telemetry/fleet_usage_sender.ts" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/telemetry/fleet_usage_sender.ts" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/telemetry/fleet_usage_sender.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_client.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_client.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_client.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_client.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/lib/langchain/elasticsearch_store/elasticsearch_store.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/lib/langchain/elasticsearch_store/elasticsearch_store.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/helpers.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/post_actions_connector_execute.ts" }, { "plugin": "globalSearchBar", "path": "x-pack/plugins/global_search_bar/public/telemetry/event_reporter.ts" }, { "plugin": "globalSearchBar", "path": "x-pack/plugins/global_search_bar/public/telemetry/event_reporter.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.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": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/upload_csv.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/upload_csv.ts" }, { "plugin": "reporting", "path": "x-pack/plugins/reporting/server/usage/event_tracker.ts" }, { "plugin": "searchPlayground", "path": "x-pack/plugins/search_playground/server/routes.ts" }, { "plugin": "securitySolutionServerless", "path": "x-pack/plugins/security_solution_serverless/server/task_manager/nlp_cleanup_task/nlp_cleanup_task.ts" }, { "plugin": "securitySolutionServerless", "path": "x-pack/plugins/security_solution_serverless/server/task_manager/nlp_cleanup_task/nlp_cleanup_task.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/services/telemetry/telemetry_client.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/services/telemetry/telemetry_client.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/services/telemetry/telemetry_client.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/services/telemetry/telemetry_client.ts" }, { "plugin": "observabilityLogsExplorer", "path": "x-pack/plugins/observability_solution/observability_logs_explorer/public/state_machines/observability_logs_explorer/src/telemetry_events.ts" }, { "plugin": "observabilityOnboarding", "path": "x-pack/plugins/observability_solution/observability_onboarding/public/hooks/use_flow_progress_telemetry.ts" }, { "plugin": "observabilityOnboarding", "path": "x-pack/plugins/observability_solution/observability_onboarding/public/application/app.tsx" }, { "plugin": "observabilityAIAssistant", "path": "x-pack/plugins/observability_solution/observability_ai_assistant/public/service/create_chat_service.test.ts" }, { "plugin": "@kbn/core-analytics-browser-mocks", "path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.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": "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": "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": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "elasticAssistant", "path": "x-pack/plugins/elastic_assistant/server/routes/attack_discovery/helpers.test.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "datasetQuality", "path": "x-pack/plugins/observability_solution/dataset_quality/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "infra", "path": "x-pack/plugins/observability_solution/infra/public/services/telemetry/telemetry_service.test.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_service.test.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_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": "actions", "path": "x-pack/plugins/actions/server/lib/action_executor.test.ts" }, { "plugin": "actions", "path": "x-pack/plugins/actions/server/lib/action_executor.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/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_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/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.registerEventType", "type": "Function", "tags": [], "label": "registerEventType", "description": [ "\nRegisters the event type that will be emitted via the reportEvent API." ], "signature": [ "(eventTypeOps: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventTypeOpts", "text": "EventTypeOpts" }, ") => void" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.registerEventType.$1", "type": "Object", "tags": [], "label": "eventTypeOps", "description": [ "The definition of the event type {@link EventTypeOpts }." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventTypeOpts", "text": "EventTypeOpts" }, "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "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: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ShipperClassConstructor", "text": "ShipperClassConstructor" }, ", shipperConfig: ShipperConfig, opts?: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.RegisterShipperOpts", "text": "RegisterShipperOpts" }, " | undefined) => void" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.registerShipper.$1", "type": "Object", "tags": [], "label": "Shipper", "description": [ "The {@link IShipper } class to instantiate the shipper." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ShipperClassConstructor", "text": "ShipperClassConstructor" }, "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.registerShipper.$3", "type": "Object", "tags": [], "label": "opts", "description": [ "Additional options to register the shipper {@link RegisterShipperOpts }." ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.RegisterShipperOpts", "text": "RegisterShipperOpts" }, " | undefined" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.OptInConfig", "text": "OptInConfig" }, ") => void" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.optIn.$1", "type": "Object", "tags": [], "label": "optInConfig", "description": [ "{@link OptInConfig }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.OptInConfig", "text": "OptInConfig" } ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.registerContextProvider", "type": "Function", "tags": [ "track-adoption" ], "label": "registerContextProvider", "description": [ "\nRegisters the context provider to enrich any reported events." ], "signature": [ "(contextProviderOpts: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ContextProviderOpts", "text": "ContextProviderOpts" }, ") => void" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": true, "references": [ { "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-application-browser-internal", "path": "packages/core/application/core-application-browser-internal/src/register_analytics_context_provider.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-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-chrome-browser-internal", "path": "packages/core/chrome/core-chrome-browser-internal/src/register_analytics_context_provider.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": "cloud", "path": "x-pack/plugins/cloud/common/register_cloud_deployment_id_analytics_context.ts" }, { "plugin": "licensing", "path": "x-pack/plugins/licensing/common/register_analytics_context_provider.ts" }, { "plugin": "security", "path": "x-pack/plugins/security/public/analytics/register_user_context.ts" }, { "plugin": "telemetry", "path": "src/plugins/telemetry/server/plugin.ts" }, { "plugin": "telemetry", "path": "src/plugins/telemetry/public/plugin.ts" }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_service.ts" }, { "plugin": "apm", "path": "x-pack/plugins/observability_solution/apm/public/analytics/register_service_inventory_view_type_context.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-application-browser-internal", "path": "packages/core/application/core-application-browser-internal/src/register_analytics_context_provider.test.ts" }, { "plugin": "@kbn/core-application-browser-internal", "path": "packages/core/application/core-application-browser-internal/src/register_analytics_context_provider.test.ts" }, { "plugin": "@kbn/core-application-browser-internal", "path": "packages/core/application/core-application-browser-internal/src/register_analytics_context_provider.test.ts" }, { "plugin": "@kbn/core-chrome-browser-internal", "path": "packages/core/chrome/core-chrome-browser-internal/src/register_analytics_context_provider.test.ts" }, { "plugin": "@kbn/core-chrome-browser-internal", "path": "packages/core/chrome/core-chrome-browser-internal/src/register_analytics_context_provider.test.ts" }, { "plugin": "@kbn/core-chrome-browser-internal", "path": "packages/core/chrome/core-chrome-browser-internal/src/register_analytics_context_provider.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/ebt", "id": "def-common.IAnalyticsClient.registerContextProvider.$1", "type": "Object", "tags": [], "label": "contextProviderOpts", "description": [ "{@link ContextProviderOpts }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ContextProviderOpts", "text": "ContextProviderOpts" }, "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.telemetryCounter$", "type": "Object", "tags": [], "label": "telemetryCounter$", "description": [ "\nObservable to emit the stats of the processed events." ], "signature": [ "Observable", "<", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.TelemetryCounter", "text": "TelemetryCounter" }, ">" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.flush", "type": "Function", "tags": [], "label": "flush", "description": [ "\nForces all shippers to send all their enqueued events and fulfills the returned promise." ], "signature": [ "() => Promise" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IAnalyticsClient.shutdown", "type": "Function", "tags": [], "label": "shutdown", "description": [ "\nStops the client. Flushing any pending events in the process." ], "signature": [ "() => Promise" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IShipper", "type": "Interface", "tags": [], "label": "IShipper", "description": [ "\nBasic structure of a Shipper" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]) => void" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.IShipper.reportEvents.$1", "type": "Array", "tags": [], "label": "events", "description": [ "batched events {@link Event }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.Event", "text": "Event" }, ">[]" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" }, ") => void) | undefined" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.IShipper.extendContext.$1", "type": "Object", "tags": [], "label": "newContext", "description": [ "The full new context to set {@link EventContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.EventContext", "text": "EventContext" } ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IShipper.telemetryCounter$", "type": "Object", "tags": [], "label": "telemetryCounter$", "description": [ "\nObservable to emit the stats of the processed events." ], "signature": [ "Observable", "<", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.TelemetryCounter", "text": "TelemetryCounter" }, "> | undefined" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IShipper.flush", "type": "Function", "tags": [], "label": "flush", "description": [ "\nSends all the enqueued events and fulfills the returned promise." ], "signature": [ "() => Promise" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/ebt", "id": "def-common.IShipper.shutdown", "type": "Function", "tags": [], "label": "shutdown", "description": [ "\nShutdown the shipper." ], "signature": [ "() => void" ], "path": "packages/analytics/ebt/client/src/shippers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.OptInConfig", "type": "Interface", "tags": [], "label": "OptInConfig", "description": [ "\nOptions for the optIn API" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.OptInConfigPerType", "text": "OptInConfigPerType" } ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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 | undefined" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.OptInConfigPerType.enabled", "type": "boolean", "tags": [], "label": "enabled", "description": [ "\nThe event type is globally enabled." ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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 | undefined" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.RegisterShipperOpts", "type": "Interface", "tags": [], "label": "RegisterShipperOpts", "description": [ "\nOptional options to register a shipper" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.SchemaArray", "type": "Interface", "tags": [], "label": "SchemaArray", "description": [ "\nSchema to represent an array" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaArray", "text": "SchemaArray" }, " extends ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMeta", "text": "SchemaMeta" }, "" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.SchemaArray.type", "type": "string", "tags": [], "label": "type", "description": [ "The type must be an array" ], "signature": [ "\"array\"" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "; } | (unknown extends Value ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaArray", "text": "SchemaArray" }, " | ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaObject", "text": "SchemaObject" }, " | ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, " : NonNullable extends (infer U)[] | readonly (infer U)[] ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaArray", "text": "SchemaArray" }, " : NonNullable extends Date ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, " : NonNullable extends object ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaObject", "text": "SchemaObject" }, " : ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, ")" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.SchemaChildValue", "type": "Interface", "tags": [], "label": "SchemaChildValue", "description": [ "\nSchema to define a primitive value" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, "" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.SchemaChildValue.type", "type": "Uncategorized", "tags": [], "label": "type", "description": [ "The type of the value" ], "signature": [ "NonNullable extends string | Date ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AllowedSchemaStringTypes", "text": "AllowedSchemaStringTypes" }, " : NonNullable extends number ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AllowedSchemaNumberTypes", "text": "AllowedSchemaNumberTypes" }, " : NonNullable extends boolean ? \"boolean\" : ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AllowedSchemaTypes", "text": "AllowedSchemaTypes" } ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.SchemaMeta", "type": "Interface", "tags": [], "label": "SchemaMeta", "description": [ "\nSchema meta with optional description" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMeta", "text": "SchemaMeta" }, "" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, ") | undefined" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.SchemaObject", "type": "Interface", "tags": [], "label": "SchemaObject", "description": [ "\nSchema to represent an object" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaObject", "text": "SchemaObject" }, " extends ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMeta", "text": "SchemaMeta" }, "" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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]: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ShipperClassConstructor", "type": "Interface", "tags": [], "label": "ShipperClassConstructor", "description": [ "\nConstructor of a {@link IShipper}" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.ShipperClassConstructor", "text": "ShipperClassConstructor" }, "" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ShipperClassConstructor.shipperName", "type": "string", "tags": [], "label": "shipperName", "description": [ "\nThe shipper's unique name" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ShipperClassConstructor.new", "type": "Function", "tags": [], "label": "new", "description": [ "\nThe constructor" ], "signature": [ "any" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.ShipperClassConstructor.new.$1", "type": "Uncategorized", "tags": [], "label": "config", "description": [ "The shipper's custom config" ], "signature": [ "Config" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ShipperClassConstructor.new.$2", "type": "Object", "tags": [], "label": "initContext", "description": [ "Common context {@link AnalyticsClientInitContext }" ], "signature": [ { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" } ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.TelemetryCounter", "type": "Interface", "tags": [], "label": "TelemetryCounter", "description": [ "\nShape of the events emitted by the telemetryCounter$ observable" ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.TelemetryCounter.count", "type": "number", "tags": [], "label": "count", "description": [ "\nThe number of events that this counter refers to." ], "path": "packages/analytics/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/ebt", "id": "def-common.AllowedSchemaBooleanTypes", "type": "Type", "tags": [], "label": "AllowedSchemaBooleanTypes", "description": [ "Types matching boolean values" ], "signature": [ "\"boolean\"" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.AllowedSchemaNumberTypes", "type": "Type", "tags": [], "label": "AllowedSchemaNumberTypes", "description": [ "Types matching number values" ], "signature": [ "\"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.AllowedSchemaStringTypes", "type": "Type", "tags": [], "label": "AllowedSchemaStringTypes", "description": [ "Types matching string values" ], "signature": [ "\"keyword\" | \"text\" | \"date\"" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.AllowedSchemaTypes", "type": "Type", "tags": [], "label": "AllowedSchemaTypes", "description": [ "\nPossible type values in the schema" ], "signature": [ "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "id": "def-common.ContextProviderName", "type": "Type", "tags": [], "label": "ContextProviderName", "description": [ "\nContextProviderName used for indexed structures. Only used to improve the readability of the types" ], "signature": [ "string" ], "path": "packages/analytics/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AllowedSchemaStringTypes", "text": "AllowedSchemaStringTypes" }, " : Value extends number ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AllowedSchemaNumberTypes", "text": "AllowedSchemaNumberTypes" }, " : Value extends boolean ? \"boolean\" : ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.AllowedSchemaTypes", "text": "AllowedSchemaTypes" } ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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]: ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "; } | (unknown extends Value ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaArray", "text": "SchemaArray" }, " | ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaObject", "text": "SchemaObject" }, " | ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, " : NonNullable extends (infer U)[] | readonly (infer U)[] ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaArray", "text": "SchemaArray" }, " : NonNullable extends Date ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, " : NonNullable extends object ? ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaObject", "text": "SchemaObject" }, " : ", { "pluginId": "@kbn/ebt", "scope": "common", "docId": "kibKbnEbtPluginApi", "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, ")" ], "path": "packages/analytics/ebt/client/src/schema/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/analytics_client/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ebt", "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/ebt/client/src/events/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }