{ "id": "apmOss", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "apmOss", "id": "def-public.APM_STATIC_INDEX_PATTERN_ID", "type": "string", "tags": [], "label": "APM_STATIC_INDEX_PATTERN_ID", "description": [], "signature": [ "\"apm_static_index_pattern_id\"" ], "source": { "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", "lineNumber": 9 }, "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "apmOss", "id": "def-public.ApmOssPluginSetup", "type": "Interface", "tags": [], "label": "ApmOssPluginSetup", "description": [], "source": { "path": "src/plugins/apm_oss/public/types.ts", "lineNumber": 10 }, "deprecated": false, "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "apmOss", "id": "def-public.ApmOssPluginStart", "type": "Interface", "tags": [], "label": "ApmOssPluginStart", "description": [], "source": { "path": "src/plugins/apm_oss/public/types.ts", "lineNumber": 13 }, "deprecated": false, "children": [], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [ { "parentPluginId": "apmOss", "id": "def-server.createDjangoAgentInstructions", "type": "Function", "tags": [], "label": "createDjangoAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 88 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createDjangoAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 88 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createDjangoAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 88 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createDotNetAgentInstructions", "type": "Function", "tags": [], "label": "createDotNetAgentInstructions", "description": [], "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; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 631 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createDotNetAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 631 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createDotNetAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 631 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createFlaskAgentInstructions", "type": "Function", "tags": [], "label": "createFlaskAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 173 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createFlaskAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 173 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createFlaskAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 173 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createGoAgentInstructions", "type": "Function", "tags": [], "label": "createGoAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 492 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createGoAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 492 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createGoAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 492 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createJavaAgentInstructions", "type": "Function", "tags": [], "label": "createJavaAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 585 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createJavaAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 585 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createJavaAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 585 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createJsAgentInstructions", "type": "Function", "tags": [], "label": "createJsAgentInstructions", "description": [], "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; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 393 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createJsAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 393 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createNodeAgentInstructions", "type": "Function", "tags": [], "label": "createNodeAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 11 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createNodeAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 11 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createNodeAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 11 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createPhpAgentInstructions", "type": "Function", "tags": [], "label": "createPhpAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 705 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createPhpAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 705 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createPhpAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 705 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createRackAgentInstructions", "type": "Function", "tags": [], "label": "createRackAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 298 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createRackAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 298 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createRackAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 298 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.createRailsAgentInstructions", "type": "Function", "tags": [], "label": "createRailsAgentInstructions", "description": [], "signature": [ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 255 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.createRailsAgentInstructions.$1", "type": "string", "tags": [], "label": "apmServerUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 255 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "apmOss", "id": "def-server.createRailsAgentInstructions.$2", "type": "string", "tags": [], "label": "secretToken", "description": [], "signature": [ "string" ], "source": { "path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts", "lineNumber": 255 }, "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "apmOss", "id": "def-server.APM_STATIC_INDEX_PATTERN_ID", "type": "string", "tags": [], "label": "APM_STATIC_INDEX_PATTERN_ID", "description": [], "signature": [ "\"apm_static_index_pattern_id\"" ], "source": { "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", "lineNumber": 9 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "apmOss", "id": "def-server.APMOSSConfig", "type": "Type", "tags": [], "label": "APMOSSConfig", "description": [], "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; }" ], "source": { "path": "src/plugins/apm_oss/server/index.ts", "lineNumber": 32 }, "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup", "type": "Interface", "tags": [], "label": "APMOSSPluginSetup", "description": [], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 47 }, "deprecated": false, "children": [ { "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup.config", "type": "Object", "tags": [], "label": "config", "description": [], "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; }" ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 48 }, "deprecated": false }, { "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup.config$", "type": "Object", "tags": [], "label": "config$", "description": [], "signature": [ "Observable", ">" ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 49 }, "deprecated": false }, { "parentPluginId": "apmOss", "id": "def-server.APMOSSPluginSetup.getRegisteredTutorialProvider", "type": "Function", "tags": [], "label": "getRegisteredTutorialProvider", "description": [], "signature": [ "() => ", { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.TutorialProvider", "text": "TutorialProvider" } ], "source": { "path": "src/plugins/apm_oss/server/plugin.ts", "lineNumber": 50 }, "deprecated": false, "children": [], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }