Skip to content

Add more state info to cpptools crash logging. #13888

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 5 commits into from
Sep 2, 2025
Merged

Add more state info to cpptools crash logging. #13888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b04c3c4
Add more state info to cpptools crash logging.
sean-mcmanus Aug 29, 2025
3a1d60e
Modify comment.
sean-mcmanus Aug 29, 2025
e5abee2
Add lastInvokedLspMessage.
sean-mcmanus Aug 29, 2025
b41b712
Add a comment.
sean-mcmanus Aug 29, 2025
c527a25
Fix comment.
sean-mcmanus Aug 29, 2025
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
127 changes: 76 additions & 51 deletions Extension/src/LanguageServer/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ import { CopilotCompletionContextFeatures, CopilotCompletionContextProvider } fr
import { CustomConfigurationProvider1, getCustomConfigProviders, isSameProviderExtensionId } from './customProviders';
import { DataBinding } from './dataBinding';
import { cachedEditorConfigSettings, getEditorConfigSettings } from './editorConfig';
import { CppSourceStr, clients, configPrefix, initializeIntervalTimer, updateLanguageConfigurations, usesCrashHandler, watchForCrashes } from './extension';
import { CppSourceStr, clients, configPrefix, initializeIntervalTimer, isWritingCrashCallStack, updateLanguageConfigurations, usesCrashHandler, watchForCrashes } from './extension';
import { LocalizeStringParams, getLocaleId, getLocalizedString } from './localization';
import { PersistentFolderState, PersistentState, PersistentWorkspaceState } from './persistentState';
import { RequestCancelled, ServerCancelled, createProtocolFilter } from './protocolFilter';
Expand Down Expand Up @@ -953,6 +953,8 @@ export class DefaultClient implements Client {
public getShowConfigureIntelliSenseButton(): boolean { return this.showConfigureIntelliSenseButton; }
public setShowConfigureIntelliSenseButton(show: boolean): void { this.showConfigureIntelliSenseButton = show; }

private lastInvokedLspMessage: string = ""; // e.g. cpptools/hover

/**
* don't use this.rootFolder directly since it can be undefined
*/
Expand Down Expand Up @@ -1688,7 +1690,6 @@ export class DefaultClient implements Client {
closed: () => {
languageClientCrashTimes.push(Date.now());
languageClientCrashedNeedsRestart = true;
telemetry.logLanguageServerEvent("languageClientCrash");
let restart: boolean = true;
if (languageClientCrashTimes.length < 5) {
void clients.recreateClients();
Expand All @@ -1702,6 +1703,26 @@ export class DefaultClient implements Client {
void clients.recreateClients();
}
}

// Wait 1 second to allow time for the file watcher to signal a crash call stack write has occurred.
setTimeout(() => {
telemetry.logLanguageServerEvent("languageClientCrash",
{
lastInvokedLspMessage: this.lastInvokedLspMessage
},
{
restarting: Number(restart),
writingCrashCallStack: Number(isWritingCrashCallStack),
initializingWorkspace: Number(this.model.isInitializingWorkspace.Value),
indexingWorkspace: Number(this.model.isIndexingWorkspace.Value),
parsingWorkspace: Number(this.model.isParsingWorkspace.Value),
parsingFiles: Number(this.model.isParsingFiles.Value),
updatingIntelliSense: Number(this.model.isUpdatingIntelliSense.Value),
runningCodeAnalysis: Number(this.model.isRunningCodeAnalysis.Value)
}
);
}, 1000);

const message: string = restart ? localize('server.crashed.restart', 'The language server crashed. Restarting...')
: localize('server.crashed2', 'The language server crashed 5 times in the last 3 minutes. It will not be restarted.');

Expand Down Expand Up @@ -2768,55 +2789,59 @@ export class DefaultClient implements Client {
const message: string = notificationBody.status;
util.setProgress(util.getProgressExecutableSuccess());
const testHook: TestHook = getTestHook();
if (message.endsWith("Idle")) {
const status: IntelliSenseStatus = { status: Status.Idle };
testHook.updateStatus(status);
} else if (message.endsWith("Parsing")) {
this.model.isParsingWorkspace.Value = true;
this.model.isInitializingWorkspace.Value = false;
this.model.isIndexingWorkspace.Value = false;
const status: IntelliSenseStatus = { status: Status.TagParsingBegun };
testHook.updateStatus(status);
} else if (message.endsWith("Initializing")) {
this.model.isInitializingWorkspace.Value = true;
this.model.isIndexingWorkspace.Value = false;
this.model.isParsingWorkspace.Value = false;
} else if (message.endsWith("Indexing")) {
this.model.isIndexingWorkspace.Value = true;
this.model.isInitializingWorkspace.Value = false;
this.model.isParsingWorkspace.Value = false;
} else if (message.endsWith("files")) {
this.model.isParsingFiles.Value = true;
} else if (message.endsWith("IntelliSense")) {
timeStamp = Date.now();
this.model.isUpdatingIntelliSense.Value = true;
const status: IntelliSenseStatus = { status: Status.IntelliSenseCompiling };
testHook.updateStatus(status);
} else if (message.endsWith("IntelliSense done")) {
getOutputChannelLogger().appendLineAtLevel(6, localize("update.intellisense.time", "Update IntelliSense time (sec): {0}", (Date.now() - timeStamp) / 1000));
this.model.isUpdatingIntelliSense.Value = false;
const status: IntelliSenseStatus = { status: Status.IntelliSenseReady };
testHook.updateStatus(status);
} else if (message.endsWith("Parsing done")) { // Tag Parser Ready
this.model.isParsingWorkspace.Value = false;
const status: IntelliSenseStatus = { status: Status.TagParsingDone };
testHook.updateStatus(status);
util.setProgress(util.getProgressParseRootSuccess());
} else if (message.endsWith("files done")) {
this.model.isParsingFiles.Value = false;
} else if (message.endsWith("Analysis")) {
this.model.isRunningCodeAnalysis.Value = true;
this.model.codeAnalysisTotal.Value = 1;
this.model.codeAnalysisProcessed.Value = 0;
} else if (message.endsWith("Analysis done")) {
this.model.isRunningCodeAnalysis.Value = false;
} else if (message.includes("Squiggles Finished - File name:")) {
const index: number = message.lastIndexOf(":");
const name: string = message.substring(index + 2);
const status: IntelliSenseStatus = { status: Status.IntelliSenseReady, filename: name };
testHook.updateStatus(status);
} else if (message.endsWith("No Squiggles")) {
util.setIntelliSenseProgress(util.getProgressIntelliSenseNoSquiggles());
if (message.startsWith("C_Cpp: ")) {
if (message.endsWith("Idle")) {
const status: IntelliSenseStatus = { status: Status.Idle };
testHook.updateStatus(status);
} else if (message.endsWith("Parsing")) {
this.model.isParsingWorkspace.Value = true;
this.model.isInitializingWorkspace.Value = false;
this.model.isIndexingWorkspace.Value = false;
const status: IntelliSenseStatus = { status: Status.TagParsingBegun };
testHook.updateStatus(status);
} else if (message.endsWith("Initializing")) {
this.model.isInitializingWorkspace.Value = true;
this.model.isIndexingWorkspace.Value = false;
this.model.isParsingWorkspace.Value = false;
} else if (message.endsWith("Indexing")) {
this.model.isIndexingWorkspace.Value = true;
this.model.isInitializingWorkspace.Value = false;
this.model.isParsingWorkspace.Value = false;
} else if (message.endsWith("files")) {
this.model.isParsingFiles.Value = true;
} else if (message.endsWith("IntelliSense")) {
timeStamp = Date.now();
this.model.isUpdatingIntelliSense.Value = true;
const status: IntelliSenseStatus = { status: Status.IntelliSenseCompiling };
testHook.updateStatus(status);
} else if (message.endsWith("IntelliSense done")) {
getOutputChannelLogger().appendLineAtLevel(6, localize("update.intellisense.time", "Update IntelliSense time (sec): {0}", (Date.now() - timeStamp) / 1000));
this.model.isUpdatingIntelliSense.Value = false;
const status: IntelliSenseStatus = { status: Status.IntelliSenseReady };
testHook.updateStatus(status);
} else if (message.endsWith("Parsing done")) { // Tag Parser Ready
this.model.isParsingWorkspace.Value = false;
const status: IntelliSenseStatus = { status: Status.TagParsingDone };
testHook.updateStatus(status);
util.setProgress(util.getProgressParseRootSuccess());
} else if (message.endsWith("files done")) {
this.model.isParsingFiles.Value = false;
} else if (message.endsWith("Analysis")) {
this.model.isRunningCodeAnalysis.Value = true;
this.model.codeAnalysisTotal.Value = 1;
this.model.codeAnalysisProcessed.Value = 0;
} else if (message.endsWith("Analysis done")) {
this.model.isRunningCodeAnalysis.Value = false;
} else if (message.includes("Squiggles Finished - File name:")) {
const index: number = message.lastIndexOf(":");
const name: string = message.substring(index + 2);
const status: IntelliSenseStatus = { status: Status.IntelliSenseReady, filename: name };
testHook.updateStatus(status);
} else if (message.endsWith("No Squiggles")) {
util.setIntelliSenseProgress(util.getProgressIntelliSenseNoSquiggles());
}
} else if (message.includes("/")) {
this.lastInvokedLspMessage = message;
}
}

Expand Down
3 changes: 3 additions & 0 deletions Extension/src/LanguageServer/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ let languageConfigurations: vscode.Disposable[] = [];
let intervalTimer: NodeJS.Timeout;
let codeActionProvider: vscode.Disposable;
export const intelliSenseDisabledError: string = "Do not activate the extension when IntelliSense is disabled.";
export let isWritingCrashCallStack: boolean = false;

type VcpkgDatabase = Record<string, string[]>; // Stored as <header file entry> -> [<port name>]
let vcpkgDbPromise: Promise<VcpkgDatabase>;
Expand Down Expand Up @@ -1023,9 +1024,11 @@ export function watchForCrashes(crashDirectory: string): void {
return;
}
const crashDate: Date = new Date();
isWritingCrashCallStack = true;

// Wait 5 seconds to allow time for the crash log to finish being written.
setTimeout(() => {
isWritingCrashCallStack = false;
fs.readFile(path.resolve(crashDirectory, filename), 'utf8', (err, data) => {
void handleCrashFileRead(crashDirectory, filename, crashDate, err, data);
});
Expand Down