你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
访问 Azure IoT Edge 中的内置指标
适用于:IoT Edge 1.5
IoT Edge 1.4
重要
IoT Edge 1.5 LTS 和 IoT Edge 1.4 LTS 是受支持的版本。 IoT Edge 1.4 LTS 的生命周期结束日期为 2024 年 11 月 12 日。 如果你使用的是较低的版本,请参阅更新 IoT Edge。
IoT Edge 运行时组件(IoT Edge 中心和 IoT Edge 代理)以 Prometheus 公开格式生成内置指标。 远程访问这些指标来监视和了解 IoT Edge 设备的运行状况。
你可以使用自己的解决方案来访问这些指标。 也可使用指标收集器模块来收集内置指标并将它们发送到 Azure Monitor 或 Azure IoT 中心。 有关详细信息,请参阅收集和传输指标。
默认情况下,指标会自动在 edgeHub 和 edgeAgent 模块(http://edgeHub:9600/metrics
和 http://edgeAgent:9600/metrics
)的端口 9600 公开。 默认情况下,这些端口不会映射到主机。
通过从模块的 createOptions
公开和映射指标端口来访问主机中的指标。 下面的示例将默认指标端口映射到主机上的端口 9601:
{
"ExposedPorts": {
"9600/tcp": {}
},
"HostConfig": {
"PortBindings": {
"9600/tcp": [
{
"HostPort": "9601"
}
]
}
}
}
如果要映射 edgeHub 和 edgeAgent 的指标终结点,请选择不同且唯一的主机端口号。
可用度量值
指标包含标志,有助于识别所收集指标的性质。 所有指标都包含以下标志:
标记 | 描述 |
---|---|
iothub | 设备与之通信的中心 |
edge_device | 当前设备的 ID |
instance_number | 表示当前运行时的 GUID。 重启时,将重置所有指标。 此 GUID 有助于协调重启。 |
在 Prometheus 公开格式中,有四个核心指标类型:计数器、仪表、直方图和摘要。 有关不同指标类型的详细信息,请参阅 Prometheus 指标类型文档。
为内置直方图和摘要指标提供的分位数为 0.1、0.5、0.9 和 0.99。
edgeHub 模块生成以下指标:
“属性” | 维度 | 说明 |
---|---|---|
edgehub_gettwin_total |
source (操作源)id (模块 ID) |
类型:计数器 GetTwin 调用总数 |
edgehub_messages_received_total |
route_output (发送消息的输出)id |
类型:计数器 从客户端接收的消息总数 |
edgehub_messages_sent_total |
from (消息源)to (消息目标)from_route_output to_route_input (消息目标输入)priority (到目标的消息优先级) |
类型:计数器 发送到客户端或上游的消息总数 当 to 为 $upstream 时,to_route_input 为空 |
edgehub_reported_properties_total |
target (更新目标)id |
类型:计数器 报告的属性更新调用总数 |
edgehub_message_size_bytes |
id |
类型:摘要 来自客户端的消息大小 如果在某段时间内(当前为 10 分钟)未报告新的度量,则可能会将值报告为 NaN ;对于 summary 类型,将发出相应的 _count 和 _sum 计数器。 |
edgehub_gettwin_duration_seconds |
source id |
类型:摘要 获取孪生操作所用的时间 |
edgehub_message_send_duration_seconds |
from to from_route_output to_route_input |
类型:摘要 发送消息所用的时间 |
edgehub_message_process_duration_seconds |
from to priority |
类型:摘要 处理来自队列的消息所用的时间 |
edgehub_reported_properties_update_duration_seconds |
target id |
类型:摘要 更新报告的属性所用的时间 |
edgehub_direct_method_duration_seconds |
from (调用方)to (接收方) |
类型:摘要 解析直接消息所用的时间 |
edgehub_direct_methods_total |
from to |
类型:计数器 发送的直接消息总数 |
edgehub_queue_length |
endpoint (消息源)priority (队列优先级) |
类型:仪表 给定优先级的 edgeHub 队列的当前长度 |
edgehub_messages_dropped_total |
reason (no_route、ttl_expiry)from from_route_output |
类型:计数器 因某种原因而删除的消息总数 |
edgehub_messages_unack_total |
reason (storage_failure)from from_route_output |
类型:计数器 由于存储故障而未确认的消息总数 |
edgehub_offline_count_total |
id |
类型:计数器 edgeHub 脱机的总次数 |
edgehub_offline_duration_seconds |
id |
类型:摘要 Edge 中心脱机的时间 |
edgehub_operation_retry_total |
id operation (操作名称) |
类型:计数器 重试 edgeHub 操作的总次数 |
edgehub_client_connect_failed_total |
id reason (未通过身份验证) |
类型:计数器 客户端无法连接到 edgeHub 的总次数 |
edgeAgent 模块生成以下指标:
“属性” | 维度 | 说明 |
---|---|---|
edgeAgent_total_time_running_correctly_seconds |
module_name |
类型:仪表 在部署中指定模块并且处于运行状态的时间 |
edgeAgent_total_time_expected_running_seconds |
module_name |
类型:仪表 在部署中指定模块的时间 |
edgeAgent_module_start_total |
module_name 、module_version |
类型:计数器 edgeAgent 请求 Docker 启动模块的次数 |
edgeAgent_module_stop_total |
module_name 、module_version |
类型:计数器 edgeAgent 请求 Docker 停止模块的次数 |
edgeAgent_command_latency_seconds |
command |
类型:仪表 Docker 执行给定命令所用的时间。 可能的命令有:create、update、remove、start、stop 和 restart |
edgeAgent_iothub_syncs_total |
类型:计数器 edgeAgent 尝试将其孪生与 iotHub 同步的成功和失败次数。 此数目包括请求孪生的代理和通知孪生更新的中心 |
|
edgeAgent_unsuccessful_iothub_syncs_total |
类型:计数器 edgeAgent 无法与 iotHub 同步其孪生的次数。 |
|
edgeAgent_deployment_time_seconds |
类型:计数器 接收更改后完成新部署所用的时间。 |
|
edgeagent_direct_method_invocations_count |
method_name |
类型:计数器 调用内置 edgeAgent 直接方法(如 Ping 或 Restart)的次数。 |
edgeAgent_host_uptime_seconds |
类型:仪表 主机已开启的时间 |
|
edgeAgent_iotedged_uptime_seconds |
类型:仪表 iotedged 已运行的时间 |
|
edgeAgent_available_disk_space_bytes |
disk_name 、disk_filesystem 、disk_filetype |
类型:仪表 磁盘上的剩余空间量 |
edgeAgent_total_disk_space_bytes |
disk_name 、disk_filesystem 、disk_filetype |
类型:仪表 磁盘的大小 |
edgeAgent_used_memory_bytes |
module_name |
类型:仪表 所有进程使用的 RAM 量 |
edgeAgent_total_memory_bytes |
module_name |
类型:仪表 可用 RAM |
edgeAgent_used_cpu_percent |
module_name |
类型:直方图 所有进程使用的 CPU 百分比 |
edgeAgent_created_pids_total |
module_name |
类型:仪表 容器创建的进程或线程数 |
edgeAgent_total_network_in_bytes |
module_name |
类型:仪表 从网络接收的字节数 |
edgeAgent_total_network_out_bytes |
module_name |
类型:仪表 发送到网络的字节数 |
edgeAgent_total_disk_read_bytes |
module_name |
类型:仪表 从磁盘读取的字节数 |
edgeAgent_total_disk_write_bytes |
module_name |
类型:仪表 写入磁盘的字节数 |
edgeAgent_metadata |
edge_agent_version 、experimental_features 、host_information |
类型:仪表 有关设备的常规元数据。 此值始终为 0,将在标志中对信息进行编码。 请注意, experimental_features 和 host_information 是 JSON 对象。 host_information 类似于 {"OperatingSystemType": "linux", "Architecture": "x86_64", "Version": "1.2.7", "Provisioning": {"Type": "dps.tpm", "DynamicReprovisioning": false, "AlwaysReprovisionOnStartup": false}, "ServerVersion": "20.10.11+azure-3", "KernelVersion": "5.11.0-1027-azure", "OperatingSystem": "Ubuntu 20.04.4 LTS", "NumCpus": 2, "Virtualized": "yes"} 。 请注意,ServerVersion 是 Docker 版本,Version 是 IoT Edge 安全守护程序版本。 |