i/OrbbecSDK_ROS2
1
0
Fork 0
mirror of https://github.com/orbbec/OrbbecSDK_ROS2.git synced 2026-10-04 03:57:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update FAQ documentation to enhance log collection and saving instructions

Browse Source
This commit is contained in:
slz
2026-02-05 14:44:06 +08:00
parent d467ba04f2
commit ab7101f5ef
2 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/source/camera_devices/8_FAQ/FAQ.md
+8 -6
View File
@@ -27,17 +27,19 @@ If the camera node crashes unexpectedly, it will generate a crash log in the cur
### How to Collect and Save Logs ### How to Collect and Save Logs
- **SDK debug logs** **1. SDK debug logs**
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`. 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`.
> SDK logs are appended to the same file: multiple launches will continue writing into the same log file. - SDK logs are appended to the same file: multiple launches will continue writing into the same log file.
> 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. - 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.
**2. ROS 2 logs (`~/.ros/log`)**
- **ROS 2 logs (`~/.ros/log`)**
In the launch file, set the node (or composable node container) parameter `output` to `"log"` to save ROS 2 logs locally. In the launch file, set the node (or composable node container) parameter `output` to `"log"` to save ROS 2 logs locally.
> After setting `output="log"`, ROS 2 logs will be stored in the `~/.ros/log/` directory. - After setting `output="log"`, ROS 2 logs will be stored in the `~/.ros/log/` directory.
> 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. - 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.
### Why Are There So Many Launch Files? ### Why Are There So Many Launch Files?
docs/zh/source/camera_devices/8_FAQ/FAQ.md
+8 -6
View File
@@ -27,17 +27,19 @@
### 如何采集和保存日志 ### 如何采集和保存日志
- **SDK debug 日志** **1. SDK debug 日志**
将 launch 参数 `log_level` 设为 `debug` 运行后，会在当前工程目录下的 `Log/` 文件夹中生成 SDK 日志文件。如果需要为本次测试指定一个更易识别的日志文件名，可以修改参数 `log_file_name`。 将 launch 参数 `log_level` 设为 `debug` 运行后，会在当前工程目录下的 `Log/` 文件夹中生成 SDK 日志文件。如果需要为本次测试指定一个更易识别的日志文件名，可以修改参数 `log_file_name`。
> SDK 日志是追加写入的：多次启动会在同一个文件里不断累积日志。 - SDK 日志是追加写入的：多次启动会在同一个文件里不断累积日志。
> 建议：在准备打包日志发给技术支持前，先删除旧的日志文件，然后重新复现问题并采集新的日志，这样日志更干净、定位更准确。 - 建议：在准备打包日志发给技术支持前，先删除旧的日志文件，然后重新复现问题并采集新的日志，这样日志更干净、定位更准确。
**2. ROS2 日志（~/.ros/log）**
- **ROS2 日志（~/.ros/log）**
在 launch 文件中，将节点（或可组合节点容器）的 `output` 参数设为 `"log"`，即可将 ROS2 日志保存到本地： 在 launch 文件中，将节点（或可组合节点容器）的 `output` 参数设为 `"log"`，即可将 ROS2 日志保存到本地：
> 设置为 `output="log"` 后，ROS2 日志将保存在 `~/.ros/log/` 目录下。 - 设置为 `output="log"` 后，ROS2 日志将保存在 `~/.ros/log/` 目录下。
> 如需提交问题，请同时打包 `Log/` 目录下的 SDK 日志和 `~/.ros/log/` 下对应时间的 ROS2 日志，一并提供。 - 如需提交问题，请同时打包 `Log/` 目录下的 SDK 日志和 `~/.ros/log/` 下对应时间的 ROS2 日志，一并提供。
### 为什么有这么多启动文件？ ### 为什么有这么多启动文件？