kibana/api_docs/kbn_apm_config_loader.devdocs.json

{
  "id": "@kbn/apm-config-loader",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [
      {
        "parentPluginId": "@kbn/apm-config-loader",
        "id": "def-server.ApmConfiguration",
        "type": "Class",
        "tags": [],
        "label": "ApmConfiguration",
        "description": [],
        "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.ApmConfiguration.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/apm-config-loader",
                "id": "def-server.ApmConfiguration.Unnamed.$1",
                "type": "string",
                "tags": [],
                "label": "rootDir",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/apm-config-loader",
                "id": "def-server.ApmConfiguration.Unnamed.$2",
                "type": "Object",
                "tags": [],
                "label": "rawKibanaConfig",
                "description": [],
                "signature": [
                  "KibanaRawConfig"
                ],
                "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/apm-config-loader",
                "id": "def-server.ApmConfiguration.Unnamed.$3",
                "type": "boolean",
                "tags": [],
                "label": "isDistributable",
                "description": [],
                "signature": [
                  "boolean"
                ],
                "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.ApmConfiguration.getConfig",
            "type": "Function",
            "tags": [],
            "label": "getConfig",
            "description": [],
            "signature": [
              "(serviceName: string) => ",
              "AgentConfigOptions"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/apm-config-loader",
                "id": "def-server.ApmConfiguration.getConfig.$1",
                "type": "string",
                "tags": [],
                "label": "serviceName",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.ApmConfiguration.isUsersRedactionEnabled",
            "type": "Function",
            "tags": [],
            "label": "isUsersRedactionEnabled",
            "description": [],
            "signature": [
              "() => boolean"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [
      {
        "parentPluginId": "@kbn/apm-config-loader",
        "id": "def-server.getConfiguration",
        "type": "Function",
        "tags": [],
        "label": "getConfiguration",
        "description": [],
        "signature": [
          "(serviceName: string) => ",
          "AgentConfigOptions",
          " | undefined"
        ],
        "path": "src/platform/packages/private/kbn-apm-config-loader/src/config_loader.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.getConfiguration.$1",
            "type": "string",
            "tags": [],
            "label": "serviceName",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/config_loader.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/apm-config-loader",
        "id": "def-server.initApm",
        "type": "Function",
        "tags": [],
        "label": "initApm",
        "description": [],
        "signature": [
          "(argv: string[], rootDir: string, isDistributable: boolean, serviceName: string) => void"
        ],
        "path": "src/platform/packages/private/kbn-apm-config-loader/src/init_apm.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.initApm.$1",
            "type": "Array",
            "tags": [],
            "label": "argv",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/init_apm.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.initApm.$2",
            "type": "string",
            "tags": [],
            "label": "rootDir",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/init_apm.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.initApm.$3",
            "type": "boolean",
            "tags": [],
            "label": "isDistributable",
            "description": [],
            "signature": [
              "boolean"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/init_apm.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.initApm.$4",
            "type": "string",
            "tags": [],
            "label": "serviceName",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/init_apm.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/apm-config-loader",
        "id": "def-server.shouldInstrumentClient",
        "type": "Function",
        "tags": [],
        "label": "shouldInstrumentClient",
        "description": [],
        "signature": [
          "(config: ",
          "AgentConfigOptions",
          " | undefined) => boolean"
        ],
        "path": "src/platform/packages/private/kbn-apm-config-loader/src/rum_agent_configuration.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/apm-config-loader",
            "id": "def-server.shouldInstrumentClient.$1",
            "type": "Object",
            "tags": [],
            "label": "config",
            "description": [],
            "signature": [
              "AgentConfigOptions",
              " | undefined"
            ],
            "path": "src/platform/packages/private/kbn-apm-config-loader/src/rum_agent_configuration.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [
      {
        "parentPluginId": "@kbn/apm-config-loader",
        "id": "def-server.apmConfigSchema",
        "type": "Object",
        "tags": [],
        "label": "apmConfigSchema",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.ObjectType",
            "text": "ObjectType"
          },
          "<ExtendedProps<{ active: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<boolean | undefined>; serverUrl: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<string | undefined>; secretToken: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<string | undefined>; apiKey: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<string | undefined>; environment: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<string | undefined>; globalLabels: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<Readonly<{} & {}> | undefined>; }, { servicesOverrides: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<Record<string, Readonly<{ apiKey?: string | undefined; active?: boolean | undefined; environment?: string | undefined; serverUrl?: string | undefined; secretToken?: string | undefined; globalLabels?: Readonly<{} & {}> | undefined; } & {}>> | undefined>; redactUsers: ",
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<boolean | undefined>; }>>"
        ],
        "path": "src/platform/packages/private/kbn-apm-config-loader/src/apm_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ]
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}