联犀开发者文档

设备本地日志上报

约 567 字大约 2 分钟

2025-03-03

简介

为了便于开发调试和远程错误定位，联犀提供了设备本地日志上传功能。可在联犀管理后台关闭/开启单个设备的本地日志功能。

参数说明

  • {productID}：产品ID。
  • {deviceName}：设备ID。
  • 通用请求参数
参数类型必填说明
msgTokenString是用于上下行消息配对标识
sys.noAskbool否云端是否回复设备
sys.retMsgbool否是否返回错误信息,字段为msg
示例:
{
  "method": "reportInfo",
  "msgToken": "1234567",
  "sys": {
     "noAsk": false,
     "retMsg": true
  }
}

日志级别

级别说明
1关闭
2错误
3告警
4信息
5调试

注意：服务端不对日志等级进行严格限制，建议：

  • 后台设置设备日志级别为 5 的时候，设备上报 2、3、4、5 等级日志
  • 后台设置设备日志级别为 4 的时候，设备上报 2、3、4 等级日志
  • 以此类推

Topic 介绍

1. 设备主动查询服务端设置的日志等级

上行 Topic： $log/up/operation/{productID}/{deviceName}

{
  "method": "getStatus",
  "timestamp": 1654844328734,
  "msgToken": "xxxxxx"
}

下行 Topic： $log/down/operation/{productID}/{deviceName}

{
  "method": "getStatusReply",
  "msgToken": "xxxxxxx",
  "timestamp": 1654844328734,
  "code": 200,
  "msg": "成功",
  "data": {
    "logLevel": 2
  }
}

2. 日志直传

上行 Topic： $log/up/report/{productID}/{deviceName}

参数说明：

  • logLevel：日志级别（2)错误 3)告警 4)信息 5)调试），不传默认为 5
  • content：日志内容，在后台将以文本形式直接展示
  • timestamp：日志时间戳
{
  "method": "reportInfo",
  "timestamp": 1654844328734,
  "msgToken": "xxxxxx",
  "params": [
    {
      "timestamp": 1654844328734,
      "logLevel": 5,
      "content": "long string,不要超过500k"
    },
    {
      "timestamp": 1654844328734,
      "logLevel": 4,
      "content": "long string"
    },
    {
      "timestamp": 1654844328734,
      "content": "sdsdadasfafasdf sdfasd sadfasdf sdfsdfs sdf4asdfsdf"
    }
  ]
}

下行 Topic： $log/down/report/{productID}/{deviceName}

{
  "method": "reportReply",
  "msgToken": "xxxxxx",
  "timestamp": 1656553866096,
  "code": 200,
  "msg": "成功"
}

3. 服务端主动推送修改日志等级

下行 Topic： $log/down/update/{productID}/{deviceName}

{
  "method": "getStatusReply",
  "msgToken": "xxxxxx",
  "code": 200,
  "msg": "成功",
  "data": {
    "logLevel": 1
  }
}

使用建议

  1. 日志级别设置：根据实际需求合理设置日志级别，避免产生过多无用日志
  2. 日志内容：日志内容应简洁明了，便于问题定位
  3. 时间戳：确保设备时间同步，日志时间戳准确
  4. 性能考虑：日志上报频率不宜过高，避免影响设备性能

更新日志

2026/8/4 07:04
查看所有更新日志
  • 7e927-文档站全面重构：目录重排、首页重写、案例独立成站、应用市场下线于
  • bddea-docs: 更新文档结构、添加新内容并优化现有文档于
  • 706e5-doc于
  • ded7d-doc于
  • 6fa0c-doc于
  • 80b39-doc于
  • d4fa0-doc: 更换皮肤到最新版于
  • 82830-doc于
  • 4066c-doc: 完善文档于
  • f4017-doc: 完善文档于
  • 8794f-feat: 完善项目`于
  • df9b4-初始化于