Skip to content

Add doc for collecting ServiceHub logs #4472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2019
Merged

Add doc for collecting ServiceHub logs #4472

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be5565d
Add doc for collecting ServiceHub logs
RyanToth3 Dec 11, 2019
e0e4567
Address comments
RyanToth3 Dec 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/ide/how-to-increase-chances-of-performance-issue-being-fixed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ follow the feedback steps specific to that case.

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

- [Out-Of-Process Issues:](#out-of-process-issues) An issue caused by a Visual Studio satellite process

## Crashes
A crash occurs when the process (Visual Studio) terminates unexpectedly.

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

## Out-Of-Process Issues

> [!NOTE]
> Starting with Visual Studio 2019 version 16.3, out-of-process logs are automatically attached to feedback submitted using the Report a Problem tool.
However, if the issue is directly reproducible, following the below steps could still help add additional information to help better diagnose the issue.

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'.

What makes these types of issues most actionable is to provide additional logs that can be collected by following these steps:

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:

- Set the global environment variable **ServiceHubTraceLevel** to **All**
- Reproduce the issue.

2. Download the Microsoft Visual Studio and .NET Framework Log Collection Tool [here](https://aka.ms/vscollect).
3. Run the tool. This outputs a zip file to **%temp%/vslogs.zip**. Please attach that file to your feedback.

## See also

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