Add instructions for submitting detailed logs (#3442)
* Add instructions for submitting detailed logs Resolves https://github.com/Microsoft/WSL/issues/3137 * Revise to attach: ETL don't have sensitive info
Christopher Warrington committed
Aug 13, 2018 at 09:13 UTC
48fccdc6e2c1bde8f2eb8185c581f6653d1ee422
1 file changed
+24
-17
CONTRIBUTING.md
+24
-17
@@ -3,7 +3,7 @@ Please provide as much information as possible when reporting a bug or filing an
3
This Github issues page is a bugtracker. It's intended for technical discussion and for debugging specific issues. If you have a feature request, you should instead post it to the [UserVoice](https://wpdev.uservoice.com/forums/266908). The UserVoice is better for tracking feature requests; it has a voting mechanism so the WSL team can put a higher priority behind issues that affect more people.
4
5
## Important: Reporting BSODs and Security issues
6
-**Do not open Github issues for Windows crashes (BSODs) or security issues.**. Instead, send Windows crashes or other security-related issues to secure@microsoft.com.
6
+**Do not open Github issues for Windows crashes (BSODs) or security issues.**. Instead, send Windows crashes or other security-related issues to secure@microsoft.com.
7
8
## Reporting issues in Windows Console or WSL text rendering/user experience
9
Note that WSL distro's launch in the Windows Console (unless you have taken steps to launch a 3rd party console/terminal). Therefore, *please file UI/UX related issues in the [Windows Console issue tracker](https://github.com/microsoft/console)*.
@@ -12,7 +12,7 @@ Note that WSL distro's launch in the Windows Console (unless you have taken step
12
A well written bug will follow the following template:
13
14
### 1) Issue Title
15
-A title succinctly describing the issue.
15
+A title succinctly describing the issue.
16
17
#### Example:
18
`Traceroute not working.`
@@ -21,9 +21,9 @@ A title succinctly describing the issue.
21
Your Windows build number. This can be gathered from the CMD prompt using the `ver` command.
22
23
```
24
-C:\> ver
25
-Microsoft Windows [Version 10.0.14385]
26
-```
24
+C:\> ver
25
+Microsoft Windows [Version 10.0.14385]
26
+```
27
28
Note: The Windows Insider builds contain many updates and fixes. If you are running on the Creators Update (10.0.15063) please check to see if your issue has been resolved in a later build. If you are running on the Anniversary Update (10.0.14393), please try updating to the Creators Update.
29
@@ -57,9 +57,9 @@ What was the expected result of the command? Include examples / documentation i
57
58
Run the failing command under [strace](http://manpages.ubuntu.com/manpages/wily/man1/strace.1.html). Normal command structure is:
59
60
-```
61
-$ strace -ff <command>
62
-```
60
+```
61
+$ strace -ff <command>
62
+```
63
64
> Note: `strace` can produce lengthy output. If the generated trace is more than about 20 lines please paste this into a [Gist](https://gist.github.com/) or another paste service and link in the bug.
65
@@ -82,15 +82,18 @@ access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory)
82
Some bugs require additional information such as scripts to reproduce. Please add to this section.
83
84
If there are files required, email the files to InsiderSupport@microsoft.com with:
85
-Subject: Forward to WSL Team - RE: github issue <issue #>
86
-Body: "Please forward to WSL Team" and include your attachment.
85
+
86
+* **Subject**: Forward to WSL Team - RE: github issue <issue #>
87
+* **Body**: "Please forward to WSL Team" and include your attachment.
88
89
Common files are:
89
-Memory dumps found under C:\Windows\MEMORY.DMP
90
-Additional strace logs if the error occurs within a fork. The following command generates an output file for every fork created:
90
92
-```
93
-$ strace -ff -o <outputfile> <command>
91
+* Memory dumps found under C:\Windows\MEMORY.DMP
92
+* Additional strace logs if the error occurs within a fork. The following
93
+ command generates an output file for every fork created:
94
+
95
+```
96
+$ strace -ff -o <outputfile> <command>
97
```
98
99
### 8) Detailed Logs
@@ -99,9 +102,9 @@ Some bugs will require more detailed logs to help determine the cause. There is
102
#### Start collecting logs
103
104
```
102
-logman.exe create trace lxcore_kernel -p {0CD1C309-0878-4515-83DB-749843B3F5C9} -mode 0x00000008 -ft 10:00 -o .\lxcore_kernel.etl -ets
103
-logman.exe create trace lxcore_user -p {D90B9468-67F0-5B3B-42CC-82AC81FFD960} -ft 1:00 -rt -o .\lxcore_user.etl -ets
104
-logman.exe create trace lxcore_service -p {B99CDB5A-039C-5046-E672-1A0DE0A40211} -ft 1:00 -rt -o .\lxcore_service.etl -ets
105
+logman.exe create trace lxcore_kernel -p {0CD1C309-0878-4515-83DB-749843B3F5C9} -mode 0x00000008 -ft 10:00 -o .\lxcore_kernel.etl -ets
106
+logman.exe create trace lxcore_user -p {D90B9468-67F0-5B3B-42CC-82AC81FFD960} -ft 1:00 -rt -o .\lxcore_user.etl -ets
107
+logman.exe create trace lxcore_service -p {B99CDB5A-039C-5046-E672-1A0DE0A40211} -ft 1:00 -rt -o .\lxcore_service.etl -ets
108
```
109
110
#### Stop collecting logs
@@ -121,3 +124,7 @@ lxcore_kernel.etl
124
lxcore_service.etl
125
lxcore_user.etl
126
```
127
+
128
+#### Submitting logs
129
+
130
+To submit the details logs, attach them to your GitHub issue.