2021-03-03 04:02:17 +01:00
{
"id" : "usageCollection" ,
"client" : {
"classes" : [ ] ,
"functions" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.TrackApplicationView" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [
"constructor"
] ,
"label" : "TrackApplicationView" ,
"description" : [
"\nReact component to track the number of clicks and minutes on screen of the children components."
] ,
"signature" : [
"(props: React.PropsWithChildren<" ,
{
"pluginId" : "usageCollection" ,
"scope" : "public" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-public.TrackApplicationViewProps" ,
"text" : "TrackApplicationViewProps"
} ,
">) => JSX.Element"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx" ,
"lineNumber" : 23
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-04-15 17:36:10 +02:00
"id" : "def-public.TrackApplicationView.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "props" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"React.PropsWithChildren<" ,
2021-05-04 13:32:11 +02:00
{
"pluginId" : "usageCollection" ,
"scope" : "public" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-public.TrackApplicationViewProps" ,
"text" : "TrackApplicationViewProps"
} ,
2021-03-03 04:02:17 +01:00
">"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 23
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"isRequired" : true
2021-03-03 04:02:17 +01:00
}
] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
}
] ,
2021-05-04 13:32:11 +02:00
"interfaces" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-public.TrackApplicationViewProps" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "TrackApplicationViewProps" ,
"description" : [
"\nProps to provide to the {@link TrackApplicationView} component."
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/public/components/track_application_view/types.ts" ,
"lineNumber" : 15
} ,
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-public.TrackApplicationViewProps.viewId" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "viewId" ,
"description" : [
"\nThe name of the view to be tracked. The appId will be obtained automatically."
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/components/track_application_view/types.ts" ,
"lineNumber" : 20
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-public.TrackApplicationViewProps.children" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "children" ,
"description" : [
"\nThe React component to be tracked."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
2021-05-06 21:29:47 +02:00
] ,
2021-05-04 13:32:11 +02:00
"source" : {
"path" : "src/plugins/usage_collection/public/components/track_application_view/types.ts" ,
"lineNumber" : 25
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-05-04 13:32:11 +02:00
}
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
}
] ,
2021-05-04 13:32:11 +02:00
"enums" : [ ] ,
2021-03-03 04:02:17 +01:00
"misc" : [ ] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UsageCollectionSetup" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "UsageCollectionSetup" ,
2021-05-04 13:32:11 +02:00
"description" : [
"Public's setup APIs exposed by the UsageCollection Service"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 36
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UsageCollectionSetup.components" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "components" ,
2021-05-04 13:32:11 +02:00
"description" : [
"Component helpers to track usage collection in the UI"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"{ ApplicationUsageTrackingProvider: React.FC<{}>; }"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
2021-05-04 13:32:11 +02:00
"lineNumber" : 38
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UsageCollectionSetup.reportUiCounter" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "reportUiCounter" ,
2021-05-04 13:32:11 +02:00
"description" : [
"Report whenever a UI event occurs for UI counters to report it"
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(appName: string, type: " ,
"UiCounterMetricType" ,
", eventNames: string | string[], count?: number | undefined) => void"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 75
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.appName" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "appName" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 76
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.type" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "type" ,
"description" : [ ] ,
"signature" : [
"METRIC_TYPE" ,
".COUNT | " ,
"METRIC_TYPE" ,
".LOADED | " ,
"METRIC_TYPE" ,
".CLICK"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 77
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.eventNames" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "eventNames" ,
"description" : [ ] ,
"signature" : [
"string | string[]"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 78
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.count" ,
"type" : "number" ,
"tags" : [ ] ,
"label" : "count" ,
"description" : [ ] ,
"signature" : [
"number | undefined"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 79
} ,
"deprecated" : false
}
]
2021-03-03 04:02:17 +01:00
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UsageCollectionStart" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "UsageCollectionStart" ,
2021-05-04 13:32:11 +02:00
"description" : [
"Public's start APIs exposed by the UsageCollection Service"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 84
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UsageCollectionStart.reportUiCounter" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "reportUiCounter" ,
2021-05-04 13:32:11 +02:00
"description" : [
"Report whenever a UI event occurs for UI counters to report it"
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"(appName: string, type: " ,
"UiCounterMetricType" ,
", eventNames: string | string[], count?: number | undefined) => void"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 86
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.appName" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "appName" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 87
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.type" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "type" ,
"description" : [ ] ,
"signature" : [
"METRIC_TYPE" ,
".COUNT | " ,
"METRIC_TYPE" ,
".LOADED | " ,
"METRIC_TYPE" ,
".CLICK"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 88
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.eventNames" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "eventNames" ,
"description" : [ ] ,
"signature" : [
"string | string[]"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 89
} ,
"deprecated" : false
} ,
{
"parentPluginId" : "usageCollection" ,
"id" : "def-public.count" ,
"type" : "number" ,
"tags" : [ ] ,
"label" : "count" ,
"description" : [ ] ,
"signature" : [
"number | undefined"
] ,
"source" : {
"path" : "src/plugins/usage_collection/public/plugin.tsx" ,
"lineNumber" : 90
} ,
"deprecated" : false
}
]
2021-03-03 04:02:17 +01:00
}
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
2021-05-04 13:32:11 +02:00
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.ICollector" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "ICollector" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nCommon interface for Usage and Stats Collectors"
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
2021-05-04 13:32:11 +02:00
"section" : "def-server.ICollector" ,
"text" : "ICollector"
2021-03-03 04:02:17 +01:00
} ,
"<TFetchReturn, ExtraOptions>"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 171
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.ICollector.log" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "log" ,
"description" : [
"Logger"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"Logger"
] ,
2021-05-04 13:32:11 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 173
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.ICollector.extendFetchContext" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "extendFetchContext" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nThe options to extend the context provided to the `fetch` method: {@link CollectorOptionsFetchExtendedContext}."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-06-07 23:55:35 +02:00
"ICollectorOptionsFetchExtendedContext" ,
"<boolean> | (" ,
"ICollectorOptionsFetchExtendedContext" ,
"<boolean> & Required<Pick<" ,
"ICollectorOptionsFetchExtendedContext" ,
"<true>, \"kibanaRequest\">>)"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 178
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.ICollector.type" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "type" ,
2021-05-04 13:32:11 +02:00
"description" : [
"The registered type (aka name) of the collector"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 180
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.ICollector.fetch" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "fetch" ,
"description" : [
"\nThe actual logic that reports the Usage collection.\nIt will be called on every collection request.\nWhatever is returned in this method will be passed through as-is under\nthe {@link ICollector.type} key.\n"
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-06-07 23:55:35 +02:00
"(this: " ,
2021-05-04 13:32:11 +02:00
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
2021-06-07 23:55:35 +02:00
"section" : "def-server.ICollector" ,
"text" : "ICollector"
2021-05-04 13:32:11 +02:00
} ,
2021-06-07 23:55:35 +02:00
"<TFetchReturn, {}> & ExtraOptions, context: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorFetchContext" ,
"text" : "CollectorFetchContext"
} ,
"<boolean>) => TFetchReturn | Promise<TFetchReturn>"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 192
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.context" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "context" ,
"description" : [ ] ,
"signature" : [
"{ esClient: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.ElasticsearchClient" ,
"text" : "ElasticsearchClient"
} ,
"; soClient: Pick<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsClient" ,
"text" : "SavedObjectsClient"
} ,
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; } & (WithKibanaRequest extends true ? { kibanaRequest?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any> | undefined; } : {})"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 110
} ,
"deprecated" : false
}
]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.ICollector.isReady" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "isReady" ,
"description" : [
"\nShould return `true` when it's safe to call the `fetch` method."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"() => boolean | Promise<boolean>"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 196
2021-03-03 04:02:17 +01:00
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [ ]
2021-05-04 13:32:11 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.IncrementCounterParams" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "IncrementCounterParams" ,
"description" : [
"\nDetails about the counter to be incremented"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 26
} ,
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.IncrementCounterParams.counterName" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "counterName" ,
"description" : [
"The name of the counter"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 28
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.IncrementCounterParams.counterType" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "counterType" ,
"description" : [
"The counter type (\"count\" by default)"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.IncrementCounterParams.incrementBy" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "incrementBy" ,
"description" : [
"Increment the counter by this number (1 if not specified)"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"number | undefined"
] ,
2021-05-04 13:32:11 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 32
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-05-04 13:32:11 +02:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.IUsageCounter" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "IUsageCounter" ,
"description" : [
"\nUsage Counter allows to keep track of any events that occur.\nBy calling {@link IUsageCounter.incrementCounter} devs can notify this\nAPI whenever the event happens."
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 40
} ,
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.IUsageCounter.incrementCounter" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "incrementCounter" ,
"description" : [
"\nNotifies the counter about a new event happening so it can increase the count internally."
2021-03-03 04:02:17 +01:00
] ,
2021-05-04 13:32:11 +02:00
"signature" : [
"(params: " ,
2021-03-03 04:02:17 +01:00
{
2021-05-04 13:32:11 +02:00
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.IncrementCounterParams" ,
"text" : "IncrementCounterParams"
2021-03-03 04:02:17 +01:00
} ,
2021-05-04 13:32:11 +02:00
") => void"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 45
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.params" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "params" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.IncrementCounterParams" ,
"text" : "IncrementCounterParams"
}
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/usage_counter.ts" ,
"lineNumber" : 45
} ,
"deprecated" : false
}
]
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
2021-05-04 13:32:11 +02:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCountersSavedObjectAttributes" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "UsageCountersSavedObjectAttributes" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nThe attributes stored in the UsageCounters' SavedObjects"
] ,
2021-05-04 13:32:11 +02:00
"signature" : [
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.UsageCountersSavedObjectAttributes" ,
"text" : "UsageCountersSavedObjectAttributes"
} ,
" extends " ,
"SavedObjectAttributes"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 21
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCountersSavedObjectAttributes.domainId" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "domainId" ,
"description" : [
"The domain ID registered in the Usage Counter"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 23
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCountersSavedObjectAttributes.counterName" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "counterName" ,
"description" : [
"The counter name"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 25
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCountersSavedObjectAttributes.counterType" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "counterType" ,
"description" : [
"The counter type"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 27
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCountersSavedObjectAttributes.count" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "count" ,
"description" : [
"Number of times the event has occurred"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 29
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.AllowedSchemaTypes" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "AllowedSchemaTypes" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nPossible type values in the schema"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-08 20:05:14 +02:00
"\"boolean\" | \"date\" | \"keyword\" | \"text\" | \"long\" | \"double\" | \"short\" | \"float\" | \"integer\" | \"byte\""
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 33
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CollectorFetchContext" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "CollectorFetchContext" ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nThe context for the `fetch` method: It includes the most commonly used clients in the collectors (ES and SO clients).\nBoth are scoped based on the request and the context:\n- When users are requesting a sample of data, it is scoped to their role to avoid exposing data they shouldn't read\n- When building the telemetry data payload to report to the remote cluster, the requests are scoped to the `kibana` internal user\n"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ esClient: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.ElasticsearchClient" ,
"text" : "ElasticsearchClient"
} ,
"; soClient: Pick<" ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsClient" ,
"text" : "SavedObjectsClient"
} ,
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; } & (WithKibanaRequest extends true ? { kibanaRequest?: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any> | undefined; } : {})"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 76
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
2021-05-04 13:32:11 +02:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.CollectorFetchMethod" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "CollectorFetchMethod" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nThe fetch method has the context of the Collector itself\n(this has access to all the properties of the collector like the logger)\nand the the first parameter is {@link CollectorFetchContext}."
] ,
"signature" : [
2021-06-07 23:55:35 +02:00
"(this: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.ICollector" ,
"text" : "ICollector"
} ,
"<TReturn, {}> & ExtraOptions, context: " ,
2021-05-04 13:32:11 +02:00
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorFetchContext" ,
"text" : "CollectorFetchContext"
} ,
"<WithKibanaRequest>) => TReturn | Promise<TReturn>"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 104
} ,
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.CollectorOptions" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "CollectorOptions" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nOptions to instantiate a collector"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ type: string; isReady: () => boolean | Promise<boolean>; schema?: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.MakeSchemaFrom" ,
"text" : "MakeSchemaFrom"
} ,
"<TFetchReturn> | undefined; fetch: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorFetchMethod" ,
"text" : "CollectorFetchMethod"
} ,
"<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorOptionsFetchExtendedContext" ,
"text" : "CollectorOptionsFetchExtendedContext"
} ,
"<WithKibanaRequest>; } : { extendFetchContext?: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorOptionsFetchExtendedContext" ,
"text" : "CollectorOptionsFetchExtendedContext"
} ,
"<WithKibanaRequest> | undefined; })"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 135
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.CollectorOptionsFetchExtendedContext" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "CollectorOptionsFetchExtendedContext" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nThe options to extend the context provided to the `fetch` method."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"ICollectorOptionsFetchExtendedContext" ,
"<WithKibanaRequest> & (WithKibanaRequest extends true ? Required<Pick<" ,
"ICollectorOptionsFetchExtendedContext" ,
"<WithKibanaRequest>, \"kibanaRequest\">> : {})"
2021-05-06 21:29:47 +02:00
] ,
2021-05-04 13:32:11 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 125
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.MakeSchemaFrom" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "MakeSchemaFrom" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nThe `schema` property in {@link CollectorOptions} must match the output of\nthe `fetch` method. This type helps ensure that is correct"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"{ [Key in keyof Required<Base>]: Required<Base>[Key] extends (infer U)[] ? { type: \"array\"; items: " ,
"RecursiveMakeSchemaFrom" ,
"<U>; } : " ,
"RecursiveMakeSchemaFrom" ,
"<Required<Base>[Key]>; }"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/collector/types.ts" ,
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.USAGE_COUNTERS_SAVED_OBJECT_TYPE" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "USAGE_COUNTERS_SAVED_OBJECT_TYPE" ,
"description" : [
"The Saved Objects type for Usage Counters"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"usage-counters\""
] ,
2021-05-04 13:32:11 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 38
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectorOptions" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "UsageCollectorOptions" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nSame as {@link CollectorOptions} but with the `schema` property enforced"
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-05-04 13:32:11 +02:00
"{ type: string; isReady: () => boolean | Promise<boolean>; schema?: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
2021-05-04 13:32:11 +02:00
"section" : "def-server.MakeSchemaFrom" ,
"text" : "MakeSchemaFrom"
2021-03-03 04:02:17 +01:00
} ,
2021-05-04 13:32:11 +02:00
"<TFetchReturn> | undefined; fetch: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
2021-05-04 13:32:11 +02:00
"section" : "def-server.CollectorFetchMethod" ,
"text" : "CollectorFetchMethod"
2021-03-03 04:02:17 +01:00
} ,
2021-05-04 13:32:11 +02:00
"<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
2021-05-04 13:32:11 +02:00
"section" : "def-server.CollectorOptionsFetchExtendedContext" ,
"text" : "CollectorOptionsFetchExtendedContext"
2021-03-03 04:02:17 +01:00
} ,
2021-05-04 13:32:11 +02:00
"<WithKibanaRequest>; } : { extendFetchContext?: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
2021-05-04 13:32:11 +02:00
"section" : "def-server.CollectorOptionsFetchExtendedContext" ,
"text" : "CollectorOptionsFetchExtendedContext"
} ,
2021-06-07 23:55:35 +02:00
"<WithKibanaRequest> | undefined; }) & Required<Pick<" ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorOptions" ,
"text" : "CollectorOptions"
} ,
"<TFetchReturn, boolean, {}>, \"schema\">>"
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/collector/usage_collector.ts" ,
"lineNumber" : 16
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCountersSavedObject" ,
2021-03-06 02:12:28 +01:00
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "UsageCountersSavedObject" ,
2021-05-04 13:32:11 +02:00
"description" : [
"\nThe structure of the SavedObjects of type \"usage-counters\""
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 23:55:35 +02:00
"SavedObject" ,
"<" ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.UsageCountersSavedObjectAttributes" ,
"text" : "UsageCountersSavedObjectAttributes"
} ,
">"
2021-05-06 21:29:47 +02:00
] ,
2021-03-06 02:12:28 +01:00
"source" : {
2021-05-04 13:32:11 +02:00
"path" : "src/plugins/usage_collection/server/usage_counters/saved_objects.ts" ,
"lineNumber" : 35
2021-03-06 02:12:28 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"initialIsOpen" : false
2021-03-03 04:02:17 +01:00
}
] ,
2021-05-04 13:32:11 +02:00
"objects" : [ ] ,
"setup" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectionSetup" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "UsageCollectionSetup" ,
"description" : [
"Server's setup APIs exposed by the UsageCollection Service"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 29
} ,
"deprecated" : false ,
2021-05-04 13:32:11 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectionSetup.createUsageCounter" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "createUsageCounter" ,
"description" : [
"\nCreates and registers a usage counter to collect daily aggregated plugin counter events"
] ,
"signature" : [
"(type: string) => " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.IUsageCounter" ,
"text" : "IUsageCounter"
}
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 33
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.type" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "type" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 33
} ,
"deprecated" : false
}
]
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectionSetup.getUsageCounterByType" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "getUsageCounterByType" ,
"description" : [
"\nReturns a usage counter by type"
] ,
"signature" : [
"(type: string) => " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.IUsageCounter" ,
"text" : "IUsageCounter"
} ,
" | undefined"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 37
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.type" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "type" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 37
} ,
"deprecated" : false
}
]
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectionSetup.makeUsageCollector" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "makeUsageCollector" ,
"description" : [
"\nCreates a usage collector to collect plugin telemetry data.\nregisterCollector must be called to connect the created collector with the service."
] ,
"signature" : [
"<TFetchReturn, WithKibanaRequest extends boolean = false, ExtraOptions extends object = {}>(options: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.UsageCollectorOptions" ,
"text" : "UsageCollectorOptions"
} ,
"<TFetchReturn, WithKibanaRequest, ExtraOptions>) => " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.ICollector" ,
"text" : "ICollector"
} ,
"<TFetchReturn, ExtraOptions>"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 42
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.options" ,
"type" : "CompoundType" ,
"tags" : [ ] ,
"label" : "options" ,
"description" : [ ] ,
"signature" : [
"{ type: string; isReady: () => boolean | Promise<boolean>; schema?: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.MakeSchemaFrom" ,
"text" : "MakeSchemaFrom"
} ,
"<TFetchReturn> | undefined; fetch: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorFetchMethod" ,
"text" : "CollectorFetchMethod"
} ,
"<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorOptionsFetchExtendedContext" ,
"text" : "CollectorOptionsFetchExtendedContext"
} ,
"<WithKibanaRequest>; } : { extendFetchContext?: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorOptionsFetchExtendedContext" ,
"text" : "CollectorOptionsFetchExtendedContext"
} ,
"<WithKibanaRequest> | undefined; }) & Required<Pick<" ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.CollectorOptions" ,
"text" : "CollectorOptions"
} ,
"<TFetchReturn, boolean, {}>, \"schema\">>"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 47
} ,
"deprecated" : false
}
]
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectionSetup.registerCollector" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "registerCollector" ,
"description" : [
"\nRegister a usage collector or a stats collector.\nUsed to connect the created collector to telemetry."
] ,
"signature" : [
"<TFetchReturn, ExtraOptions extends object>(collector: " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.ICollector" ,
"text" : "ICollector"
} ,
"<TFetchReturn, ExtraOptions>) => void"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 53
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.collector" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "collector" ,
"description" : [ ] ,
"signature" : [
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.ICollector" ,
"text" : "ICollector"
} ,
"<TFetchReturn, ExtraOptions>"
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 54
} ,
"deprecated" : false
}
]
2021-05-04 13:32:11 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "usageCollection" ,
2021-05-04 13:32:11 +02:00
"id" : "def-server.UsageCollectionSetup.getCollectorByType" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-04 13:32:11 +02:00
"label" : "getCollectorByType" ,
"description" : [
"\nReturns a usage collector by type"
] ,
"signature" : [
"<TFetchReturn, ExtraOptions extends object>(type: string) => " ,
{
"pluginId" : "usageCollection" ,
"scope" : "server" ,
"docId" : "kibUsageCollectionPluginApi" ,
"section" : "def-server.ICollector" ,
"text" : "ICollector"
} ,
"<TFetchReturn, ExtraOptions> | undefined"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 59
} ,
2021-06-07 23:55:35 +02:00
"deprecated" : false ,
"returnComment" : [ ] ,
"children" : [
{
"parentPluginId" : "usageCollection" ,
"id" : "def-server.type" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "type" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/usage_collection/server/plugin.ts" ,
"lineNumber" : 60
} ,
"deprecated" : false
}
]
2021-05-04 13:32:11 +02:00
}
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
}
2021-03-03 04:02:17 +01:00
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}