MySQL 8.3 Reference Manual  /  ...  /  Configuring TRACE Telemetry

35.2.1 跟踪遥测配置

本节描述了服务器和客户端的配置。

服务器配置

以下是服务器跟踪遥测配置变量:

表 35.1 遥测变量摘要

Name Cmd-Line Option File System Var Status Var Var Scope Dynamic
telemetry.live_sessions 全局
telemetry.metrics_reader_frequency_1 全局
telemetry.metrics_reader_frequency_2 全局
telemetry.metrics_reader_frequency_3 全局
telemetry.otel_bsp_max_export_batch_size 全局
telemetry.otel_bsp_max_queue_size 全局
telemetry.otel_bsp_schedule_delay 全局
telemetry.otel_exporter_otlp_metrics_certificates 全局
telemetry.otel_exporter_otlp_metrics_cipher 全局
telemetry.otel_exporter_otlp_metrics_cipher_suite 全局
telemetry.otel_exporter_otlp_metrics_client_certificates 全局
telemetry.otel_exporter_otlp_metrics_client_key 全局
telemetry.otel_exporter_otlp_metrics_compression 全局
telemetry.otel_exporter_otlp_metrics_endpoint 全局
telemetry.otel_exporter_otlp_metrics_headers 全局
telemetry.otel_exporter_otlp_metrics_max_tls 全局
telemetry.otel_exporter_otlp_metrics_min_tls 全局
telemetry.otel_exporter_otlp_metrics_protocol 全局
telemetry.otel_exporter_otlp_metrics_timeout 全局
telemetry.otel_exporter_otlp_traces_certificates 全局
telemetry.otel_exporter_otlp_traces_cipher 全局
telemetry.otel_exporter_otlp_traces_cipher_suite 全局
telemetry.otel_exporter_otlp_traces_client_certificates 全局
telemetry.otel_exporter_otlp_traces_client_key 全局
telemetry.otel_exporter_otlp_traces_compression 全局
telemetry.otel_exporter_otlp_traces_endpoint 全局
telemetry.otel_exporter_otlp_traces_headers 全局
telemetry.otel_exporter_otlp_traces_max_tls 全局
telemetry.otel_exporter_otlp_traces_min_tls 全局
telemetry.otel_exporter_otlp_traces_protocol 全局
telemetry.otel_exporter_otlp_traces_timeout 全局
telemetry.otel_log_level 全局
telemetry.otel_resource_attributes 全局
telemetry.query_text_enabled 全局
telemetry.trace_enabled 全局

客户端配置

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

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

Option Name Description
--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 启用时,打印遥测客户端选项的帮助。
--otel_log_level 控制哪些 OpenTelemetry 日志被打印在服务器日志中
--otel_resource_attributes 请参阅对应的 OpenTelemetry 变量 OTEL_RESOURCE_ATTRIBUTES。
--otel-trace 该系统变量控制是否收集遥测跟踪。

  • 跟踪

    Command-Line Format --otel-trace
    Type 布尔值
    Default Value ON

    控制是否收集遥测跟踪。

  • 帮助

    Command-Line Format --otel-help
    Type 布尔值
    Default Value 关闭

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

  • otel_log_level

    Command-Line Format --otel_log_level
    Type 枚举
    Default Value ERROR
    Valid Values

    ERROR

    SILENT

    WARNING

    INFO

    DEBUG

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

  • otel_resource_attributes

    Command-Line Format --otel_resource_attributes
    Type 字符串
    Default Value

    请参阅相应的 OpenTelemetry 变量 OTEL_RESOURCE_ATTRIBUTES。

  • otel_exporter_otlp_traces_protocol

    Command-Line Format --otel_exporter_otlp_traces_protocol
    Type 枚举
    Default Value http/protobuf
    Valid Values

    http/protobuf

    http/json

    OTLP 传输协议

  • otel_exporter_otlp_traces_endpoint

    Command-Line Format --otel_exporter_otlp_traces_endpoint
    Type 字符串
    Default Value http://localhost:4318/v1/traces

    目标 URL,exporter 将跟踪发送到该 URL

  • otel_exporter_otlp_traces_certificates

    Command-Line Format --otel_exporter_otlp_traces_certificates
    Type 字符串
    Default Value

    当前未使用。未来开发中。

  • otel_exporter_otlp_traces_client_key

    Command-Line Format --otel_exporter_otlp_traces_client_key
    Type 字符串
    Default Value

    当前未使用。未来开发中。

  • otel_exporter_otlp_traces_client_certificates

    Command-Line Format --otel_exporter_otlp_traces_client_certificates
    Type 字符串
    Default Value

    当前未使用。未来开发中。

  • otel_exporter_otlp_traces_headers

    Command-Line Format --otel_exporter_otlp_traces_headers
    Type 字符串
    Default Value

    请参阅相应的 OpenTelemetry 变量 OTEL_EXPORTER_TRACES_HEADERS。

  • otel_exporter_otlp_traces_compression

    Command-Line Format --otel_exporter_otlp_traces_compression
    Type 字符串
    Default Value none
    Valid Values

    none

    gzip

    exporter 使用的压缩方式

  • otel_exporter_otlp_traces_timeout

    Command-Line Format --otel_exporter_otlp_traces_timeout
    Type 整数
    Default Value 10000

    OLTP exporter 等待每批次导出时间

  • otel_bsp_schedule_delay

    Command-Line Format --otel_bsp_schedule_delay
    Type 整数
    Default Value 5000

    两次连续导出之间的延迟间隔,以毫秒为单位

  • otel_bsp_max_queue_size

    Command-Line Format --otel_bsp_max_queue_size
    Type 整数
    Default Value 2048

    最大队列大小

  • otel_bsp_max_export_batch_size

    Command-Line Format --otel_bsp_max_export_batch_size
    Type 整数
    Default Value 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