This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new 88f40a6 Refine backend-profile-export.md (#6865)
88f40a6 is described below
commit 88f40a6bffb2a856a995ffb78ff686e94281c310
Author: Wing <[email protected]>
AuthorDate: Wed Apr 28 20:41:51 2021 +0800
Refine backend-profile-export.md (#6865)
---
docs/en/guides/backend-profile-export.md | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/en/guides/backend-profile-export.md
b/docs/en/guides/backend-profile-export.md
index 1c7a1c9..cf10644 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.)
