kibana/api_docs/kbn_telemetry.devdocs.json

{
  "id": "@kbn/telemetry",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/telemetry",
        "id": "def-server.initTelemetry",
        "type": "Function",
        "tags": [],
        "label": "initTelemetry",
        "description": [
          "\n\nInitializes OpenTelemetry (currently only tracing)\n"
        ],
        "signature": [
          "(argv: string[], rootDir: string, isDistributable: boolean, serviceName: string) => () => Promise<void>"
        ],
        "path": "src/platform/packages/shared/kbn-telemetry/src/init_telemetry.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/telemetry",
            "id": "def-server.initTelemetry.$1",
            "type": "Array",
            "tags": [],
            "label": "argv",
            "description": [
              "Process arguments"
            ],
            "signature": [
              "string[]"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry/src/init_telemetry.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/telemetry",
            "id": "def-server.initTelemetry.$2",
            "type": "string",
            "tags": [],
            "label": "rootDir",
            "description": [
              "Root dir of Kibana repo"
            ],
            "signature": [
              "string"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry/src/init_telemetry.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/telemetry",
            "id": "def-server.initTelemetry.$3",
            "type": "boolean",
            "tags": [],
            "label": "isDistributable",
            "description": [
              "Whether this is a distributable build"
            ],
            "signature": [
              "boolean"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry/src/init_telemetry.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/telemetry",
            "id": "def-server.initTelemetry.$4",
            "type": "string",
            "tags": [],
            "label": "serviceName",
            "description": [
              "The service name used in resource attributes"
            ],
            "signature": [
              "string"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry/src/init_telemetry.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [
          "A function that can be called on shutdown and allows exporters to flush their queue."
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/telemetry",
        "id": "def-server.setDiagLogger",
        "type": "Function",
        "tags": [],
        "label": "setDiagLogger",
        "description": [],
        "signature": [
          "(logger: ",
          {
            "pluginId": "@kbn/logging",
            "scope": "common",
            "docId": "kibKbnLoggingPluginApi",
            "section": "def-common.Logger",
            "text": "Logger"
          },
          ", logLevel: ",
          "LogLevelId",
          " | undefined) => void"
        ],
        "path": "src/platform/packages/shared/kbn-telemetry/src/set_diag_logger.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/telemetry",
            "id": "def-server.setDiagLogger.$1",
            "type": "Object",
            "tags": [],
            "label": "logger",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/logging",
                "scope": "common",
                "docId": "kibKbnLoggingPluginApi",
                "section": "def-common.Logger",
                "text": "Logger"
              }
            ],
            "path": "src/platform/packages/shared/kbn-telemetry/src/set_diag_logger.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/telemetry",
            "id": "def-server.setDiagLogger.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "logLevel",
            "description": [],
            "signature": [
              "LogLevelId",
              " | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry/src/set_diag_logger.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}