Skip to content

Moved client id logging into createBasicLogEvent #13607

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
owenofbrien merged 3 commits into from
Nov 21, 2025
Merged

Moved client id logging into createBasicLogEvent #13607

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a745647
Moved client id logging into createBasicLogEvent to ensure that exten…
owenofbrien Nov 21, 2025
bc4e024
Merge branch 'main' into fixBasicLogEvent
owenofbrien Nov 21, 2025
d944ade
Ran linter
owenofbrien Nov 21, 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
26 changes: 13 additions & 13 deletions packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,10 @@ export class ClearcutLogger {
eventName: EventNames,
data: EventValue[] = [],
): LogEvent {
const email = this.userAccountManager.getCachedGoogleAccount();
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The method getCachedGoogleAccount() performs a synchronous file read on every call. Since createBasicLogEvent is now called for every telemetry event, this synchronous I/O could block the Node.js event loop and cause performance issues, especially when many events are logged in quick succession. This could impact the application's responsiveness.

To mitigate this, consider caching the email within the ClearcutLogger instance. A more robust solution would be to add in-memory caching to the UserAccountManager itself to avoid repeated file reads across the application.

const surface = determineSurface();
const ghWorkflowName = determineGHWorkflowName();

const baseMetadata: EventValue[] = [
...data,
{
Expand Down Expand Up @@ -321,34 +323,32 @@ export class ClearcutLogger {
});
}

return {
const logEvent: LogEvent = {
console_type: 'GEMINI_CLI',
application: 102, // GEMINI_CLI
event_name: eventName as string,
event_metadata: [baseMetadata],
};

// Should log either email or install ID, not both. See go/cloudmill-1p-oss-instrumentation#define-sessionable-id
if (email) {
logEvent.client_email = email;
} else {
logEvent.client_install_id = this.installationManager.getInstallationId();
}

return logEvent;
}

createLogEvent(eventName: EventNames, data: EventValue[] = []): LogEvent {
const email = this.userAccountManager.getCachedGoogleAccount();

if (eventName !== EventNames.START_SESSION) {
data.push(...this.sessionData);
}
const totalAccounts = this.userAccountManager.getLifetimeGoogleAccounts();

data = this.addDefaultFields(data, totalAccounts);

const logEvent = this.createBasicLogEvent(eventName, data);

// Should log either email or install ID, not both. See go/cloudmill-1p-oss-instrumentation#define-sessionable-id
if (email) {
logEvent.client_email = email;
} else {
logEvent.client_install_id = this.installationManager.getInstallationId();
}

return logEvent;
return this.createBasicLogEvent(eventName, data);
}

flushIfNeeded(): void {
Expand Down