Apollo开放平台文档

apollo_monitor_system_status

更新时间：2022-05-05

/apollo/monitor/system_status 数据通道（channel）是 Apollo 系统反馈硬件、软件等状态的数据消息的通道。

本文档介绍 /apollo/monitor/system_status 通道里各数据字段的含义。

前提条件

您需要提前了解：

通道数据解释

监控内容

  1. Apollo 模块运行状态
  2. 监控数据完整性与频率
  3. 系统运行状态
  4. 生成端到端的数据延迟报告

其中，1、2 为可配置选项。

参考快速上手播放 demo_3.5.record 的数据包后，您可以通过 Cyber Monitor 工具查看数据包里的全部的通道信息。 其中，/apollo/monitor/system_status 通道内的数据如下所示。

ChannelName: /apollo/monitor/system_status
MessageType: apollo.monitor.SystemStatus
FrameRatio: 1.01
RawMessage Size: 676 Bytes
header:
  timestamp_sec: 1632310757.228502274
  module_name: SystemMonitor
  sequence_num: 1275
hmi_modules: +[18 items]
components: +[4 items]

整个数据通道内的数据可以分为两部分：CyberRT 框架定义的元数据和通道对应的消息格式（Message）所定义的消息数据。

CyberRT 框架定义的元数据

该部分包括 apollo.common.Header 数据字段，详情参见 数据通道。

ChannelName: /apollo/monitor/system_status
MessageType: apollo.monitor.systemstatus
FrameRatio: 0.00
RawMessage Size: 16863 Bytes (16.47 KB)

其中，MessageType 定义了当前通道对应的消息格式（Message）为 apollo.monitor.SystemStatus。

消息格式（Message）所定义的消息数据

下一小节，将逐一详细介绍这部分消息的数据字段含义。

apollo.monitor.SystemStatus 消息格式（Message）定义的数据字段

apollo.monitor.SystemStatus 消息格式（Message）

其定义了如下 2 个重要数据字段。

数据名称 数据解释 Protobuf Message 定义
hmi_modules 报告受监控模块状态 由 apollo.monitor.ComponentStatus
components 报告受监控模块详细状态 由 apollo.monitor.Component 定义 
ChannelName: /apollo/monitor/system_status
MessageType: apollo.monitor.SystemStatus
FrameRatio: 0.67
hmi_modules
  key: AudioDetection
  value:
    status: FATAL

其中，hmi_modules 是一个包含模块状态信息的 map 类型值，提供给 dreamview 进行状态显示使用。 module_controller.png

其中模块状态包含如下具体信息：

数据名称 数据解释 详细
Status 模块状态 包括 UNKNOWN、WARN、OK、ERROR
message 详细的报错信息 用户自定义的报错信息

components 也是一个包含模块更加详细状态信息的 map 类型值，其中模块状态包含如下具体信息：

数据名称 数据解释 详细
process_status 进程状态 包括 UNKNOWN、WARN、OK、ERROR
channel_status channel 信息状态 是利用以上模块状态的消息定义返回channel状态信息
resource_status 资源状态 是利用以上模块状态的消息定义返回资源模块状态信息
summary 根据以上状态信息进行汇总的状态 是利用以上模块状态的消息定义返回总体的状态信息

深入了解 SystemStatus 数据类型

深入了解 apollo.monitor.SystemStatus 等消息格式（Message）定义，参见 system_status.proto文件。关于 protobuf 与 消息格式（Message）的关系，参见 消息格式。

文档意见反馈

如果您在使用文档时遇到任何问题，请到我们在【开发者社区】建立的 反馈意见收集问答页面，反馈相关的问题。我们会根据反馈意见对文档进行迭代优化。

规划模块apollo_monitor