Skip to content

Commit 47e8ef8

Browse files
authored
Merge pull request #4472 from RyanToth3/dev/rytoth/oop-issue-doc
Add doc for collecting ServiceHub logs
2 parents 6c04960 + e0e4567 commit 47e8ef8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/ide/how-to-increase-chances-of-performance-issue-being-fixed.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ follow the feedback steps specific to that case.
4242

4343
- [High CPU:](#slowness-and-high-cpu-issues) Extended periods of unexpectedly high CPU usage
4444

45+
- [Out-Of-Process Issues:](#out-of-process-issues) An issue caused by a Visual Studio satellite process
46+
4547
## Crashes
4648
A crash occurs when the process (Visual Studio) terminates unexpectedly.
4749

@@ -238,6 +240,24 @@ tool can be found on the [Recording performance traces with
238240
PerfView](https://github.com/dotnet/roslyn/wiki/Recording-performance-traces-with-PerfView)
239241
page.
240242

243+
## Out-Of-Process Issues
244+
245+
> [!NOTE]
246+
> Starting with Visual Studio 2019 version 16.3, out-of-process logs are automatically attached to feedback submitted using the Report a Problem tool.
247+
However, if the issue is directly reproducible, following the below steps could still help add additional information to help better diagnose the issue.
248+
249+
There are a number of satellite processes that run parallel to Visual Studio and provide various features from outside of the main Visual Studio process. If an error occurs in one of these satellite processes it is usually seen on the Visual Studio side as a 'StreamJsonRpc.RemoteInvocationException' or a 'StreamJsonRpc.ConnectionLostException'.
250+
251+
What makes these types of issues most actionable is to provide additional logs that can be collected by following these steps:
252+
253+
1. If this is a directly reproducible issue, start by deleting the **%temp%/servicehub/logs** folder. If you cannot reproduce this issue please keep this folder intact and ignore the following bullets:
254+
255+
- Set the global environment variable **ServiceHubTraceLevel** to **All**
256+
- Reproduce the issue.
257+
258+
2. Download the Microsoft Visual Studio and .NET Framework Log Collection Tool [here](https://aka.ms/vscollect).
259+
3. Run the tool. This outputs a zip file to **%temp%/vslogs.zip**. Please attach that file to your feedback.
260+
241261
## See also
242262

243263
* [Visual Studio feedback options](../ide/feedback-options.md)

0 commit comments

Comments
 (0)