cecdcc538e
* Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs
597 lines
19 KiB
JSON
597 lines
19 KiB
JSON
{
|
|
"id": "apmOss",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.APM_STATIC_INDEX_PATTERN_ID",
|
|
"type": "string",
|
|
"label": "APM_STATIC_INDEX_PATTERN_ID",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/common/index_pattern_constants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"signature": [
|
|
"\"apm_static_index_pattern_id\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.ApmOssPluginSetup",
|
|
"type": "Interface",
|
|
"label": "ApmOssPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/public/types.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.ApmOssPluginStart",
|
|
"type": "Interface",
|
|
"label": "ApmOssPluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/public/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.createDjangoAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 88
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 88
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createDjangoAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 88
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createDotNetAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 631
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 631
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; commands: string[]; textPost: string; textPre?: undefined; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createDotNetAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 631
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createFlaskAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 173
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 173
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createFlaskAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 173
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createGoAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 492
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 492
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createGoAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 492
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createJavaAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 585
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 585
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createJavaAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 585
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createJsAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 393
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; textPre: string; commands: string[]; textPost?: undefined; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createJsAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 393
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createNodeAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 11
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 11
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createNodeAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createPhpAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 705
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 705
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createPhpAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 705
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createRackAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 298
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 298
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createRackAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 298
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.createRailsAgentInstructions",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "apmServerUrl",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 255
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "secretToken",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 255
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"
|
|
],
|
|
"description": [],
|
|
"label": "createRailsAgentInstructions",
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
|
|
"lineNumber": 255
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APM_STATIC_INDEX_PATTERN_ID",
|
|
"type": "string",
|
|
"label": "APM_STATIC_INDEX_PATTERN_ID",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/common/index_pattern_constants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"signature": [
|
|
"\"apm_static_index_pattern_id\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.APMOSSConfig",
|
|
"type": "Type",
|
|
"label": "APMOSSConfig",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/index.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"signature": [
|
|
"{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.APMOSSPluginSetup",
|
|
"type": "Interface",
|
|
"label": "APMOSSPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMOSSPluginSetup.config",
|
|
"type": "Object",
|
|
"label": "config",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/plugin.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"signature": [
|
|
"Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.APMOSSPluginSetup.config$",
|
|
"type": "Object",
|
|
"label": "config$",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/plugin.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"signature": [
|
|
"Observable",
|
|
"<Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>>"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-server.APMOSSPluginSetup.getRegisteredTutorialProvider",
|
|
"type": "Function",
|
|
"label": "getRegisteredTutorialProvider",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "server",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-server.TutorialProvider",
|
|
"text": "TutorialProvider"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/plugin.ts",
|
|
"lineNumber": 50
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/apm_oss/server/plugin.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |