* 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>
506 lines
18 KiB
JSON
506 lines
18 KiB
JSON
{
|
|
"id": "telemetryCollectionManager",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.StatsCollectionConfig",
|
|
"type": "Interface",
|
|
"label": "StatsCollectionConfig",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.StatsCollectionConfig.usageCollection",
|
|
"type": "Object",
|
|
"label": "usageCollection",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 58,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L58"
|
|
},
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.CollectorSet",
|
|
"text": "CollectorSet"
|
|
},
|
|
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.StatsCollectionConfig.esClient",
|
|
"type": "CompoundType",
|
|
"label": "esClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 59,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L59"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.StatsCollectionConfig.soClient",
|
|
"type": "CompoundType",
|
|
"label": "soClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L60"
|
|
},
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\"> | Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRepository",
|
|
"text": "SavedObjectsRepository"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.StatsCollectionConfig.kibanaRequest",
|
|
"type": "Object",
|
|
"label": "kibanaRequest",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 61,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L61"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 57,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L57"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.StatsCollectionContext",
|
|
"type": "Interface",
|
|
"label": "StatsCollectionContext",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.StatsCollectionContext.logger",
|
|
"type": "CompoundType",
|
|
"label": "logger",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 79,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L79"
|
|
},
|
|
"signature": [
|
|
"Logger",
|
|
" | Console"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.StatsCollectionContext.version",
|
|
"type": "string",
|
|
"label": "version",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 80,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L80"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 78,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L78"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ClusterDetails",
|
|
"type": "Interface",
|
|
"label": "ClusterDetails",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ClusterDetails.clusterUuid",
|
|
"type": "string",
|
|
"label": "clusterUuid",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L54"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 53,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L53"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.UsageStatsPayload",
|
|
"type": "Interface",
|
|
"label": "UsageStatsPayload",
|
|
"signature": [
|
|
"UsageStatsPayload",
|
|
" extends ",
|
|
"BasicStatsPayload"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.UsageStatsPayload.collectionSource",
|
|
"type": "string",
|
|
"label": "collectionSource",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 75,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L75"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 74,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L74"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.StatsGetter",
|
|
"type": "Type",
|
|
"label": "StatsGetter",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 88,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L88"
|
|
},
|
|
"signature": [
|
|
"(clustersDetails: ",
|
|
"ClusterDetails",
|
|
"[], config: ",
|
|
"StatsCollectionConfig",
|
|
", context: ",
|
|
"StatsCollectionContext",
|
|
") => Promise<T[]>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.StatsGetterConfig",
|
|
"type": "Type",
|
|
"label": "StatsGetterConfig",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 83,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L83"
|
|
},
|
|
"signature": [
|
|
"UnencryptedStatsGetterConfig",
|
|
" | ",
|
|
"EncryptedStatsGetterConfig"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ClusterDetailsGetter",
|
|
"type": "Type",
|
|
"label": "ClusterDetailsGetter",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 84,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L84"
|
|
},
|
|
"signature": [
|
|
"(config: ",
|
|
"StatsCollectionConfig",
|
|
", context: ",
|
|
"StatsCollectionContext",
|
|
") => Promise<",
|
|
"ClusterDetails",
|
|
"[]>"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup",
|
|
"type": "Interface",
|
|
"label": "TelemetryCollectionManagerPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.setCollectionStrategy",
|
|
"type": "Function",
|
|
"label": "setCollectionStrategy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L20"
|
|
},
|
|
"signature": [
|
|
"<T extends ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.BasicStatsPayload",
|
|
"text": "BasicStatsPayload"
|
|
},
|
|
">(collectionConfig: ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.CollectionStrategyConfig",
|
|
"text": "CollectionStrategyConfig"
|
|
},
|
|
"<T>) => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.getOptInStats",
|
|
"type": "Function",
|
|
"label": "getOptInStats",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 23,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L23"
|
|
},
|
|
"signature": [
|
|
"(optInStatus: boolean, config: ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.StatsGetterConfig",
|
|
"text": "StatsGetterConfig"
|
|
},
|
|
") => Promise<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.getStats",
|
|
"type": "Function",
|
|
"label": "getStats",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L24"
|
|
},
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.StatsGetterConfig",
|
|
"text": "StatsGetterConfig"
|
|
},
|
|
") => Promise<string[] | ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.UsageStatsPayload",
|
|
"text": "UsageStatsPayload"
|
|
},
|
|
"[]>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.areAllCollectorsReady",
|
|
"type": "Function",
|
|
"label": "areAllCollectorsReady",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L25"
|
|
},
|
|
"signature": [
|
|
"() => Promise<boolean | undefined>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L19"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart",
|
|
"type": "Interface",
|
|
"label": "TelemetryCollectionManagerPluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart.getOptInStats",
|
|
"type": "Function",
|
|
"label": "getOptInStats",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L29"
|
|
},
|
|
"signature": [
|
|
"(optInStatus: boolean, config: ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.StatsGetterConfig",
|
|
"text": "StatsGetterConfig"
|
|
},
|
|
") => Promise<string[] | { cluster_uuid: string; opt_in_status: boolean; }[]>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart.getStats",
|
|
"type": "Function",
|
|
"label": "getStats",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L30"
|
|
},
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.StatsGetterConfig",
|
|
"text": "StatsGetterConfig"
|
|
},
|
|
") => Promise<string[] | ",
|
|
{
|
|
"pluginId": "telemetry",
|
|
"scope": "common",
|
|
"docId": "kibTelemetryPluginApi",
|
|
"section": "def-common.UsageStatsPayload",
|
|
"text": "UsageStatsPayload"
|
|
},
|
|
"[]>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart.areAllCollectorsReady",
|
|
"type": "Function",
|
|
"label": "areAllCollectorsReady",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L31"
|
|
},
|
|
"signature": [
|
|
"() => Promise<boolean | undefined>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/telemetry_collection_manager/server/types.ts#L28"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |