maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/usage_collection.json
Stacey Gammon 87a5b22626
API DOCS Step 3/3 (#92929) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-02 22:02:17 -05:00

519 lines
19 KiB
JSON
Raw Blame History

{
"id": "usageCollection",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.TrackApplicationView",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "props",
"isRequired": true,
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.TrackApplicationViewProps",
"text": "TrackApplicationViewProps"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx#L23"
}
}
],
"signature": [
"(props: React.PropsWithChildren<",
"TrackApplicationViewProps",
">) => JSX.Element"
],
"description": [
"\nReact component to track the number of clicks and minutes on screen of the children components."
],
"label": "TrackApplicationView",
"source": {
"path": "src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx#L23"
},
"tags": [
"Link",
"constructor"
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"id": "def-public.METRIC_TYPE",
"type": "Enum",
"label": "METRIC_TYPE",
"tags": [],
"description": [],
"source": {
"path": "node_modules/@kbn/analytics/target/types/metrics/index.d.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/masternode_modules/@kbn/analytics/target/types/metrics/index.d.ts#L10"
},
"signature": [
"METRIC_TYPE"
],
"initialIsOpen": false
}
],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.UsageCollectionSetup",
"type": "Interface",
"label": "UsageCollectionSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.UsageCollectionSetup.components",
"type": "Object",
"label": "components",
"description": [],
"source": {
"path": "src/plugins/usage_collection/public/plugin.tsx",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/plugin.tsx#L35"
},
"signature": [
"{ ApplicationUsageTrackingProvider: React.FC<{}>; }"
]
},
{
"tags": [],
"id": "def-public.UsageCollectionSetup.reportUiCounter",
"type": "Function",
"label": "reportUiCounter",
"description": [],
"source": {
"path": "src/plugins/usage_collection/public/plugin.tsx",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/plugin.tsx#L38"
},
"signature": [
"(appName: string, type: ",
"UiCounterMetricType",
", eventNames: string | string[], count?: number | undefined) => void"
]
}
],
"source": {
"path": "src/plugins/usage_collection/public/plugin.tsx",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/plugin.tsx#L34"
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.UsageCollectionStart",
"type": "Interface",
"label": "UsageCollectionStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.UsageCollectionStart.reportUiCounter",
"type": "Function",
"label": "reportUiCounter",
"description": [],
"source": {
"path": "src/plugins/usage_collection/public/plugin.tsx",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/plugin.tsx#L42"
},
"signature": [
"(appName: string, type: ",
"UiCounterMetricType",
", eventNames: string | string[], count?: number | undefined) => void"
]
}
],
"source": {
"path": "src/plugins/usage_collection/public/plugin.tsx",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/public/plugin.tsx#L41"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"id": "def-server.Collector",
"type": "Class",
"tags": [],
"label": "Collector",
"description": [],
"signature": [
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.Collector",
"text": "Collector"
},
"<TFetchReturn, ExtraOptions>"
],
"children": [
{
"tags": [],
"id": "def-server.Collector.extendFetchContext",
"type": "CompoundType",
"label": "extendFetchContext",
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 145,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L145"
},
"signature": [
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorOptionsFetchExtendedContext",
"text": "CollectorOptionsFetchExtendedContext"
},
"<any>"
]
},
{
"tags": [],
"id": "def-server.Collector.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 146,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L146"
}
},
{
"tags": [],
"id": "def-server.Collector.init",
"type": "Object",
"label": "init",
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 147,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L147"
},
"signature": [
"Function | undefined"
]
},
{
"tags": [],
"id": "def-server.Collector.fetch",
"type": "Function",
"label": "fetch",
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 148,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L148"
},
"signature": [
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorFetchMethod",
"text": "CollectorFetchMethod"
},
"<any, TFetchReturn, ExtraOptions>"
]
},
{
"tags": [],
"id": "def-server.Collector.isReady",
"type": "Function",
"label": "isReady",
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 149,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L149"
},
"signature": [
"() => boolean | Promise<boolean>"
]
},
{
"id": "def-server.Collector.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "log",
"isRequired": true,
"signature": [
"Logger"
],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 156,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L156"
}
},
{
"type": "CompoundType",
"label": "{\n type,\n init,\n fetch,\n isReady,\n extendFetchContext = {},\n ...options\n }",
"isRequired": true,
"signature": [
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorOptions",
"text": "CollectorOptions"
},
"<TFetchReturn, any, ExtraOptions>"
],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 157,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L157"
}
}
],
"tags": [
"private",
"link",
"link"
],
"returnComment": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L155"
}
}
],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 144,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L144"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-server.SchemaField",
"type": "Interface",
"label": "SchemaField",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.SchemaField.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L34"
}
}
],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L33"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-server.AllowedSchemaTypes",
"type": "Type",
"label": "AllowedSchemaTypes",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L28"
},
"signature": [
"\"boolean\" | \"date\" | \"text\" | \"keyword\" | \"long\" | \"double\" | \"short\" | \"integer\" | \"byte\" | \"float\""
],
"initialIsOpen": false
},
{
"id": "def-server.MakeSchemaFrom",
"type": "Type",
"label": "MakeSchemaFrom",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L51"
},
"signature": [
"{ [Key in keyof Required<Base>]: Required<Base>[Key] extends (infer U)[] ? { type: 'array'; items: RecursiveMakeSchemaFrom<U>; } : RecursiveMakeSchemaFrom<Required<Base>[Key]>; }"
],
"initialIsOpen": false
},
{
"id": "def-server.CollectorOptions",
"type": "Type",
"label": "CollectorOptions",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 112,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L112"
},
"signature": [
"{ type: string; init?: Function | undefined; isReady: () => Promise<boolean> | boolean; schema?: MakeSchemaFrom<TFetchReturn> | undefined; fetch: CollectorFetchMethod<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: CollectorOptionsFetchExtendedContext<WithKibanaRequest>; } : { extendFetchContext?: CollectorOptionsFetchExtendedContext<WithKibanaRequest> | undefined; })"
],
"initialIsOpen": false
},
{
"id": "def-server.UsageCollectorOptions",
"type": "Type",
"label": "UsageCollectorOptions",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/collector/usage_collector.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/usage_collector.ts#L13"
},
"signature": [
"{ type: string; init?: Function | undefined; isReady: () => boolean | Promise<boolean>; schema?: ",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.MakeSchemaFrom",
"text": "MakeSchemaFrom"
},
"<TFetchReturn> | undefined; fetch: ",
"CollectorFetchMethod",
"<WithKibanaRequest, TFetchReturn, ExtraOptions>; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: ",
"CollectorOptionsFetchExtendedContext",
"<WithKibanaRequest>; } : { extendFetchContext?: ",
"CollectorOptionsFetchExtendedContext",
"<WithKibanaRequest> | undefined; }) & Required<Pick<CollectorOptions<TFetchReturn, boolean, {}>, \"schema\">>"
],
"initialIsOpen": false
},
{
"id": "def-server.CollectorFetchContext",
"type": "Type",
"label": "CollectorFetchContext",
"tags": [
"remark"
],
"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"
],
"source": {
"path": "src/plugins/usage_collection/server/collector/collector.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/collector/collector.ts#L65"
},
"signature": [
"{ esClient: ElasticsearchClient; soClient: SavedObjectsClientContract | ISavedObjectsRepository; } & (WithKibanaRequest extends true ? { kibanaRequest?: KibanaRequest<unknown, unknown, unknown, any> | undefined; } : {})"
],
"initialIsOpen": false
},
{
"id": "def-server.UsageCollectionSetup",
"type": "Type",
"label": "UsageCollectionSetup",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/usage_collection/server/plugin.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/usage_collection/server/plugin.ts#L21"
},
"signature": [
"{ makeStatsCollector: <TFetchReturn, WithKibanaRequest, ExtraOptions>(options: ",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorOptions",
"text": "CollectorOptions"
},
"<TFetchReturn, WithKibanaRequest, ExtraOptions>) => ",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.Collector",
"text": "Collector"
},
"<TFetchReturn, ExtraOptions>; makeUsageCollector: <TFetchReturn, WithKibanaRequest, ExtraOptions>(options: ",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.UsageCollectorOptions",
"text": "UsageCollectorOptions"
},
"<TFetchReturn, WithKibanaRequest, ExtraOptions>) => ",
"UsageCollector",
"<TFetchReturn, ExtraOptions>; registerCollector: <TFetchReturn, ExtraOptions>(collector: ",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.Collector",
"text": "Collector"
}
],
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink