1254 lines
46 KiB
JSON
1254 lines
46 KiB
JSON
{
|
|
"id": "usageCollection",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.TrackApplicationView",
|
|
"type": "Function",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.TrackApplicationView.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "public",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-public.TrackApplicationViewProps",
|
|
"text": "TrackApplicationViewProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.TrackApplicationViewProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TrackApplicationViewProps",
|
|
"description": [
|
|
"\nProps to provide to the {@link TrackApplicationView} component."
|
|
],
|
|
"path": "src/plugins/usage_collection/public/components/track_application_view/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.TrackApplicationViewProps.viewId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "viewId",
|
|
"description": [
|
|
"\nThe name of the view to be tracked. The appId will be obtained automatically."
|
|
],
|
|
"path": "src/plugins/usage_collection/public/components/track_application_view/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.TrackApplicationViewProps.children",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "children",
|
|
"description": [
|
|
"\nThe React component to be tracked."
|
|
],
|
|
"signature": [
|
|
"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"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/components/track_application_view/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UsageCollectionSetup",
|
|
"description": [
|
|
"Public's setup APIs exposed by the UsageCollection Service"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup.components",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "components",
|
|
"description": [
|
|
"Component helpers to track usage collection in the UI"
|
|
],
|
|
"signature": [
|
|
"{ ApplicationUsageTrackingProvider: React.FC<{}>; }"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup.reportUiCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportUiCounter",
|
|
"description": [
|
|
"Report whenever a UI event occurs for UI counters to report it"
|
|
],
|
|
"signature": [
|
|
"(appName: string, type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
", eventNames: string | string[], count?: number | undefined) => void"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup.reportUiCounter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup.reportUiCounter.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
}
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup.reportUiCounter.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "eventNames",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionSetup.reportUiCounter.$4",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UsageCollectionStart",
|
|
"description": [
|
|
"Public's start APIs exposed by the UsageCollection Service"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionStart.reportUiCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportUiCounter",
|
|
"description": [
|
|
"Report whenever a UI event occurs for UI counters to report it"
|
|
],
|
|
"signature": [
|
|
"(appName: string, type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
", eventNames: string | string[], count?: number | undefined) => void"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionStart.reportUiCounter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionStart.reportUiCounter.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
}
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionStart.reportUiCounter.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "eventNames",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-public.UsageCollectionStart.reportUiCounter.$4",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/usage_collection/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ICollector",
|
|
"description": [
|
|
"\nCommon interface for Usage and Stats Collectors"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.ICollector",
|
|
"text": "ICollector"
|
|
},
|
|
"<TFetchReturn, ExtraOptions>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector.log",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [
|
|
"Logger"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "server",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-server.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector.extendFetchContext",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "extendFetchContext",
|
|
"description": [
|
|
"\nThe options to extend the context provided to the `fetch` method: {@link CollectorOptionsFetchExtendedContext}."
|
|
],
|
|
"signature": [
|
|
"ICollectorOptionsFetchExtendedContext",
|
|
"<boolean> | (",
|
|
"ICollectorOptionsFetchExtendedContext",
|
|
"<boolean> & Required<Pick<",
|
|
"ICollectorOptionsFetchExtendedContext",
|
|
"<true>, \"kibanaRequest\">>)"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The registered type (aka name) of the collector"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector.fetch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"signature": [
|
|
"(this: ",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.ICollector",
|
|
"text": "ICollector"
|
|
},
|
|
"<TFetchReturn, {}> & ExtraOptions, context: ",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.CollectorFetchContext",
|
|
"text": "CollectorFetchContext"
|
|
},
|
|
"<boolean>) => TFetchReturn | Promise<TFetchReturn>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector.fetch.$1",
|
|
"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"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"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; } : {})"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.ICollector.isReady",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isReady",
|
|
"description": [
|
|
"\nShould return `true` when it's safe to call the `fetch` method."
|
|
],
|
|
"signature": [
|
|
"() => boolean | Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IncrementCounterParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IncrementCounterParams",
|
|
"description": [
|
|
"\nDetails about the counter to be incremented"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IncrementCounterParams.counterName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "counterName",
|
|
"description": [
|
|
"The name of the counter"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IncrementCounterParams.counterType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "counterType",
|
|
"description": [
|
|
"The counter type (\"count\" by default)"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IncrementCounterParams.incrementBy",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "incrementBy",
|
|
"description": [
|
|
"Increment the counter by this number (1 if not specified)"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IUsageCounter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IUsageCounter.incrementCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "incrementCounter",
|
|
"description": [
|
|
"\nNotifies the counter about a new event happening so it can increase the count internally."
|
|
],
|
|
"signature": [
|
|
"(params: ",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.IncrementCounterParams",
|
|
"text": "IncrementCounterParams"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.IUsageCounter.incrementCounter.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.IncrementCounterParams",
|
|
"text": "IncrementCounterParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCountersSavedObjectAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UsageCountersSavedObjectAttributes",
|
|
"description": [
|
|
"\nThe attributes stored in the UsageCounters' SavedObjects"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCountersSavedObjectAttributes",
|
|
"text": "UsageCountersSavedObjectAttributes"
|
|
},
|
|
" extends ",
|
|
"SavedObjectAttributes"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCountersSavedObjectAttributes.domainId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "domainId",
|
|
"description": [
|
|
"The domain ID registered in the Usage Counter"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCountersSavedObjectAttributes.counterName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "counterName",
|
|
"description": [
|
|
"The counter name"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCountersSavedObjectAttributes.counterType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "counterType",
|
|
"description": [
|
|
"The counter type"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCountersSavedObjectAttributes.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [
|
|
"Number of times the event has occurred"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.AllowedSchemaTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AllowedSchemaTypes",
|
|
"description": [
|
|
"\nPossible type values in the schema"
|
|
],
|
|
"signature": [
|
|
"\"boolean\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"text\" | \"short\" | \"float\" | \"integer\" | \"byte\""
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.CollectorFetchContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CollectorFetchContext",
|
|
"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"
|
|
],
|
|
"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"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"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; } : {})"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.CollectorFetchMethod",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CollectorFetchMethod",
|
|
"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": [
|
|
"(this: ",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.ICollector",
|
|
"text": "ICollector"
|
|
},
|
|
"<TReturn, {}> & ExtraOptions, context: ",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.CollectorFetchContext",
|
|
"text": "CollectorFetchContext"
|
|
},
|
|
"<WithKibanaRequest>) => TReturn | Promise<TReturn>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.CollectorFetchMethod.$1",
|
|
"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"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"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; } : {})"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.CollectorOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CollectorOptions",
|
|
"description": [
|
|
"\nOptions to instantiate a collector"
|
|
],
|
|
"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; })"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.CollectorOptionsFetchExtendedContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CollectorOptionsFetchExtendedContext",
|
|
"description": [
|
|
"\nThe options to extend the context provided to the `fetch` method."
|
|
],
|
|
"signature": [
|
|
"ICollectorOptionsFetchExtendedContext",
|
|
"<WithKibanaRequest> & (WithKibanaRequest extends true ? Required<Pick<",
|
|
"ICollectorOptionsFetchExtendedContext",
|
|
"<WithKibanaRequest>, \"kibanaRequest\">> : {})"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.MakeSchemaFrom",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MakeSchemaFrom",
|
|
"description": [
|
|
"\nThe `schema` property in {@link CollectorOptions} must match the output of\nthe `fetch` method. This type helps ensure that is correct"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<Base>]: Required<Base>[Key] extends (infer U)[] ? { type: \"array\"; items: ",
|
|
"RecursiveMakeSchemaFrom",
|
|
"<U>; } : ",
|
|
"RecursiveMakeSchemaFrom",
|
|
"<Required<Base>[Key]>; }"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.USAGE_COUNTERS_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "USAGE_COUNTERS_SAVED_OBJECT_TYPE",
|
|
"description": [
|
|
"The Saved Objects type for Usage Counters"
|
|
],
|
|
"signature": [
|
|
"\"usage-counters\""
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectorOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UsageCollectorOptions",
|
|
"description": [
|
|
"\nSame as {@link CollectorOptions} but with the `schema` property enforced"
|
|
],
|
|
"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\">>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/collector/usage_collector.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCountersSavedObject",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UsageCountersSavedObject",
|
|
"description": [
|
|
"\nThe structure of the SavedObjects of type \"usage-counters\""
|
|
],
|
|
"signature": [
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCountersSavedObjectAttributes",
|
|
"text": "UsageCountersSavedObjectAttributes"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/usage_counters/saved_objects.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UsageCollectionSetup",
|
|
"description": [
|
|
"Server's setup APIs exposed by the UsageCollection Service"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.createUsageCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.createUsageCounter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.getUsageCounterByType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.getUsageCounterByType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.makeUsageCollector",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.makeUsageCollector.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCollectorOptions",
|
|
"text": "UsageCollectorOptions"
|
|
},
|
|
"<TFetchReturn, WithKibanaRequest, ExtraOptions>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.registerCollector",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.registerCollector.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "collector",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.ICollector",
|
|
"text": "ICollector"
|
|
},
|
|
"<TFetchReturn, ExtraOptions>"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.getCollectorByType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "usageCollection",
|
|
"id": "def-server.UsageCollectionSetup.getCollectorByType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/usage_collection/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |