配置 OpenTelemetry 适配器

  1. 在主视图上,前往设置选项卡,并在左窗格上选择服务器连接

  2. Open Telemetry 窗口中,配置以下参数:

    字段

    描述

    开/关

    启用/禁用适配器。

    暴露敏感数据

    启用/禁用向客户端导出敏感数据(如 IP 和 IMEI)。

    启用 Prometheus 抓取

    启用用于 Prometheus 抓取端点 /metrics 的 HTTP 服务器。

    Prometheus 端口

    配置 HTTP 服务器监听的端口。

    此设置仅在 Prometheus 启用时可见。

    Prometheus 认证

    为 Prometheus 抓取启用基本认证。

    此设置仅在 Prometheus 启用时可见。

    用户名称

    输入抓取时使用的用户名。

    此设置仅在 Prometheus 认证启用时可见。

    密码

    输入抓取时使用的密码。密码将以明文形式显示。

    此设置仅在 Prometheus 认证启用时可见。

    启用 OTLP/HTTP 推送

    启用 OTLP/HTTP 导出器以开始发送定期更新。

    OTLP 指标 URL

    输入导出器应以 protobuf 格式发送数据的 OTLP/HTTP 指标端点。

    此设置仅在 OTLP 启用时可见。

    更新周期

    适配器从工具/控制器轮询指标数据的间隔,同时也是适配器将这些数据导出到 OTLP/HTTP 端点的更新间隔。

    适配器将 IAM 名称下配置的控制器名称作为服务名称附加到消息中。如果 IAM 名称为空,服务名称将导出为 px2system

Prometheus 信息指标

静态系统信息作为 OpenTelemetry 信息指标发送。随后数据在标签中可用。

Prometheus 指标语义

指标

类型

单位

描述

px2system_device_info

gauge

1

以常量值为 1 的 *_infostyle 指标导出的静态 px2system 元数据。

cellular_enabled

gauge

1

如果控制器配置中启用了蜂窝,则为 1;如果存在但已禁用,则为 0。仅在蜂窝存在时发出。

cellular_connection_info

gauge

1

仅当蜂窝存在且已启用时发出,常量值为 1。

cellular_up

gauge

1

如果最新的蜂窝遥测样本有效且所有值均为数字,则为 1;否则为 0。当蜂窝存在且已启用时发出(样本可能缺失),如果蜂窝未连接则为 0。

cellular_signal_sample_age_seconds

gauge

s

最新蜂窝样本的年龄(秒)。如果无可用样本或样本过期/无效,则为 -1。

cellular_signal_rsrp_dbm

gauge

dBm

参考信号接收功率。仅在 cellular_signal_up==1 时发出。

cellular_signal_rsrq_db

gauge

dB

参考信号接收质量。仅在蜂窝存在、已启用且已连接时发出。

cellular_signal_rssi_dbm

gauge

dBm

接收信号强度指示器。仅在蜂窝存在、已启用且已连接时发出。

cellular_signal_snr_db

gauge

dB

信噪比。仅在蜂窝存在、已启用且已连接时发出。

cellular_signal_tx_dbm

gauge

dBm

发射功率。仅在蜂窝存在、已启用且已连接时发出。

wifi_enabled

gauge

1

如果控制器配置中启用了 WiFi 客户端,则为 1;如果存在但已禁用,则为 0。仅在 WiFi 客户端存在时发出。

wifi_connection_info

gauge

1

仅当 WiFi 存在且已启用并且存在 WiFi 样本时发出,常量值为 1。

wifi_up

gauge

1

如果最新的 WiFi 样本有效且值均为数字,则为 1;否则为 0。当 WiFi 存在且已启用时发出(样本可能缺失)。如果 WiFi 未连接则为 0。

wifi_signal_sample_age_seconds

gauge

s

最新 WiFi 样本的年龄(秒)。如果无可用样本或样本过期/无效,则为 -1。

wifi_signal_rssi_dbm

gauge

dBm

WiFi 接收信号强度指示器。仅在 WiFi 存在、已启用且已连接时发出。

wifi_link_quality_percent

gauge

%

WiFi 链路质量。仅在 WiFi 存在、已启用且已连接时发出。

wifi_tx_bitrate_mbps

gauge

Mbit/s

WiFi 协商的最大发送比特率。仅在 WiFi 存在、已启用且已连接时发出。

wifi_rx_bitrate_mbps

gauge

Mbit/s

WiFi 协商的最大接收比特率。仅在 WiFi 存在、已启用且已连接时发出。

Prometheus 信息指标和标签

指标

标签键

敏感

备注

px2system_device_info

service_name

配置的 IAM 名称,如果为空则发出为“px2system”。

px2system_device_info

tool_serial

工具标识符。当工具标识符可用时发出。

px2system_device_info

tool_model

工具型号标识符。当工具标识符可用时发出。

cellular_connection_info

technology

示例值:“4G”,“5G”。当蜂窝启用时发出。

cellular_connection_info

pci

物理小区 ID。当从调制解调器可用时发出。

cellular_connection_info

carrier_name

运营商名称。当从调制解调器可用时发出。

cellular_connection_info

carrier_mcc

移动国家码。当从调制解调器可用时发出。

cellular_connection_info

carrier_mnc

移动网络码。当从调制解调器可用时发出。

cellular_connection_info

apn

配置的接入点名称;受 exposeSensitiveData 控制。

cellular_connection_info

ip_address

蜂窝调制解调器使用的 IP 地址;受敏感数据暴露控制。

cellular_connection_info

imei

调制解调器的国际移动设备识别码;受敏感数据暴露控制。

cellular_connection_info

sim_iccid

SIM 序列号;仅当存在时;受敏感数据暴露控制。

cellular_connection_info

frequency_band

蜂窝调制解调器使用的频段。当从调制解调器可用时发出。

cellular_connection_info

bandwidth

蜂窝调制解调器使用的带宽。当从调制解调器可用时发出。

cellular_connection_info

mtu

最大传输单元。当从调制解调器可用时发出。

cellular_connection_info

imsi

SIM 国际移动用户识别码;受敏感数据暴露控制。

wifi_connection_info

channel

WiFi 信道。当从系统可用时发出。

wifi_connection_info

ssid

WiFi 网络的唯一名称;受敏感数据暴露控制。

wifi_connection_info

bssid

唯一接入点的唯一 MAC 地址;受敏感数据暴露控制。

wifi_connection_info

mac_address

WiFi 网卡的 MAC 地址;受敏感数据暴露控制。

wifi_connection_info

ipv4

WiFi 使用的 IP 地址;受敏感数据暴露控制。

OTLP/HTTP 信息指标

OTLP 指标名称映射

指标

单位

描述

cellular.enabled

1

如果控制器配置中启用了蜂窝,则为 1;否则为 0。仅在蜂窝存在时发出。

cellular.up

1

如果最新的蜂窝样本为数字,则为 1;否则为 0。当蜂窝存在且已启用时发出;如果样本缺失/无效,可能发出为 0,表示未连接。

cellular.signal.sample_age

s

最新蜂窝样本的年龄(秒)。如果样本缺失/无效,则为 -1。

cellular.signal.rsrp

dBm

参考信号接收功率。仅当样本为数字且蜂窝存在、已启用并已连接时发出。

cellular.signal.rsrq

dB

参考信号接收质量。仅当样本为数字且蜂窝存在、已启用并已连接时发出。

cellular.signal.rssi

dBm

接收信号强度指示器。仅当样本为数字且蜂窝存在、已启用并已连接时发出。

cellular.signal.snr

dB

信噪比。仅当样本为数字且蜂窝存在、已启用并已连接时发出。

cellular.signal.tx_power

dBm

发射功率。仅当样本为数字且蜂窝存在、已启用并已连接时发出。

wifi.enabled

1

如果控制器配置中启用了 WiFi 客户端,则为 1;否则为 0。仅在 WiFi 客户端存在时发出。

wifi.up

1

如果最新的 WiFi 样本为数字,则为 1;否则为 0。当 WiFi 存在且已启用时发出;如果样本缺失/无效,可能发出为 0,表示未连接。

wifi.signal.sample_age

s

最新 WiFi 样本的年龄(秒)。如果样本缺失/无效,则为 -1。

wifi.signal.rssi

dBm

WiFi 接收信号强度指示器。仅当样本为数字且 WiFi 存在、已启用并已连接时发出。

wifi.link.quality

%

WiFi 链路质量。仅当样本为数字且 WiFi 存在、已启用并已连接时发出。

wifi.link.tx_bitrate

Mbit/s

WiFi 协商的最大发送比特率。仅当样本为数字且 WiFi 存在、已启用并已连接时发出。

wifi.link.rx_bitrate

Mbit/s

WiFi 协商的最大接收比特率。仅当样本为数字且 WiFi 存在、已启用并已连接时发出。

OTLP 资源属性

敏感

备注

service.name

配置的 IAM 名称,如果为空则发出为“px2system”。

tool.serial_number

工具序列号。仅当至少一个域存在且已启用,并且工具序列号可用时发出。

tool.model

工具型号。仅当至少一个域存在且已启用,并且工具型号可用时发出。

cellular.present

当蜂窝存在时发出为“true”(即使已禁用)。如果系统中不存在蜂窝,则发出为 false。

cellular.radio.tech

示例值:“4G”,“5G”。当可用且蜂窝已启用时发出。

cellular.carrier.name

运营商名称。当可用且蜂窝已启用时发出。

cellular.carrier.mcc

移动国家码。当可用且蜂窝已启用时发出。

cellular.carrier.mnc

移动网络码。当可用且蜂窝已启用时发出。

cellular.frequency.band

蜂窝频段。当可用且蜂窝已启用时发出。

cellular.frequency.bandwidth

蜂窝带宽。当可用且蜂窝已启用时发出。

cellular.link.mtu

最大传输单元。当可用且蜂窝已启用时发出。

cellular.pci

物理小区标识。当可用且蜂窝已启用时发出。

cellular.ip

蜂窝调制解调器的 IP 地址。当蜂窝启用时发出。受敏感数据暴露控制。

cellular.apn

配置的接入点名称。当蜂窝启用时发出。受敏感数据暴露控制。

cellular.imei

调制解调器的国际移动设备识别码。当蜂窝启用时发出。受敏感数据暴露控制。

cellular.imsi

SIM 国际移动用户识别码。当蜂窝启用时发出。受敏感数据暴露控制。

cellular.sim.iccid

SIM 序列号。仅当存在时;当蜂窝已启用时发出。受敏感数据暴露控制。

wifi.present

当 WiFi 客户端存在时发出为“true”(即使已禁用)。如果系统中不存在 WiFi,则发出为 false。

wifi.channel

系统的 WiFi 信道。当 WiFi 存在且已启用时发出。

wifi.ssid

WiFi 网络的唯一名称。当 WiFi 存在且已启用时发出。受敏感数据暴露控制。

wifi.bssid

唯一接入点的唯一 MAC 地址。当 WiFi 存在且已启用时发出。受敏感数据暴露控制。

wifi.mac_address

WiFi 网卡的 MAC 地址。当 WiFi 存在且已启用时发出。受敏感数据暴露控制。

wifi.ipv4

WiFi 使用的 IP 地址。当 WiFi 存在且已启用时发出。受敏感数据暴露控制。

Prometheus 认证

当在 OpenTelemetry 中启用 Prometheus 认证时,客户端必须在 GET(抓取)请求的 Authorization 标头中发送正确的用户名和密码。如果凭据缺失或错误,服务器将响应 401 Unauthorized。认证具有优先级:即使请求使用了错误的路径,服务器也会返回 401。如果凭据正确,服务器的响应就像认证被禁用一样:对于正确的路径返回 200 及抓取结果,对于错误的路径返回 404 Not Found。

密码以明文形式存储并在 OpenTelemetry 窗口中显示,这是有意为之的可用性权衡。此决定适用于受控的操作环境,其中 UI 访问受到限制。用户应对管理界面应用适当的访问控制。

Prometheus 错误处理

如果客户端抓取 /metrics 以外的任何路径,服务器将返回 HTTP 404 错误。如果启用了认证,请参阅认证部分了解错误处理方式。如果 Prometheus 未启用,客户端请求将超时。

OTLP/HTTP 错误处理

导出器使用持久(保活)连接到 OTEL Collector。它在首次推送时惰性打开连接,并在后续推送中重用该套接字。如果连接失败,它会尽可能尝试重用套接字。

如果导出连接失败,适配器使用带有 ±25% 抖动的退避策略进行连续重试。退避上限为 30 秒。连续 10 次失败后,适配器将于 5 分钟再次进行尝试。

使用退避策略的可重试 HTTP 响应失败包括:

  • 无法连接到端点。

  • 发送失败/读取失败(连接关闭并重试)。

  • HTTP 响应状态:

    • 408(超时)

    • 429(节流)

  • 任何 5xx(服务器错误)。

不可重试的故障(暂停直到配置更改):

  • 任何 HTTP 4xx 响应。

  • 无效的指标 URL。

  • https:// 配置(不支持 TLS)。

如果不存在遥测样本(例如在启动时),适配器不会将此视为故障,也不会应用退避策略。