diff --git a/docs/en/guides/backend-profile-export.md b/docs/en/guides/backend-profile-export.md index 1c7a1c9b4b5087e142fd2aa4fe95035ddd359d77..cf10644e6729596ec03b9d94a6ffb6c208e260a8 100644 --- a/docs/en/guides/backend-profile-export.md +++ b/docs/en/guides/backend-profile-export.md @@ -1,24 +1,24 @@ -# Exporter tool of profile raw data -When the visualization doesn't work well through the official UI, users could submit the issue to report. This tool helps the users to package the original profile data for helping the community to locate the issue in the user case. NOTICE, this report includes the class name, method name, line number, etc. Before submit this, please make sure this wouldn't become your system vulnerability. +# Exporter tool for profile raw data +When visualization doesn't work well on the official UI, users may submit issue reports. This tool helps users package the original profile data to assist the community in locating the issues in the users' cases. NOTE: This report includes the class name, method name, line number, etc. Before making your submission, please make sure that the security of your system wouldn't be compromised. -## Export command line Usage -1. Set the storage in `tools/profile-exporter/application.yml` file by following your use case. -1. Prepare data - - Profile task id: Profile task id - - Trace id: Wrong profiled trace id - - Export dir: Directory of the data will export +## Export using command line +1. Set the storage in the `tools/profile-exporter/application.yml` file based on your use case. +1. Prepare the data + - Profile task ID: Profile task ID + - Trace ID: Trace ID of the profile error + - Export dir: Directory exported by the data 1. Enter the Skywalking root path 1. Execute shell command ```bash bash tools/profile-exporter/profile_exporter.sh --taskid={profileTaskId} --traceid={traceId} {exportDir} ``` -1. The file `{traceId}.tar.gz` will be generated after execution shell. +1. The file `{traceId}.tar.gz` will be generated after executing shell. ## Exported data content 1. `basic.yml`: Contains the complete information of the profiled segments in the trace. 1. `snapshot.data`: All monitored thread snapshot data in the current segment. -## Report profile issue +## Report profile issues 1. Provide exported data generated from this tool. -1. Provide span operation name, analyze mode(include/exclude children). -1. Issue description. (If there have the UI screenshots, it's better) +1. Provide the operation name and the mode of analysis (including/excluding child span) for the span. +1. Issue description. (It would be great if you could provide UI screenshots.)