Skip to content

Track file extension in LSP request failure telemetry #3228

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −12
Draft

Track file extension in LSP request failure telemetry #3228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc81737
Initial plan
Copilot Mar 25, 2026
c6804b7
Track file type or extension for failing LSP requests in telemetry
Copilot Mar 25, 2026
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
1 change: 1 addition & 0 deletions _extension/src/telemetryReporting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export type LSErrorResponse = {
errorCode: string;
requestMethod: string;
stack: string;
fileExtension?: string;
};

export type EnableNativePreview = {};
Expand Down
6 changes: 6 additions & 0 deletions internal/lsp/lsproto/_generate/generate.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@ const customStructures: Structure[] = [
type: { kind: "base", name: "string" },
documentation: "The stack trace associated with the event.",
},
{
name: "fileExtension",
type: { kind: "base", name: "string" },
optional: true,
documentation: "The file extension of the document that caused the event, if available.",
},
],
documentation: "RequestFailureTelemetryProperties contains failure information when an LSP request manages to recover.",
},
Expand Down
7 changes: 7 additions & 0 deletions internal/lsp/lsproto/lsp_generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 19 additions & 12 deletions internal/lsp/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,8 +756,9 @@ func registerLanguageServiceDocumentRequestHandler[Req lsproto.HasTextDocumentUR
if err != nil {
return nil, err
}
fileExtension := tspath.TryGetExtensionFromPath(params.TextDocumentURI().FileName())
return func() error {
defer s.recover(req)
defer s.recover(req, fileExtension)
resp, lsErr := fn(s, ctx, ls, params)
if lsErr != nil {
return lsErr
Expand All @@ -781,8 +782,9 @@ func registerLanguageServiceWithAutoImportsRequestHandler[Req lsproto.HasTextDoc
if err != nil {
return nil, err
}
fileExtension := tspath.TryGetExtensionFromPath(params.TextDocumentURI().FileName())
return func() error {
defer s.recover(req)
defer s.recover(req, fileExtension)
resp, lsErr := fn(s, ctx, languageService, params)
if errors.Is(lsErr, ls.ErrNeedsAutoImports) {
languageService, lsErr = s.session.GetLanguageServiceWithAutoImports(ctx, snapshot, params.TextDocumentURI())
Expand Down Expand Up @@ -824,8 +826,9 @@ func registerMultiProjectReferenceRequestHandler[Req lsproto.HasTextDocumentPosi
if err != nil {
return nil, err
}
fileExtension := tspath.TryGetExtensionFromPath(params.TextDocumentURI().FileName())
return func() error {
defer s.recover(req)
defer s.recover(req, fileExtension)
resp, lsErr := fn(defaultLs, ctx, params, orchestrator)
if lsErr != nil {
return lsErr
Expand Down Expand Up @@ -882,7 +885,7 @@ func (s *Server) getLanguageServiceAndCrossProjectOrchestrator(ctx context.Conte
return defaultLs, orchestrator, err
}

func (s *Server) recover(req *lsproto.RequestMessage) {
func (s *Server) recover(req *lsproto.RequestMessage, fileExtension string) {
if r := recover(); r != nil {
stack := debug.Stack()
s.logger.Errorf("panic handling request %s: %v\n%s", req.Method, r, string(stack))
Expand All @@ -892,13 +895,17 @@ func (s *Server) recover(req *lsproto.RequestMessage) {
return
}

props := &lsproto.RequestFailureTelemetryProperties{
ErrorCode: lsproto.ErrorCodeInternalError.String(),
RequestMethod: strings.ReplaceAll(string(req.Method), "/", "."),
Stack: sanitizeStackTrace(string(stack)),
}
if fileExtension != "" {
props.FileExtension = &fileExtension
}
_ = sendNotification(s, lsproto.TelemetryEventInfo, lsproto.TelemetryEvent{
RequestFailureTelemetryEvent: &lsproto.RequestFailureTelemetryEvent{
Properties: &lsproto.RequestFailureTelemetryProperties{
ErrorCode: lsproto.ErrorCodeInternalError.String(),
RequestMethod: strings.ReplaceAll(string(req.Method), "/", "."),
Stack: sanitizeStackTrace(string(stack)),
},
Properties: props,
},
})
} else {
Expand Down Expand Up @@ -1245,7 +1252,7 @@ func (s *Server) handleCompletionItemResolve(ctx context.Context, params *lsprot
if err != nil {
return nil, err
}
defer s.recover(reqMsg)
defer s.recover(reqMsg, tspath.TryGetExtensionFromPath(data.FileName))
return languageService.ResolveCompletionItem(
ctx,
params,
Expand Down Expand Up @@ -1282,7 +1289,7 @@ func (s *Server) handleDocumentOnTypeFormat(ctx context.Context, ls *ls.Language

func (s *Server) handleWorkspaceSymbol(ctx context.Context, params *lsproto.WorkspaceSymbolParams, reqMsg *lsproto.RequestMessage) (lsproto.WorkspaceSymbolResponse, error) {
snapshot := s.session.GetSnapshotLoadingProjectTree(ctx, nil)
defer s.recover(reqMsg)
defer s.recover(reqMsg, "")

programs := core.Map(snapshot.ProjectCollection.Projects(), (*project.Project).GetProgram)
return ls.ProvideWorkspaceSymbols(
Expand Down Expand Up @@ -1336,7 +1343,7 @@ func (s *Server) handleCodeLensResolve(ctx context.Context, codeLens *lsproto.Co
// based on non-existent files and line maps from shortened files.
return codeLens, lsproto.ErrorCodeContentModified
}
defer s.recover(reqMsg)
defer s.recover(reqMsg, tspath.TryGetExtensionFromPath(codeLens.Data.Uri.FileName()))
return defaultLs.ResolveCodeLens(
ctx,
codeLens,
Expand Down