本节描述服务器和客户端的配置。
以下是服务器跟踪遥测配置变量
-
系统变量 telemetry.trace_enabled
范围 全局 动态 是 SET_VAR
提示适用否 平台特定 Linux 类型 布尔 默认值 ON
控制是否收集遥测跟踪。
-
系统变量 telemetry.query_text_enabled
范围 全局 动态 是 SET_VAR
提示适用否 平台特定 Linux 类型 布尔 默认值 ON
控制是否在跟踪中包含 SQL 查询文本。
-
系统变量 telemetry.otel_log_level
范围 全局 动态 是 SET_VAR
提示适用否 平台特定 Linux 类型 枚举 默认值 ERROR
有效值 SILENT
INFO
ERROR
WARNING
DEBUG
控制在服务器日志中打印哪些 OpenTelemetry 日志。
telemetry.otel_resource_attributes
系统变量 telemetry.otel_resource_attributes
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 空
参见相应的 OpenTelemetry 变量 OTEL_RESOURCE_ATTRIBUTES。
telemetry.otel_exporter_otlp_traces_protocol
系统变量 telemetry.otel_exporter_otlp_traces_protocol
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 枚举 默认值 http/protobuf
有效值 http/protobuf
http/json
OTLP 传输协议。
telemetry.otel_exporter_otlp_traces_endpoint
系统变量 telemetry.otel_exporter_otlp_traces_endpoint
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 https://127.0.0.1:4318/v1/traces
导出器发送跟踪的目标 URL。
telemetry.otel_exporter_otlp_traces_certificates
系统变量 telemetry.otel_exporter_otlp_traces_certificates
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 在验证服务器的 TLS 证书时要使用的受信任证书。
telemetry.otel_exporter_otlp_traces_client_key
系统变量 telemetry.otel_exporter_otlp_traces_client_key
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 客户端的私钥,以 PEM 格式表示。
telemetry.otel_exporter_otlp_traces_client_certificates
系统变量 telemetry.otel_exporter_otlp_traces_client_certificates
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 客户端证书/链信任,用于客户端私钥,以 PEM 格式表示。
telemetry.otel_exporter_otlp_traces_headers
系统变量 telemetry.otel_exporter_otlp_traces_headers
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 空
参见相应的 OpenTelemetry 变量 OTEL_EXPORTER_TRACES_HEADERS。
telemetry.otel_exporter_otlp_traces_compression
系统变量 telemetry.otel_exporter_otlp_traces_compression
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 none (无压缩)
有效值 none (无压缩)
gzip
导出器使用的压缩。
telemetry.otel_exporter_otlp_traces_timeout
系统变量 telemetry.otel_exporter_otlp_traces_timeout
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 整数 默认值 10000
单位 毫秒 OLTP 导出器等待每个批处理导出所需的时间(毫秒)。
telemetry.otel_bsp_schedule_delay
系统变量 telemetry.otel_bsp_schedule_delay
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 整数 默认值 5000
单位 毫秒 两次连续导出之间的延迟间隔(毫秒)。
telemetry.otel_bsp_max_queue_size
系统变量 telemetry.otel_bsp_max_queue_size
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 整数 默认值 2048
最大队列大小。
telemetry.otel_bsp_max_export_batch_size
系统变量 telemetry.otel_bsp_max_export_batch_size
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 整数 默认值 512
最大批处理大小。
telemetry.otel_exporter_otlp_traces_min_tls
系统变量 telemetry.otel_exporter_otlp_traces_min_tls
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 枚举 默认值 [无]
有效值 [无]
1.2
1.3
telemetry.otel_exporter_otlp_traces_max_tls
系统变量 telemetry.otel_exporter_otlp_traces_max_tls
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 枚举 默认值 [无]
有效值 [无]
1.2
1.3
telemetry.otel_exporter_otlp_traces_cipher
系统变量 telemetry.otel_exporter_otlp_traces_cipher
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 [无]
telemetry.otel_exporter_otlp_traces_cipher_suite
系统变量 telemetry.otel_exporter_otlp_traces_cipher_suite
范围 全局 动态 否 SET_VAR
提示适用否 平台特定 Linux 类型 字符串 默认值 [无]
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 | 此系统变量控制是否收集遥测跟踪。 |
-
命令行格式 --otel-trace
类型 布尔 默认值 ON
控制是否收集遥测跟踪。
-
命令行格式 --otel-help
类型 布尔 默认值 OFF
启用时,打印有关 telemetry_client 选项的帮助信息。
-
命令行格式 --otel_log_level
类型 枚举 默认值 ERROR
有效值 ERROR
SILENT
WARNING
INFO
DEBUG
控制在服务器日志中打印哪些 OpenTelemetry 日志。
-
命令行格式 --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
类型 整数 默认值 5000
两次连续导出之间的延迟间隔(毫秒)。
-
命令行格式 --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
。