kibana/api_docs/kbn_telemetry_config.devdocs.json

{
  "id": "@kbn/telemetry-config",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "@kbn/telemetry-config",
        "id": "def-common.TelemetryConfig",
        "type": "Interface",
        "tags": [],
        "label": "TelemetryConfig",
        "description": [
          "\nConfiguration for OpenTelemetry"
        ],
        "path": "src/platform/packages/shared/kbn-telemetry-config/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/telemetry-config",
            "id": "def-common.TelemetryConfig.tracing",
            "type": "Object",
            "tags": [],
            "label": "tracing",
            "description": [
              "\nTracing config. See {@link TracingConfig}."
            ],
            "signature": [
              {
                "pluginId": "@kbn/telemetry-config",
                "scope": "common",
                "docId": "kibKbnTelemetryConfigPluginApi",
                "section": "def-common.TracingConfig",
                "text": "TracingConfig"
              },
              " | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry-config/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/telemetry-config",
            "id": "def-common.TelemetryConfig.enabled",
            "type": "CompoundType",
            "tags": [],
            "label": "enabled",
            "description": [
              "\nWhether telemetry collection is enabled."
            ],
            "signature": [
              "boolean | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry-config/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/telemetry-config",
        "id": "def-common.TracingConfig",
        "type": "Interface",
        "tags": [],
        "label": "TracingConfig",
        "description": [
          "\nConfiguration for OpenTelemetry tracing"
        ],
        "path": "src/platform/packages/shared/kbn-telemetry-config/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/telemetry-config",
            "id": "def-common.TracingConfig.enabled",
            "type": "CompoundType",
            "tags": [],
            "label": "enabled",
            "description": [
              "\nWhether OpenTelemetry tracing is enabled."
            ],
            "signature": [
              "boolean | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-telemetry-config/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/telemetry-config",
            "id": "def-common.TracingConfig.sample_rate",
            "type": "number",
            "tags": [],
            "label": "sample_rate",
            "description": [
              "\nAt which rate spans get sampled if a sampling decision\nneeds to be made. Should be between 0-1."
            ],
            "path": "src/platform/packages/shared/kbn-telemetry-config/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [
      {
        "parentPluginId": "@kbn/telemetry-config",
        "id": "def-common.telemetryTracingSchema",
        "type": "Object",
        "tags": [],
        "label": "telemetryTracingSchema",
        "description": [
          "\nThe tracing config schema that is exposed by the Telemetry plugin."
        ],
        "signature": [
          {
            "pluginId": "@kbn/config-schema",
            "scope": "common",
            "docId": "kibKbnConfigSchemaPluginApi",
            "section": "def-common.Type",
            "text": "Type"
          },
          "<",
          {
            "pluginId": "@kbn/telemetry-config",
            "scope": "common",
            "docId": "kibKbnTelemetryConfigPluginApi",
            "section": "def-common.TracingConfig",
            "text": "TracingConfig"
          },
          ">"
        ],
        "path": "src/platform/packages/shared/kbn-telemetry-config/src/config_schema.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ]
  }
}