MySQL 8.4 参考手册  /  ...  /  配置跟踪遥测

35.3.1 配置跟踪遥测

本节介绍服务器和客户端的配置。

服务器配置

以下列出了服务器跟踪遥测配置变量

客户端配置

MySQL 客户端从配置文件的 [telemetry_client] 部分读取遥测配置。有关 telemetry_client 选项的信息,请参阅 安装客户端插件。以下配置选项可用

表 35.2 mysql 客户端遥测选项摘要

选项名称 描述
--telemetry_client 启用遥测客户端。
--otel_bsp_max_export_batch_size 请参阅变量 OTEL_BSP_MAX_EXPORT_BATCH_SIZE。
--otel_bsp_max_queue_size 请参阅变量 OTEL_BSP_MAX_QUEUE_SIZE。
--otel_bsp_schedule_delay 请参阅变量 OTEL_BSP_SCHEDULE_DELAY。
--otel_exporter_otlp_traces_certificates 目前未启用。为将来开发保留。
--otel_exporter_otlp_traces_client_certificates 目前未启用。为将来开发保留。
--otel_exporter_otlp_traces_client_key 目前未启用。为将来开发保留。
--otel_exporter_otlp_traces_compression 压缩类型
--otel_exporter_otlp_traces_endpoint 跟踪导出端点。
--otel_exporter_otlp_traces_headers 用作与 HTTP 请求关联的标头的键值对。
--otel_exporter_otlp_traces_protocol OTLP 传输协议。
--otel_exporter_otlp_traces_timeout OLTP 导出器等待每次批次导出所用的时间。
--otel-help 启用时,打印有关 telemetry_client 选项的帮助信息。
--otel_log_level 控制在服务器日志中打印哪些 opentelemetry 日志。
--otel_resource_attributes 请参阅相应的 OpenTelemetry 变量 OTEL_RESOURCE_ATTRIBUTES。
--otel-trace 此系统变量控制是否收集遥测跟踪。

  • trace

    命令行格式 --otel-trace
    类型 布尔型
    默认值 ON

    控制是否收集遥测跟踪。

  • help

    命令行格式 --otel-help
    类型 布尔型
    默认值 OFF

    启用时,打印有关 telemetry_client 选项的帮助信息。

  • otel_log_level

    命令行格式 --otel_log_level
    类型 枚举
    默认值 ERROR
    有效值

    ERROR

    SILENT

    WARNING

    INFO

    DEBUG

    控制在服务器日志中打印哪些 OpenTelemetry 日志。

  • otel_resource_attributes

    命令行格式 --otel_resource_attributes
    类型 字符串
    默认值

    请参阅相应的 OpenTelemetry 变量 OTEL_RESOURCE_ATTRIBUTES。

  • otel_exporter_otlp_traces_protocol

    命令行格式 --otel_exporter_otlp_traces_protocol
    类型 枚举
    默认值 http/protobuf
    有效值

    http/protobuf

    http/json

    OTLP 传输协议

  • otel_exporter_otlp_traces_endpoint

    命令行格式 --otel_exporter_otlp_traces_endpoint
    类型 字符串
    默认值 https://127.0.0.1:4318/v1/traces

    导出器发送跟踪的目标 URL。

  • otel_exporter_otlp_traces_certificates

    命令行格式 --otel_exporter_otlp_traces_certificates
    类型 字符串
    默认值

    在验证服务器的 TLS 证书时要使用的受信任证书。

  • otel_exporter_otlp_traces_client_key

    命令行格式 --otel_exporter_otlp_traces_client_key
    类型 字符串
    默认值

    客户端的私钥(PEM 格式)。

  • otel_exporter_otlp_traces_client_certificates

    命令行格式 --otel_exporter_otlp_traces_client_certificates
    类型 字符串
    默认值

    客户端证书/链信任(用于客户端私钥,PEM 格式)。

  • otel_exporter_otlp_traces_headers

    命令行格式 --otel_exporter_otlp_traces_headers
    类型 字符串
    默认值

    请参阅相应的 OpenTelemetry 变量 OTEL_EXPORTER_TRACES_HEADERS。

  • otel_exporter_otlp_traces_compression

    命令行格式 --otel_exporter_otlp_traces_compression
    类型 字符串
    默认值 none
    有效值

    none

    gzip

    导出器使用的压缩。

  • otel_exporter_otlp_traces_timeout

    命令行格式 --otel_exporter_otlp_traces_timeout
    类型 整数
    默认值 10000

    OLTP 导出器等待每次批次导出所用的时间。

  • otel_bsp_schedule_delay

    命令行格式 --otel_bsp_schedule_delay
    类型 整数
    默认值 5000

    两次连续导出之间的延迟间隔(毫秒)。

  • otel_bsp_max_queue_size

    命令行格式 --otel_bsp_max_queue_size
    类型 整数
    默认值 2048

    最大队列大小。

  • otel_bsp_max_export_batch_size

    命令行格式 --otel_bsp_max_export_batch_size
    类型 整数
    默认值 512

    最大批次大小。

客户端配置示例

以下是包含客户端遥测插件配置的 my.cnf 配置文件示例

[mysql]

telemetry-client = ON

[telemetry_client]
help = ON
trace = OFF
otel-resource-attributes = "RK1=RV1, RK2=RV2, RK3=RV3"
otel-log-level = "error"
otel-exporter-otlp-traces-headers = "K1=V1, K2=V2"
otel-exporter-otlp-traces-protocol = "http/json"

如果在配置文件中设置了 telemetry-client = ON,则在启动客户端时无需指定 --telemetry-client