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
    類型 布林值
    預設值 開啟

    控制是否收集遙測追蹤。

  • help

    命令列格式 --otel-help
    類型 布林值
    預設值 關閉

    啟用時,會列印關於 telemetry_client 選項的說明。

  • otel_log_level

    命令列格式 --otel_log_level
    類型 列舉
    預設值 錯誤
    有效值

    錯誤

    靜音

    警告

    資訊

    偵錯

    控制哪些 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
    類型 字串
    預設值
    有效值

    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