本节介绍服务器和客户端的配置。
以下列出了服务器跟踪遥测配置变量
-
系统变量 telemetry.trace_enabled范围 全局 动态 是 SET_VAR提示适用否 平台特定 Linux 类型 布尔型 默认值 ON控制是否收集遥测跟踪。
-
系统变量 telemetry.query_text_enabled范围 全局 动态 是 SET_VAR提示适用否 平台特定 Linux 类型 布尔型 默认值 ON控制是否在跟踪中包含 SQL 查询文本。
-
系统变量 telemetry.otel_log_level范围 全局 动态 是 SET_VAR提示适用否 平台特定 Linux 类型 枚举 默认值 ERROR有效值 SILENTINFOERRORWARNINGDEBUG控制在服务器日志中打印哪些 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/protobufhttp/jsonOTLP 传输协议
telemetry.otel_exporter_otlp_traces_endpoint系统变量 telemetry.otel_exporter_otlp_traces_endpoint范围 全局 动态 否 SET_VAR提示适用否 平台特定 Linux 类型 字符串 默认值 https://: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.21.3telemetry.otel_exporter_otlp_traces_max_tls系统变量 telemetry.otel_exporter_otlp_traces_max_tls范围 全局 动态 否 SET_VAR提示适用否 平台特定 Linux 类型 枚举 默认值 [无]有效值 [无]1.21.3telemetry.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有效值 ERRORSILENTWARNINGINFODEBUG控制在服务器日志中打印哪些 OpenTelemetry 日志。
-
命令行格式 --otel_resource_attributes类型 字符串 默认值 请参阅相应的 OpenTelemetry 变量 OTEL_RESOURCE_ATTRIBUTES。
otel_exporter_otlp_traces_protocol命令行格式 --otel_exporter_otlp_traces_protocol类型 枚举 默认值 http/protobuf有效值 http/protobufhttp/jsonOTLP 传输协议
otel_exporter_otlp_traces_endpoint命令行格式 --otel_exporter_otlp_traces_endpoint类型 字符串 默认值 https://: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有效值 nonegzip导出器使用的压缩。
otel_exporter_otlp_traces_timeout命令行格式 --otel_exporter_otlp_traces_timeout类型 整数 默认值 10000OLTP 导出器等待每次批次导出所用的时间。
-
命令行格式 --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。