Skip to content

Add telemetry for xterm imageAddon #299017

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
anthonykim1 merged 5 commits into from
Mar 10, 2026
Merged

Add telemetry for xterm imageAddon #299017

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
a485610
Add telemetry imageAddon loaded
anthonykim1 Mar 3, 2026
1e01e53
edit descr
anthonykim1 Mar 3, 2026
c2d4ee6
Merge branch 'main' into anthonykim1/imageAddonTelemetry
anthonykim1 Mar 5, 2026
279474a
add more individual telmetry from xterm.js api
anthonykim1 Mar 5, 2026
a0eb36d
Make sure we have telemetry for setting AND image count
anthonykim1 Mar 5, 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
5 changes: 5 additions & 0 deletions src/vs/workbench/contrib/terminal/browser/terminalTelemetry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ export class TerminalTelemetryContribution extends Disposable implements IWorkbe
shellIntegrationInjected: boolean;
shellIntegrationInjectionFailureReason: ShellIntegrationInjectionFailureReason | undefined;

imageAddonLoaded: boolean;

terminalSessionId: string;
};
type TerminalCreationTelemetryClassification = {
Expand All @@ -101,6 +103,8 @@ export class TerminalTelemetryContribution extends Disposable implements IWorkbe
shellIntegrationInjected: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'Whether the shell integration script was injected.' };
shellIntegrationInjectionFailureReason: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'Info about shell integration injection.' };

imageAddonLoaded: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'Whether the xterm.js image addon was loaded.' };

terminalSessionId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The session ID of the terminal instance.' };
};
this._telemetryService.publicLog2<TerminalCreationTelemetryData, TerminalCreationTelemetryClassification>('terminal/createInstance', {
Expand All @@ -122,6 +126,7 @@ export class TerminalTelemetryContribution extends Disposable implements IWorkbe
shellIntegrationQuality: commandDetection?.hasRichCommandDetection ? 2 : commandDetection ? 1 : 0,
shellIntegrationInjected: instance.usedShellIntegrationInjection,
shellIntegrationInjectionFailureReason: instance.shellIntegrationInjectionFailureReason,
imageAddonLoaded: instance.xterm?.isImageAddonLoaded ?? false,
terminalSessionId: instance.sessionId,
});
}
Expand Down
13 changes: 13 additions & 0 deletions src/vs/workbench/contrib/terminal/browser/xterm/xtermTerminal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ export class XtermTerminal extends Disposable implements IXtermTerminal, IDetach

get isStdinDisabled(): boolean { return !!this.raw.options.disableStdin; }
get isGpuAccelerated(): boolean { return !!this._webglAddon; }
get isImageAddonLoaded(): boolean { return !!this._imageAddon; }

private readonly _onDidRequestRunCommand = this._register(new Emitter<{ command: ITerminalCommand; noNewLine?: boolean }>());
readonly onDidRequestRunCommand = this._onDidRequestRunCommand.event;
Expand Down Expand Up @@ -916,6 +917,18 @@ export class XtermTerminal extends Disposable implements IXtermTerminal, IDetach
const AddonCtor = await this._xtermAddonLoader.importAddon('image');
this._imageAddon = new AddonCtor();
this.raw.loadAddon(this._imageAddon);
type TerminalImageAddonActivatedClassification = {
owner: 'anthonykim1';
comment: 'Tracks when the xterm.js image addon is loaded, including dynamic enablement';
};
this._telemetryService.publicLog2<{}, TerminalImageAddonActivatedClassification>('terminal/imageAddonActivated');
this._register(this._imageAddon.onImageAdded(() => {
type TerminalImageAddedClassification = {
owner: 'anthonykim1';
comment: 'Tracks when an image is added to the terminal via the image addon';
};
this._telemetryService.publicLog2<{}, TerminalImageAddedClassification>('terminal/imageAdded');
}));
}
} else {
try {
Expand Down
Loading