kibana/api_docs/kbn_apm_synthtrace.devdocs.json

1882 lines
No EOL
70 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"
},
" | ",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.ApmOtelFields",
"text": "ApmOtelFields"
},
">"
],
"path": "src/platform/packages/shared/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.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/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: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ",
"ApmSynthtraceEsClientOptions"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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, versionOverride, }?: { includeSerialization?: boolean | undefined; versionOverride?: string | undefined; }) => (base: ",
"Readable",
") => NodeJS.WritableStream"
],
"path": "src/platform/packages/shared/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": "Object",
"tags": [],
"label": "{\n includeSerialization,\n versionOverride,\n }",
"description": [],
"path": "src/platform/packages/shared/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.includeSerialization",
"type": "CompoundType",
"tags": [],
"label": "includeSerialization",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.getDefaultPipeline.$1.versionOverride",
"type": "string",
"tags": [],
"label": "versionOverride",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.getPipeline",
"type": "Function",
"tags": [],
"label": "getPipeline",
"description": [],
"signature": [
"(pipeline: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.ApmSynthtracePipelines",
"text": "ApmSynthtracePipelines"
},
", options?: { includeSerialization?: boolean | undefined; versionOverride?: string | undefined; }) => ((base: ",
"Readable",
") => NodeJS.WritableStream) | ((base: ",
"Readable",
") => ",
"Duplex",
")"
],
"path": "src/platform/packages/shared/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.getPipeline.$1",
"type": "CompoundType",
"tags": [],
"label": "pipeline",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.ApmSynthtracePipelines",
"text": "ApmSynthtracePipelines"
}
],
"path": "src/platform/packages/shared/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.getPipeline.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/platform/packages/shared/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.getPipeline.$2.includeSerialization",
"type": "CompoundType",
"tags": [],
"label": "includeSerialization",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceEsClient.getPipeline.$2.versionOverride",
"type": "string",
"tags": [],
"label": "versionOverride",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient",
"type": "Class",
"tags": [],
"label": "ApmSynthtraceKibanaClient",
"description": [],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ logger: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ({ target: string; } | { kibanaClient: ",
"KibanaClient",
"; })"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.getFleetApmPackagePath",
"type": "Function",
"tags": [],
"label": "getFleetApmPackagePath",
"description": [],
"signature": [
"(packageVersion?: string | undefined) => string"
],
"path": "src/platform/packages/shared/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.getFleetApmPackagePath.$1",
"type": "string",
"tags": [],
"label": "packageVersion",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.fetchLatestApmPackageVersion",
"type": "Function",
"tags": [],
"label": "fetchLatestApmPackageVersion",
"description": [],
"signature": [
"() => Promise<string>"
],
"path": "src/platform/packages/shared/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 | undefined) => Promise<{ version: string; }>"
],
"path": "src/platform/packages/shared/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 | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtraceKibanaClient.uninstallApmPackage",
"type": "Function",
"tags": [],
"label": "uninstallApmPackage",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "EntitiesSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.EntitiesSynthtraceEsClient",
"text": "EntitiesSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.EntityFields",
"text": "EntityFields"
},
">"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ",
"EntitiesSynthtraceEsClientOptions"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceEsClient.getDefaultPipeline",
"type": "Function",
"tags": [],
"label": "getDefaultPipeline",
"description": [],
"signature": [
"({ includeSerialization }?: Pipeline) => (base: ",
"Readable",
") => ",
"Transform"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceEsClient.getDefaultPipeline.$1",
"type": "Object",
"tags": [],
"label": "{ includeSerialization }",
"description": [],
"signature": [
"Pipeline"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceKibanaClient",
"type": "Class",
"tags": [],
"label": "EntitiesSynthtraceKibanaClient",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceKibanaClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceKibanaClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ logger: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ({ target: string; } | { kibanaClient: ",
"KibanaClient",
"; })"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceKibanaClient.installEntityIndexPatterns",
"type": "Function",
"tags": [],
"label": "installEntityIndexPatterns",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.EntitiesSynthtraceKibanaClient.uninstallEntityIndexPatterns",
"type": "Function",
"tags": [],
"label": "uninstallEntityIndexPatterns",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/entities/entities_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"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": "src/platform/packages/shared/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": "src/platform/packages/shared/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: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ",
"InfraSynthtraceEsClientOptions"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceEsClient.getDefaultPipeline",
"type": "Function",
"tags": [],
"label": "getDefaultPipeline",
"description": [],
"signature": [
"({ includeSerialization, }?: { includeSerialization?: boolean | undefined; }) => (base: ",
"Readable",
") => ",
"Transform"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceEsClient.getDefaultPipeline.$1",
"type": "Object",
"tags": [],
"label": "{\n includeSerialization,\n }",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceEsClient.getDefaultPipeline.$1.includeSerialization",
"type": "CompoundType",
"tags": [],
"label": "includeSerialization",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient",
"type": "Class",
"tags": [],
"label": "InfraSynthtraceKibanaClient",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.Unnamed.$1.logger",
"type": "CompoundType",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
" & { perf: <T>(name: string, cb: () => T) => T; }"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.Unnamed.$1.target",
"type": "string",
"tags": [],
"label": "target",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.Unnamed.$1.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.Unnamed.$1.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.fetchLatestSystemPackageVersion",
"type": "Function",
"tags": [],
"label": "fetchLatestSystemPackageVersion",
"description": [],
"signature": [
"() => Promise<string>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.installSystemPackage",
"type": "Function",
"tags": [],
"label": "installSystemPackage",
"description": [],
"signature": [
"(packageVersion: string) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.installSystemPackage.$1",
"type": "string",
"tags": [],
"label": "packageVersion",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.uninstallSystemPackage",
"type": "Function",
"tags": [],
"label": "uninstallSystemPackage",
"description": [],
"signature": [
"(packageVersion: string) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.InfraSynthtraceKibanaClient.uninstallSystemPackage.$1",
"type": "string",
"tags": [],
"label": "packageVersion",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/infra/infra_synthtrace_kibana_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "LogsSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.LogsSynthtraceEsClient",
"text": "LogsSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.LogDocument",
"text": "LogDocument"
},
">"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ",
"LogsSynthtraceEsClientOptions"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createIndexTemplate",
"type": "Function",
"tags": [],
"label": "createIndexTemplate",
"description": [],
"signature": [
"(name: ",
"IndexTemplateName",
") => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createIndexTemplate.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"IndexTemplateName"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.deleteIndexTemplate",
"type": "Function",
"tags": [],
"label": "deleteIndexTemplate",
"description": [],
"signature": [
"(name: ",
"IndexTemplateName",
") => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.deleteIndexTemplate.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"IndexTemplateName"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createComponentTemplate",
"type": "Function",
"tags": [],
"label": "createComponentTemplate",
"description": [],
"signature": [
"({ name, mappings, dataStreamOptions, }: { name: string; mappings?: ",
"MappingTypeMapping",
" | undefined; dataStreamOptions?: { failure_store: { enabled: boolean; }; } | undefined; }) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createComponentTemplate.$1",
"type": "Object",
"tags": [],
"label": "{\n name,\n mappings,\n dataStreamOptions,\n }",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createComponentTemplate.$1.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createComponentTemplate.$1.mappings",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"MappingTypeMapping",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createComponentTemplate.$1.dataStreamOptions",
"type": "Object",
"tags": [],
"label": "dataStreamOptions",
"description": [],
"signature": [
"{ failure_store: { enabled: boolean; }; } | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.deleteComponentTemplate",
"type": "Function",
"tags": [],
"label": "deleteComponentTemplate",
"description": [],
"signature": [
"(name: string) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.deleteComponentTemplate.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createIndex",
"type": "Function",
"tags": [],
"label": "createIndex",
"description": [],
"signature": [
"(index: string, mappings?: ",
"MappingTypeMapping",
" | undefined) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createIndex.$1",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createIndex.$2",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"MappingTypeMapping",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.updateIndexTemplate",
"type": "Function",
"tags": [],
"label": "updateIndexTemplate",
"description": [],
"signature": [
"(indexName: string, modify: (template: ",
"IndicesIndexTemplate",
") => ",
"IndicesPutIndexTemplateRequest",
") => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.updateIndexTemplate.$1",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.updateIndexTemplate.$2",
"type": "Function",
"tags": [],
"label": "modify",
"description": [],
"signature": [
"(template: ",
"IndicesIndexTemplate",
") => ",
"IndicesPutIndexTemplateRequest"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createCustomPipeline",
"type": "Function",
"tags": [],
"label": "createCustomPipeline",
"description": [],
"signature": [
"(processors: ",
"IngestProcessorContainer",
"[], id?: string) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createCustomPipeline.$1",
"type": "Array",
"tags": [],
"label": "processors",
"description": [],
"signature": [
"IngestProcessorContainer",
"[]"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.createCustomPipeline.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.deleteCustomPipeline",
"type": "Function",
"tags": [],
"label": "deleteCustomPipeline",
"description": [],
"signature": [
"(id?: string) => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.deleteCustomPipeline.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.getDefaultPipeline",
"type": "Function",
"tags": [],
"label": "getDefaultPipeline",
"description": [],
"signature": [
"({ includeSerialization }?: Pipeline) => (base: ",
"Readable",
") => ",
"Transform"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.LogsSynthtraceEsClient.getDefaultPipeline.$1",
"type": "Object",
"tags": [],
"label": "{ includeSerialization }",
"description": [],
"signature": [
"Pipeline"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/logs/logs_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": "src/platform/packages/shared/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": "src/platform/packages/shared/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: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ",
"MonitoringSynthtraceEsClientOptions"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/monitoring/monitoring_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.SyntheticsSynthtraceEsClient",
"type": "Class",
"tags": [],
"label": "SyntheticsSynthtraceEsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.SyntheticsSynthtraceEsClient",
"text": "SyntheticsSynthtraceEsClient"
},
" extends ",
"SynthtraceEsClient",
"<",
{
"pluginId": "@kbn/apm-synthtrace-client",
"scope": "common",
"docId": "kibKbnApmSynthtraceClientPluginApi",
"section": "def-common.SyntheticsMonitorDocument",
"text": "SyntheticsMonitorDocument"
},
">"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/synthetics/synthetics_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.SyntheticsSynthtraceEsClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/synthetics/synthetics_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.SyntheticsSynthtraceEsClient.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ client: ",
"default",
"; logger: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
},
"; } & ",
"SyntheticsSynthtraceEsClientOptions"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/synthetics/synthetics_synthtrace_es_client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.addObserverVersionTransform",
"type": "Function",
"tags": [],
"label": "addObserverVersionTransform",
"description": [],
"signature": [
"(observerVersion: string) => ",
"Transform"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/transform_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.addObserverVersionTransform.$1",
"type": "string",
"tags": [],
"label": "observerVersion",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/transform_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"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"
},
", writer: ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.Writer",
"text": "Writer"
},
" | undefined) => ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.createLogger.$2",
"type": "Object",
"tags": [],
"label": "writer",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.Writer",
"text": "Writer"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.deleteSummaryFieldTransform",
"type": "Function",
"tags": [],
"label": "deleteSummaryFieldTransform",
"description": [],
"signature": [
"() => ",
"Transform"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/transform_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.extendToolingLog",
"type": "Function",
"tags": [],
"label": "extendToolingLog",
"description": [],
"signature": [
"(log: ",
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
", logLevel: ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.LogLevel",
"text": "LogLevel"
},
") => ",
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.extendToolingLog.$1",
"type": "Object",
"tags": [],
"label": "log",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
}
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.extendToolingLog.$2",
"type": "Enum",
"tags": [],
"label": "logLevel",
"description": [],
"signature": [
{
"pluginId": "@kbn/apm-synthtrace",
"scope": "server",
"docId": "kibKbnApmSynthtracePluginApi",
"section": "def-server.LogLevel",
"text": "LogLevel"
}
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.ApmSynthtracePipelines",
"type": "Type",
"tags": [],
"label": "ApmSynthtracePipelines",
"description": [],
"signature": [
"\"default\" | \"otelToApm\" | \"apmToOtel\""
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.Logger",
"type": "Type",
"tags": [],
"label": "Logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/tooling-log",
"scope": "common",
"docId": "kibKbnToolingLogPluginApi",
"section": "def-common.ToolingLog",
"text": "ToolingLog"
},
" & { perf: <T>(name: string, cb: () => T) => T; }"
],
"path": "src/platform/packages/shared/kbn-apm-synthtrace/src/lib/utils/create_logger.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}