Support ILogger.BeginScope() for LSP logging #77647
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-issue-labeler
bot
added
Area-IDE
untriaged
jasonmalinowski
commented
Mar 18, 2025
src/LanguageServer/Microsoft.CommonLanguageServerProtocol.Framework/ILspLogger.cs
Outdated
Show resolved
Hide resolved
jasonmalinowski
commented
Mar 18, 2025
| @@ -237,7 +239,6 @@ public async Task StartRequestAsync<TRequest, TResponse>(TRequest request, TRequ | |||
| finally | |||
| { | |||
| _requestTelemetryScope?.Dispose(); | |||
| _logger.LogEndContext($"{MethodName}"); | |||
There was a problem hiding this comment.
Removed since each branch now logs a success/failure/cancelled.
jasonmalinowski
commented
Mar 18, 2025
| var xmlSnippetParser = document.Project.Solution.Services.ExportProvider.GetService<XmlSnippetParser>(); | ||
|
|
||
| return InlineCompletionsHandler.GetInlineCompletionItemsAsync(logger, document, position, options, xmlSnippetParser, cancellationToken); | ||
| } | ||
|
|
||
| private sealed class EmptyLogger : ILspLogger |
There was a problem hiding this comment.
We already had a NoOpLspLogger to reuse.
jasonmalinowski
commented
Mar 18, 2025
| @@ -4,6 +4,7 @@ | |||
|
|
|||
| using System; | |||
| using System.Threading.Tasks; | |||
| using Microsoft.CodeAnalysis.LanguageServer; | |||
There was a problem hiding this comment.
This is to use the NoOpLspLogger that already existed in this namespace from Microsoft.CodeAnalysis.LanguageServer.Protocol. If there is a desire that this example must use only stuff from CommonLanguageServerProtocol, then we should delete the package reference and move the no-op implementation to CLaSP.
jasonmalinowski
commented
Mar 18, 2025
| { | ||
| message = $"[{categoryName}] {message}"; | ||
| try | ||
| if (scope is LspLoggingScope lspLoggingScope) |
There was a problem hiding this comment.
Although nothing prevents us from just adding a string as the scope, I decided to a bit more strict about the typing here.
dibarbet
approved these changes
Mar 18, 2025
src/LanguageServer/Microsoft.CommonLanguageServerProtocol.Framework/AbstractLspLogger.cs
Outdated
Show resolved
Hide resolved
Validation run was ran, and verified good. |
Otherwise this gets logged by the LSP client as a generic message, which isn't prefixed with a severity like everything else.
This surrounds the processing of each LSP request with a call to ILogger.BeginScope() with the name of the method that's being invoked. This is prefixed to the message we send back to the LSP client, so it's much easier to understand the source of various pieces of logging. ILspLogger.LogStartContext/LogEndContext are deprecated here, as setting scopes plus an explicit start/end as appropriate makes things work much better when we're handling requests in parallel.
jasonmalinowski
force-pushed
the
support-logging-scopes
branch
from
748d7e6 to
c8c9e5b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This surrounds the processing of each LSP request with a call to ILogger.BeginScope() with the name of the method that's being invoked. This is prefixed to the message we send back to the LSP client, so it's much easier to understand the source of various pieces of logging.
ILspLogger.LogStartContext/LogEndContext are deprecated here, as setting scopes plus an explicit start/end as appropriate makes things work much better when we're handling requests in parallel.
An example of what this looks like now:
I decided to put the context first since calls sometimes end up in other components, and it made it more clear the context was flowing around.