kibana/api_docs/kbn_apm_synthtrace.devdocs.json

581 lines
No EOL
20 KiB
JSON

{
"id": "@kbn/apm-synthtrace",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "ApmSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.ApmSynthtraceEsClient",
"text": "ApmSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.ApmFields",
"text": "ApmFields"
},
">"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
"Logger",
"; } & ",
"ApmSynthtraceEsClientOptions"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.updateComponentTemplate",
"type": "Function",
"tags": [],
"label": "updateComponentTemplate",
"description": [],
"signature": [
"(name: ",
"ComponentTemplateName",
", modify: (template: ",
"ClusterComponentTemplateSummary",
") => ",
"IndicesIndexState",
") => Promise<void>"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.updateComponentTemplate.$1",
"type": "Enum",
"tags": [],
"label": "name",
"description": [],
"signature": [
"ComponentTemplateName"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.updateComponentTemplate.$2",
"type": "Function",
"tags": [],
"label": "modify",
"description": [],
"signature": [
"(template: ",
"ClusterComponentTemplateSummary",
") => ",
"IndicesIndexState"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.getDefaultPipeline",
"type": "Function",
"tags": [],
"label": "getDefaultPipeline",
"description": [],
"signature": [
"(includeSerialization?: boolean) => (base: ",
"Readable",
") => NodeJS.WritableStream"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.getDefaultPipeline.$1",
"type": "boolean",
"tags": [],
"label": "includeSerialization",
"description": [],
"signature": [
"boolean"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient",
"type": "Class",
"tags": [],
"label": "ApmSynthtraceKibanaClient",
"description": [],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.Unnamed.$1.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
"Logger"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.Unnamed.$1.target",
"type": "string",
"tags": [],
"label": "target",
"description": [],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.fetchLatestApmPackageVersion",
"type": "Function",
"tags": [],
"label": "fetchLatestApmPackageVersion",
"description": [],
"signature": [
"() => Promise<string>"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.installApmPackage",
"type": "Function",
"tags": [],
"label": "installApmPackage",
"description": [],
"signature": [
"(packageVersion: string) => Promise<void>"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.installApmPackage.$1",
"type": "string",
"tags": [],
"label": "packageVersion",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.AssetsSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "AssetsSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.AssetsSynthtraceEsClient",
"text": "AssetsSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.AssetDocument",
"text": "AssetDocument"
},
">"
],
"path": "packages/kbn-apm-synthtrace/src/lib/assets/assets_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.AssetsSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-apm-synthtrace/src/lib/assets/assets_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.AssetsSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
"Logger",
"; } & ",
"AssetsSynthtraceEsClientOptions"
],
"path": "packages/kbn-apm-synthtrace/src/lib/assets/assets_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "InfraSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.InfraSynthtraceEsClient",
"text": "InfraSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.InfraDocument",
"text": "InfraDocument"
},
">"
],
"path": "packages/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
"Logger",
"; } & ",
"InfraSynthtraceEsClientOptions"
],
"path": "packages/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.MonitoringSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "MonitoringSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.MonitoringSynthtraceEsClient",
"text": "MonitoringSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.MonitoringDocument",
"text": "MonitoringDocument"
},
">"
],
"path": "packages/kbn-apm-synthtrace/src/lib/monitoring/monitoring_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.MonitoringSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-apm-synthtrace/src/lib/monitoring/monitoring_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.MonitoringSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
"Logger",
"; } & ",
"MonitoringSynthtraceEsClientOptions"
],
"path": "packages/kbn-apm-synthtrace/src/lib/monitoring/monitoring_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.createLogger",
"type": "Function",
"tags": [],
"label": "createLogger",
"description": [],
"signature": [
"(logLevel: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.LogLevel",
"text": "LogLevel"
},
") => ",
"Logger"
],
"path": "packages/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.createLogger.$1",
"type": "Enum",
"tags": [],
"label": "logLevel",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.LogLevel",
"text": "LogLevel"
}
],
"path": "packages/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogLevel",
"type": "Enum",
"tags": [],
"label": "LogLevel",
"description": [],
"path": "packages/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}