Skip to content

Commit f8bd740

Browse files
committed
Update FAQ documentation to include log collection and saving instructions
1 parent 9c505f5 commit f8bd740

2 files changed

Lines changed: 24 additions & 8 deletions

File tree

  • docs
    • en/source/camera_devices/8_FAQ
    • zh/source/camera_devices/8_FAQ

docs/en/source/camera_devices/8_FAQ/FAQ.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,19 @@ If the camera node crashes unexpectedly, it will generate a crash log in the cur
2525

2626
- To make this change permanent, check [this link](https://github.com/OpenKinect/libfreenect2/issues/807).
2727

28-
### Additional Troubleshooting
28+
### How to Collect and Save Logs
2929

30-
- If you encounter other issues, set the `log_level` parameter to `debug`. This will generate an SDK log file in the running directory: `Log/OrbbecSDK.log.txt`. Please provide this file to the support team for further assistance.
31-
- If firmware logs are required, set the `log_level` parameter to `debug` and set `enable_heartbeat` to `true` to activate this feature.
32-
- If you set the `log_level` parameter to `debug` and do not want the terminal to refresh too many logs, you can change `output="screen"` to `output="log"` in `launch`, and the logs will be saved in the `~/.ros/log` directory.
30+
1. **SDK debug logs**
31+
Set the launch parameter `log_level` to `debug`. After running, the SDK will generate log files in the `Log/` folder under the current project directory. If you want a more recognizable file name for this test, you can set the parameter `log_file_name`.
32+
33+
> SDK logs are appended to the same file: multiple launches will continue writing into the same log file.
34+
> Recommendation: before packaging logs to send to technical support, delete old log files, then reproduce the issue and collect new logs. This keeps the logs cleaner and makes troubleshooting more accurate.
35+
36+
2. **ROS 2 logs (`~/.ros/log`)**
37+
In the launch file, set the node (or composable node container) parameter `output` to `"log"` to save ROS 2 logs locally.
38+
39+
> After setting `output="log"`, ROS 2 logs will be stored in the `~/.ros/log/` directory.
40+
> When submitting an issue, please package both the SDK logs under the `Log/` directory and the corresponding ROS 2 logs under `~/.ros/log/` for the same time period.
3341
3442
### Why Are There So Many Launch Files?
3543

docs/zh/source/camera_devices/8_FAQ/FAQ.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,19 @@
2525

2626
- 要使此更改永久生效,请查看[此链接](https://github.com/OpenKinect/libfreenect2/issues/807)
2727

28-
### 其他故障排除
28+
### 如何采集和保存日志
2929

30-
- 如果遇到其他问题,将 `log_level` 参数设置为 `debug`。这将在运行目录中生成SDK日志文件:`Log/OrbbecSDK.log.txt`。请将此文件提供给支持团队以获得进一步帮助。
31-
- 如果需要固件日志,将`log_level` 参数设置为 `debug`的同时,将 `enable_heartbeat` 设置为 `true` 以激活此功能。
32-
- 若将`log_level` 参数设置为 `debug`的同时,又不想终端刷新太多日志,可以在`launch`中将`output="screen"`改为`output="log"`,日志会被保存在`~/.ros/log`目录下。
30+
1. **SDK debug 日志**
31+
将 launch 参数 `log_level` 设为 `debug` 运行后,会在当前工程目录下的 `Log/` 文件夹中生成 SDK 日志文件。如果需要为本次测试指定一个更易识别的日志文件名,可以修改参数 `log_file_name`
32+
33+
> SDK 日志是追加写入的:多次启动会在同一个文件里不断累积日志。
34+
> 建议:在准备打包日志发给技术支持前,先删除旧的日志文件,然后重新复现问题并采集新的日志,这样日志更干净、定位更准确。
35+
36+
2. **ROS2 日志(~/.ros/log)**
37+
在 launch 文件中,将节点(或可组合节点容器)的 `output` 参数设为 `"log"`,即可将 ROS2 日志保存到本地:
38+
39+
> 设置为 `output="log"` 后,ROS2 日志将保存在 `~/.ros/log/` 目录下。
40+
> 如需提交问题,请同时打包 `Log/` 目录下的 SDK 日志和 `~/.ros/log/` 下对应时间的 ROS2 日志,一并提供。
3341
3442
### 为什么有这么多启动文件?
3543

0 commit comments

Comments
 (0)