From f8bd740dc12733477a16de6ac3ceafe5cf4d8830 Mon Sep 17 00:00:00 2001 From: slz Date: Thu, 5 Feb 2026 14:22:57 +0800 Subject: [PATCH] Update FAQ documentation to include log collection and saving instructions --- docs/en/source/camera_devices/8_FAQ/FAQ.md | 16 ++++++++++++---- docs/zh/source/camera_devices/8_FAQ/FAQ.md | 16 ++++++++++++---- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/docs/en/source/camera_devices/8_FAQ/FAQ.md b/docs/en/source/camera_devices/8_FAQ/FAQ.md index dbfe94b6..7595a261 100644 --- a/docs/en/source/camera_devices/8_FAQ/FAQ.md +++ b/docs/en/source/camera_devices/8_FAQ/FAQ.md @@ -25,11 +25,19 @@ If the camera node crashes unexpectedly, it will generate a crash log in the cur - To make this change permanent, check [this link](https://github.com/OpenKinect/libfreenect2/issues/807). -### Additional Troubleshooting +### How to Collect and Save Logs -- 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. -- If firmware logs are required, set the `log_level` parameter to `debug` and set `enable_heartbeat` to `true` to activate this feature. -- 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. +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`. + +> 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. + +2. **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. + +> 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. ### Why Are There So Many Launch Files? diff --git a/docs/zh/source/camera_devices/8_FAQ/FAQ.md b/docs/zh/source/camera_devices/8_FAQ/FAQ.md index 12cb6f2d..4332cf98 100644 --- a/docs/zh/source/camera_devices/8_FAQ/FAQ.md +++ b/docs/zh/source/camera_devices/8_FAQ/FAQ.md @@ -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 日志，一并提供。 ### 为什么有这么多启动文件？