设备平台支持设备本地日志的上报,您可以在设备平台控制台的日志服务页面,查询设备本地日志,进行故障分析。本文介绍设备向设备平台上报本地日志的流程与方法。
前置条件
- 设备已完成设备认证获得token
设备日志上传流程
简述:设备平台 获取第三方对象存储服务临时URL,由设备端自行上传至对应的对象存储服务内,文件上传成功后可在设备详情内查询当前设备已上传日志文件列表。
相关接口
bag类型开关后续将迁移至物模型内。
接口信息
名称:查询bag类型日志上传开关状态
接口路径: /sweeper-log-server/v1/bag/switch
method : get
所需鉴权:设备认证鉴权
接口入参
/
接口返回示例
{
"code": 0,
"msg": "ok",
"err_code": 10000,
"data": {
"bagSwitch" : 1
}
}
错误时返回:
{
"code": -1,
"msg": "${errorMessage}",
"err_code": ${errorCode},
"data": null
}
返回值描述:
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | code | int | 是 | 状态码,为0时表示接口调用成功,不为0时表示接口调用失败 |
2 | err_code | int | 是 | 错误码,当code为0时,返回10000,否则返回对应错误码 |
3 | msg | String | 是 | 错误的具体消息 |
4 | data | Object | 否 | 返回的结果,当失败时为空 |
5 | data.bagSwitch | Int | 否 | bag 开关状态, 1:开 0:关 |
接口信息
名称:获取设备日志上传临时授权
接口路径: /sweeper-log-server/v2/file/getUploadToken
method : get
所需鉴权:设备认证鉴权
接口入参
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | file_type | int | 是 | 默认值0, 0: 日志文件 1:bag文件 2:core文件 3:map data, 4: einternal_error_file, 5: datas 6 埋点数据; 7 mini_dump; 8 workflow |
2 | timestamp | int | 是 | 机器产生日志文件的时间戳, 精确到s |
3 | file_name | String | 是 | 文件名称(包含格式),例如: {deviceId}{firmwareversion}{typename,例子:log}{年}{月}{日}{时}{分}{秒}_{序号}.tar.gz |
接口返回示例
{
"code": 0,
"msg": "ok",
"err_code": 10000,
"result": {
"channel" : "s3",
"params":{
"path_prefix":"log/xxx",
"s3":{
"method":"PUT",
"url":"https://narwal-test-public.s3.us-east-2.amazonaws.com/log/idc_data/2020-09-27/c9eed11b99f84e04bf31c164a635d6b2/18270891201?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231011T025224Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=600&X-Amz-Credential=AKIAUNFRTHK3PAH6WQ4K%2F20231011%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=0a72083a2c9f26d7ae38c4d0a49e6759690b04dd2a959d9cf266bd612ed2ac6a"
},
"obs":{
"content_type":"text/plain"
"signature":"1eXJKQEpsQuLyzZMRgLL3Mlqb28=",
"accesskey_id":"",
"acl":"public-read",
"url":"https://narwal-test.obs.cn-south-1.myhuaweicloud.com",
"policy":""
}
}
}
}
错误时返回:
{
"code": -1,
"msg": "${errorMessage}",
"err_code": ${errorCode},
"result": null
}
返回值描述:
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | code | int | 是 | 状态码,为0时表示接口调用成功,不为0时表示接口调用失败 |
2 | err_code | int | 是 | 错误码,当code为0时,返回10000,否则返回对应错误码 |
3 | msg | String | 是 | 错误的具体消息 |
4 | result | Object | 否 | 返回的结果,当失败时为空 |
result描述:
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | channel | string | 是 | 文件上传通道: obs/s3 |
2 | params | Object | 是 | 上传参数 |
params描述:
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | path_prefix | string | 是 | 文件上传路径 |
2 | s3 | Object | 否 | S3上传参数,类型为S3不为空 |
3 | obs | Object | 否 | obs上传参数,类型为obs不为空 |
s3描述:
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | method | string | 是 | 上传方法 |
2 | url | string | 是 | 上传路径 |
obs描述:
字段名称 | 字段类型 | 是否必须 | 描述 | |
---|---|---|---|---|
1 | content_type | string | 是 | 内容类型 |
2 | signature | string | 是 | 上传签名 |
3 | accesskey_id | string | 是 | 上传AK |
4 | acl | string | 是 | 文件权限 |
5 | url | string | 是 | 上传路径 |
6 | policy | string | 是 | 授权信息 |
日志文件类型说明
文件类型 | 说明 |
---|---|
Log | 记录系统或应用程序在运行过程中产生的事件、消息或数据的文件或信息流,用于监控、调试、分析和审计系统行为。 若日志文件上传规范,可直接使用SLS、ELK等开源日志分析工具进行在线问题定位等,详见:基于SLS解析日志。 |
Bag | 设备端的回放数据,包括设备在运行时的传感器数据、状态信息等,用于方便后续分析和调试,一般用Webviz搭配使用。目前仅扫地机项目使用。 |
Coredump | 设备端系统/应用程序崩溃日志。目前仅扫地机使用。 |
Minidump | 设备端系统/应用程序崩溃日志(缩小版)。目前仅扫地机使用。 |
IDC | 用于实现视觉图片类型数据采集与训练。目前仅扫地机使用。 |
目前支持的第三方对象存储文档
以下为其官方文档。若有不了解处,可联系设备平台技术对接开发进行沟通。
云厂商 | 文档介绍 |
---|---|
华为云-对象存储服务OBS | https://support.huaweicloud.com/usermanual-obs/zh-cn_topic_0045829661.html |
AWS-S3 | https://aws.amazon.com/cn/s3/ |
创建时间:2025-02-17 15:35
最后编辑:admin 更新时间:2025-02-20 10:40
最后编辑:admin 更新时间:2025-02-20 10:40