Update FAQ documentation to include log collection and saving instructions

This commit is contained in:
slz
2026-02-05 14:22:57 +08:00
parent 9c505f5581
commit f8bd740dc1
2 changed files with 24 additions and 8 deletions
+12 -4
View File
@@ -25,11 +25,19 @@
- 要使此更改永久生效,请查看[此链接](https://github.com/OpenKinect/libfreenect2/issues/807)。
### 其他故障排除
### 如何采集和保存日志
- 如果遇到其他问题,将 `log_level` 参数设置为 `debug`。这将在运行目录中生成SDK日志文件:`Log/OrbbecSDK.log.txt`。请将此文件提供给支持团队以获得进一步帮助。
- 如果需要固件日志,将`log_level` 参数设置为 `debug`的同时,将 `enable_heartbeat` 设置为 `true` 以激活此功能。
- 若将`log_level` 参数设置为 `debug`的同时,又不想终端刷新太多日志,可以在`launch`中将`output="screen"`改为`output="log"`,日志会被保存在`~/.ros/log`目录下。
1. **SDK debug 日志**
将 launch 参数 `log_level` 设为 `debug` 运行后,会在当前工程目录下的 `Log/` 文件夹中生成 SDK 日志文件。如果需要为本次测试指定一个更易识别的日志文件名,可以修改参数 `log_file_name`。
> SDK 日志是追加写入的:多次启动会在同一个文件里不断累积日志。
> 建议:在准备打包日志发给技术支持前,先删除旧的日志文件,然后重新复现问题并采集新的日志,这样日志更干净、定位更准确。
2. **ROS2 日志(~/.ros/log)**
在 launch 文件中,将节点(或可组合节点容器)的 `output` 参数设为 `"log"`,即可将 ROS2 日志保存到本地:
> 设置为 `output="log"` 后,ROS2 日志将保存在 `~/.ros/log/` 目录下。
> 如需提交问题,请同时打包 `Log/` 目录下的 SDK 日志和 `~/.ros/log/` 下对应时间的 ROS2 日志,一并提供。
### 为什么有这么多启动文件?