503cfcf8c9
* Track stats and add extra output information * Update api docs output * Clean up id names * update api docs * Consolidate error messages and fix a bug * Update docs * Update get_declaration_nodes_for_plugin.ts * Fix bug with removeBrokenLinks not being recursive * Update docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
698 lines
27 KiB
JSON
698 lines
27 KiB
JSON
{
|
|
"id": "apm",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.ConfigSchema",
|
|
"type": "Interface",
|
|
"label": "ConfigSchema",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ConfigSchema.serviceMapEnabled",
|
|
"type": "boolean",
|
|
"label": "serviceMapEnabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/public/index.ts",
|
|
"lineNumber": 15
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ConfigSchema.profilingEnabled",
|
|
"type": "boolean",
|
|
"label": "profilingEnabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/public/index.ts",
|
|
"lineNumber": 16
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ConfigSchema.ui",
|
|
"type": "Object",
|
|
"label": "ui",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/public/index.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"signature": [
|
|
"{ enabled: boolean; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/public/index.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"id": "def-public.ApmPluginStart",
|
|
"type": "Type",
|
|
"label": "ApmPluginStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/public/plugin.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"signature": [
|
|
"void"
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"id": "def-server.APMPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "APMPlugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "apm",
|
|
"scope": "server",
|
|
"docId": "kibApmPluginApi",
|
|
"section": "def-server.APMPlugin",
|
|
"text": "APMPlugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "apm",
|
|
"scope": "server",
|
|
"docId": "kibApmPluginApi",
|
|
"section": "def-server.APMPluginSetup",
|
|
"text": "APMPluginSetup"
|
|
},
|
|
", void, ",
|
|
"APMPluginSetupDependencies",
|
|
", ",
|
|
"APMPluginStartDependencies"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-server.APMPlugin.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.APMPlugin.Unnamed.$1",
|
|
"type": "Object",
|
|
"label": "initContext",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 58
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 58
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.APMPlugin.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
"APMPluginStartDependencies",
|
|
", unknown>, plugins: Pick<",
|
|
"APMPluginSetupDependencies",
|
|
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">) => { config$: ",
|
|
"Observable",
|
|
"<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
|
|
"SearchAggregatedTransactionSetting"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.APMPlugin.setup.$1",
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
"APMPluginStartDependencies",
|
|
", unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 63
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.APMPlugin.setup.$2",
|
|
"type": "Object",
|
|
"label": "plugins",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
"APMPluginSetupDependencies",
|
|
", \"data\" | \"security\" | \"home\" | \"features\" | \"ml\" | \"actions\" | \"usageCollection\" | \"apmOss\" | \"licensing\" | \"observability\" | \"spaces\" | \"cloud\" | \"taskManager\" | \"alerting\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 64
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 62
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.APMPlugin.start",
|
|
"type": "Function",
|
|
"label": "start",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.APMPlugin.start.$1",
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 208
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 208
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.APMPlugin.stop",
|
|
"type": "Function",
|
|
"label": "stop",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 227
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/plugin.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.mergeConfigs",
|
|
"type": "Function",
|
|
"label": "mergeConfigs",
|
|
"signature": [
|
|
"(apmOssConfig: Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>, apmConfig: Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
|
|
"SearchAggregatedTransactionSetting",
|
|
"; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>) => { 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
|
|
"SearchAggregatedTransactionSetting",
|
|
"; 'xpack.apm.metricsInterval': number; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.mergeConfigs.$1",
|
|
"type": "Object",
|
|
"label": "apmOssConfig",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/index.ts",
|
|
"lineNumber": 60
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.mergeConfigs.$2",
|
|
"type": "Object",
|
|
"label": "apmConfig",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",
|
|
"SearchAggregatedTransactionSetting",
|
|
"; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/index.ts",
|
|
"lineNumber": 61
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/index.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.APMRouteHandlerResources",
|
|
"type": "Interface",
|
|
"label": "APMRouteHandlerResources",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.request",
|
|
"type": "Object",
|
|
"label": "request",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.context",
|
|
"type": "Object",
|
|
"label": "context",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"signature": [
|
|
"ApmPluginRequestHandlerContext"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.params",
|
|
"type": "Object",
|
|
"label": "params",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"signature": [
|
|
"{ query: { _inspect: boolean; }; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.config",
|
|
"type": "Object",
|
|
"label": "config",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"signature": [
|
|
"{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
|
|
"SearchAggregatedTransactionSetting",
|
|
"; 'xpack.apm.metricsInterval': number; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.logger",
|
|
"type": "Object",
|
|
"label": "logger",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"signature": [
|
|
"Logger"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.core",
|
|
"type": "Object",
|
|
"label": "core",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"signature": [
|
|
"{ setup: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>; start: () => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
">; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMRouteHandlerResources.plugins",
|
|
"type": "Object",
|
|
"label": "plugins",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"signature": [
|
|
"{ data: { setup: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginSetup",
|
|
"text": "DataPluginSetup"
|
|
},
|
|
"; start: () => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStart",
|
|
"text": "DataPluginStart"
|
|
},
|
|
">; }; features: { setup: ",
|
|
{
|
|
"pluginId": "features",
|
|
"scope": "server",
|
|
"docId": "kibFeaturesPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
},
|
|
"; start: () => Promise<",
|
|
{
|
|
"pluginId": "features",
|
|
"scope": "server",
|
|
"docId": "kibFeaturesPluginApi",
|
|
"section": "def-server.PluginStartContract",
|
|
"text": "PluginStartContract"
|
|
},
|
|
">; }; apmOss: { setup: ",
|
|
{
|
|
"pluginId": "apmOss",
|
|
"scope": "server",
|
|
"docId": "kibApmOssPluginApi",
|
|
"section": "def-server.APMOSSPluginSetup",
|
|
"text": "APMOSSPluginSetup"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-server.ProcessorEvent",
|
|
"type": "Enum",
|
|
"label": "ProcessorEvent",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/common/processor_event.ts",
|
|
"lineNumber": 8
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.APMConfig",
|
|
"type": "Type",
|
|
"label": "APMConfig",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/index.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"signature": [
|
|
"{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.APMServerRouteRepository",
|
|
"type": "Type",
|
|
"label": "APMServerRouteRepository",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/get_global_apm_server_route_repository.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"signature": [
|
|
"ServerRouteRepository<APMRouteHandlerResources, ",
|
|
"APMRouteCreateOptions",
|
|
", { \"POST /api/apm/index_pattern/static\": ",
|
|
"ServerRoute",
|
|
"<\"POST /api/apm/index_pattern/static\", undefined, APMRouteHandlerResources, { created: boolean; }, ",
|
|
"APMRouteCreateOptions",
|
|
">; } & { \"GET /api/apm/index_pattern/dynamic\": ",
|
|
"ServerRoute",
|
|
"<\"GET /api/apm/index_pattern/dynamic\", undefined, APMRouteHandlerResources, { dynamicIndexPattern: ",
|
|
"IndexPatternTitleAndFields"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.APMXPackConfig",
|
|
"type": "Type",
|
|
"label": "APMXPackConfig",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/index.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"signature": [
|
|
"{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.InspectResponse",
|
|
"type": "Type",
|
|
"label": "InspectResponse",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/routes/typings.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"signature": [
|
|
"{ response: any; duration: number; requestType: string; requestParams: Record<string, unknown>; esError: Error; }[]"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.APMPluginSetup",
|
|
"type": "Interface",
|
|
"label": "APMPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMPluginSetup.config$",
|
|
"type": "Object",
|
|
"label": "config$",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/types.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"signature": [
|
|
"Observable",
|
|
"<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",
|
|
"SearchAggregatedTransactionSetting",
|
|
"; 'xpack.apm.metricsInterval': number; }>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMPluginSetup.getApmIndices",
|
|
"type": "Function",
|
|
"label": "getApmIndices",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/types.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ApmIndicesConfig",
|
|
">"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMPluginSetup.createApmEventClient",
|
|
"type": "Function",
|
|
"label": "createApmEventClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/types.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"signature": [
|
|
"(params: { debug?: boolean | undefined; request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>; context: ",
|
|
"ApmPluginRequestHandlerContext",
|
|
"; }) => Promise<{ search<TParams extends ",
|
|
"APMEventESSearchRequest",
|
|
">(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<",
|
|
"InferSearchResponseOf",
|
|
"<TypeOfProcessorEvent<",
|
|
"ValuesType"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/apm/server/types.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |