Update FAQ documentation to enhance log collection and saving instructions

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
+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
- **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`.
> 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.
- 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`)**
- **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.
- 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?