maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/apm_oss.json
Stacey Gammon 87a5b22626
API DOCS Step 3/3 (#92929) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-02 22:02:17 -05:00

635 lines
24 KiB
JSON
Raw Blame History

{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L10"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L13"
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 173,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 298,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 492,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 585,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 631,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"
}
},
{
"type": "string",
"label": "secretToken",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts",
"lineNumber": 705,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"
}
}
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-server.APMOSSConfig",
"type": "Type",
"label": "APMOSSConfig",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/apm_oss/server/index.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/index.ts#L32"
},
"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
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9"
},
"signature": [
"\"apm_static_index_pattern_id\""
],
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L48"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L49"
},
"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,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L50"
}
}
],
"source": {
"path": "src/plugins/apm_oss/server/plugin.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L47"
},
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink