@office-ai/aioncli-core 0.18.6 → 0.24.0-preview.1

package/dist/src/telemetry/types.d.ts

@@ -14,6 +14,7 @@ export { ToolCallDecision };
 import type { ToolRegistry } from '../tools/tool-registry.js';
 import type { OutputFormat } from '../output/types.js';
 import type { AgentTerminateMode } from '../agents/types.js';
+import type { OTelFinishReason } from './semantic.js';
 export interface BaseTelemetryEvent {
     'event.name': string;
     /** Current timestamp in ISO 8601 format */
@@ -98,11 +99,11 @@ export declare class ApiRequestEvent implements BaseTelemetryEvent {
     'event.name': 'api_request';
     'event.timestamp': string;
     model: string;
-    prompt_id: string;
+    prompt: GenAIPromptDetails;
     request_text?: string;
-    constructor(model: string, prompt_id: string, request_text?: string);
-    toOpenTelemetryAttributes(config: Config): LogAttributes;
-    toLogBody(): string;
+    constructor(model: string, prompt_details: GenAIPromptDetails, request_text?: string);
+    toLogRecord(config: Config): LogRecord;
+    toSemanticLogRecord(config: Config): LogRecord;
 }
 export declare const EVENT_API_ERROR = "gemini_cli.api_error";
 export declare class ApiErrorEvent implements BaseTelemetryEvent {
@@ -154,6 +155,7 @@ export declare class ApiResponseEvent implements BaseTelemetryEvent {
     prompt: GenAIPromptDetails;
     response: GenAIResponseDetails;
     usage: GenAIUsageDetails;
+    finish_reasons: OTelFinishReason[];
     constructor(model: string, duration_ms: number, prompt_details: GenAIPromptDetails, response_details: GenAIResponseDetails, auth_type?: string, usage_data?: GenerateContentResponseUsageMetadata, response_text?: string);
     toLogRecord(config: Config): LogRecord;
     toSemanticLogRecord(config: Config): LogRecord;
@@ -334,11 +336,12 @@ export declare class ExtensionInstallEvent implements BaseTelemetryEvent {
     'event.name': 'extension_install';
     'event.timestamp': string;
     extension_name: string;
+    hashed_extension_name: string;
     extension_id: string;
     extension_version: string;
     extension_source: string;
     status: 'success' | 'error';
-    constructor(extension_name: string, extension_id: string, extension_version: string, extension_source: string, status: 'success' | 'error');
+    constructor(extension_name: string, hashed_extension_name: string, extension_id: string, extension_version: string, extension_source: string, status: 'success' | 'error');
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
@@ -368,9 +371,10 @@ export declare class ExtensionUninstallEvent implements BaseTelemetryEvent {
     'event.name': 'extension_uninstall';
     'event.timestamp': string;
     extension_name: string;
+    hashed_extension_name: string;
     extension_id: string;
     status: 'success' | 'error';
-    constructor(extension_name: string, extension_id: string, status: 'success' | 'error');
+    constructor(extension_name: string, hashed_extension_name: string, extension_id: string, status: 'success' | 'error');
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
@@ -379,12 +383,13 @@ export declare class ExtensionUpdateEvent implements BaseTelemetryEvent {
     'event.name': 'extension_update';
     'event.timestamp': string;
     extension_name: string;
+    hashed_extension_name: string;
     extension_id: string;
     extension_previous_version: string;
     extension_version: string;
     extension_source: string;
     status: 'success' | 'error';
-    constructor(extension_name: string, extension_id: string, extension_version: string, extension_previous_version: string, extension_source: string, status: 'success' | 'error');
+    constructor(extension_name: string, hashed_extension_name: string, extension_id: string, extension_version: string, extension_previous_version: string, extension_source: string, status: 'success' | 'error');
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
@@ -393,9 +398,10 @@ export declare class ExtensionEnableEvent implements BaseTelemetryEvent {
     'event.name': 'extension_enable';
     'event.timestamp': string;
     extension_name: string;
+    hashed_extension_name: string;
     extension_id: string;
     setting_scope: string;
-    constructor(extension_name: string, extension_id: string, settingScope: string);
+    constructor(extension_name: string, hashed_extension_name: string, extension_id: string, settingScope: string);
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
@@ -420,36 +426,57 @@ export declare class LlmLoopCheckEvent implements BaseTelemetryEvent {
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
-export type TelemetryEvent = StartSessionEvent | EndSessionEvent | UserPromptEvent | ToolCallEvent | ApiRequestEvent | ApiErrorEvent | ApiResponseEvent | FlashFallbackEvent | LoopDetectedEvent | LoopDetectionDisabledEvent | NextSpeakerCheckEvent | MalformedJsonResponseEvent | IdeConnectionEvent | ConversationFinishedEvent | SlashCommandEvent | FileOperationEvent | InvalidChunkEvent | ContentRetryEvent | ContentRetryFailureEvent | ExtensionEnableEvent | ExtensionInstallEvent | ExtensionUninstallEvent | ModelRoutingEvent | ToolOutputTruncatedEvent | ModelSlashCommandEvent | AgentStartEvent | AgentFinishEvent | RecoveryAttemptEvent | LlmLoopCheckEvent | WebFetchFallbackAttemptEvent;
+export type TelemetryEvent = StartSessionEvent | EndSessionEvent | UserPromptEvent | ToolCallEvent | ApiRequestEvent | ApiErrorEvent | ApiResponseEvent | FlashFallbackEvent | LoopDetectedEvent | LoopDetectionDisabledEvent | NextSpeakerCheckEvent | MalformedJsonResponseEvent | IdeConnectionEvent | ConversationFinishedEvent | SlashCommandEvent | FileOperationEvent | InvalidChunkEvent | ContentRetryEvent | ContentRetryFailureEvent | ExtensionEnableEvent | ExtensionInstallEvent | ExtensionUninstallEvent | ModelRoutingEvent | ToolOutputTruncatedEvent | ModelSlashCommandEvent | AgentStartEvent | AgentFinishEvent | RecoveryAttemptEvent | LlmLoopCheckEvent | StartupStatsEvent | WebFetchFallbackAttemptEvent | EditStrategyEvent | EditCorrectionEvent;
 export declare const EVENT_EXTENSION_DISABLE = "gemini_cli.extension_disable";
 export declare class ExtensionDisableEvent implements BaseTelemetryEvent {
     'event.name': 'extension_disable';
     'event.timestamp': string;
     extension_name: string;
+    hashed_extension_name: string;
     extension_id: string;
     setting_scope: string;
-    constructor(extension_name: string, extension_id: string, settingScope: string);
+    constructor(extension_name: string, hashed_extension_name: string, extension_id: string, settingScope: string);
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
-export declare const EVENT_SMART_EDIT_STRATEGY = "gemini_cli.smart_edit_strategy";
-export declare class SmartEditStrategyEvent implements BaseTelemetryEvent {
-    'event.name': 'smart_edit_strategy';
+export declare const EVENT_EDIT_STRATEGY = "gemini_cli.edit_strategy";
+export declare class EditStrategyEvent implements BaseTelemetryEvent {
+    'event.name': 'edit_strategy';
     'event.timestamp': string;
     strategy: string;
     constructor(strategy: string);
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
-export declare const EVENT_SMART_EDIT_CORRECTION = "gemini_cli.smart_edit_correction";
-export declare class SmartEditCorrectionEvent implements BaseTelemetryEvent {
-    'event.name': 'smart_edit_correction';
+export declare const EVENT_EDIT_CORRECTION = "gemini_cli.edit_correction";
+export declare class EditCorrectionEvent implements BaseTelemetryEvent {
+    'event.name': 'edit_correction';
     'event.timestamp': string;
     correction: 'success' | 'failure';
     constructor(correction: 'success' | 'failure');
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
+export interface StartupPhaseStats {
+    name: string;
+    duration_ms: number;
+    cpu_usage_user_usec: number;
+    cpu_usage_system_usec: number;
+    start_time_usec: number;
+    end_time_usec: number;
+}
+export declare const EVENT_STARTUP_STATS = "gemini_cli.startup_stats";
+export declare class StartupStatsEvent implements BaseTelemetryEvent {
+    'event.name': 'startup_stats';
+    'event.timestamp': string;
+    phases: StartupPhaseStats[];
+    os_platform: string;
+    os_release: string;
+    is_docker: boolean;
+    constructor(phases: StartupPhaseStats[], os_platform: string, os_release: string, is_docker: boolean);
+    toOpenTelemetryAttributes(config: Config): LogAttributes;
+    toLogBody(): string;
+}
 declare abstract class BaseAgentEvent implements BaseTelemetryEvent {
     abstract 'event.name': 'agent_start' | 'agent_finish' | 'agent_recovery_attempt';
     'event.timestamp': string;
@@ -496,3 +523,22 @@ export declare class WebFetchFallbackAttemptEvent implements BaseTelemetryEvent
     toOpenTelemetryAttributes(config: Config): LogAttributes;
     toLogBody(): string;
 }
+export declare const EVENT_HOOK_CALL = "gemini_cli.hook_call";
+export declare class HookCallEvent implements BaseTelemetryEvent {
+    'event.name': string;
+    'event.timestamp': string;
+    hook_event_name: string;
+    hook_type: 'command';
+    hook_name: string;
+    hook_input: Record<string, unknown>;
+    hook_output?: Record<string, unknown>;
+    exit_code?: number;
+    stdout?: string;
+    stderr?: string;
+    duration_ms: number;
+    success: boolean;
+    error?: string;
+    constructor(hookEventName: string, hookType: 'command', hookName: string, hookInput: Record<string, unknown>, durationMs: number, success: boolean, hookOutput?: Record<string, unknown>, exitCode?: number, stdout?: string, stderr?: string, error?: string);
+    toOpenTelemetryAttributes(config: Config): LogAttributes;
+    toLogBody(): string;
+}

package/dist/src/telemetry/types.js

@@ -12,6 +12,7 @@ import { getCommonAttributes } from './telemetryAttributes.js';
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
 import { safeJsonStringify } from '../utils/safeJsonStringify.js';
 import { toInputMessages, toOutputMessages, toFinishReasons, toOutputType, toSystemInstruction, } from './semantic.js';
+import { sanitizeHookName } from './sanitize.js';
 export const EVENT_CLI_CONFIG = 'gemini_cli.config';
 export class StartSessionEvent {
     'event.name';
@@ -74,9 +75,7 @@ export class StartSessionEvent {
                 .getAllTools()
                 .filter((tool) => tool instanceof DiscoveredMCPTool);
             this.mcp_tools_count = mcpTools.length;
-            this.mcp_tools = mcpTools
-                .map((tool) => tool.name)
-                .join(',');
+            this.mcp_tools = mcpTools.map((tool) => tool.name).join(',');
         }
     }
     toOpenTelemetryAttributes(config) {
@@ -276,27 +275,50 @@ export class ApiRequestEvent {
     'event.name';
     'event.timestamp';
     model;
-    prompt_id;
+    prompt;
     request_text;
-    constructor(model, prompt_id, request_text) {
+    constructor(model, prompt_details, request_text) {
         this['event.name'] = 'api_request';
         this['event.timestamp'] = new Date().toISOString();
         this.model = model;
-        this.prompt_id = prompt_id;
+        this.prompt = prompt_details;
         this.request_text = request_text;
     }
-    toOpenTelemetryAttributes(config) {
-        return {
+    toLogRecord(config) {
+        const attributes = {
             ...getCommonAttributes(config),
             'event.name': EVENT_API_REQUEST,
             'event.timestamp': this['event.timestamp'],
             model: this.model,
-            prompt_id: this.prompt_id,
+            prompt_id: this.prompt.prompt_id,
             request_text: this.request_text,
         };
+        return { body: `API request to ${this.model}.`, attributes };
     }
-    toLogBody() {
-        return `API request to ${this.model}.`;
+    toSemanticLogRecord(config) {
+        const { 'gen_ai.response.model': _, ...requestConventionAttributes } = getConventionAttributes({
+            model: this.model,
+            auth_type: config.getContentGeneratorConfig()?.authType,
+        });
+        const attributes = {
+            ...getCommonAttributes(config),
+            'event.name': EVENT_GEN_AI_OPERATION_DETAILS,
+            'event.timestamp': this['event.timestamp'],
+            ...toGenerateContentConfigAttributes(this.prompt.generate_content_config),
+            ...requestConventionAttributes,
+        };
+        if (this.prompt.server) {
+            attributes['server.address'] = this.prompt.server.address;
+            attributes['server.port'] = this.prompt.server.port;
+        }
+        if (config.getTelemetryLogPromptsEnabled() && this.prompt.contents) {
+            attributes['gen_ai.input.messages'] = JSON.stringify(toInputMessages(this.prompt.contents));
+        }
+        const logRecord = {
+            body: `GenAI operation request details from ${this.model}.`,
+            attributes,
+        };
+        return logRecord;
     }
 }
 export const EVENT_API_ERROR = 'gemini_cli.api_error';
@@ -401,6 +423,7 @@ export class ApiResponseEvent {
     prompt;
     response;
     usage;
+    finish_reasons;
     constructor(model, duration_ms, prompt_details, response_details, auth_type, usage_data, response_text) {
         this['event.name'] = 'api_response';
         this['event.timestamp'] = new Date().toISOString();
@@ -419,6 +442,7 @@ export class ApiResponseEvent {
             tool_token_count: usage_data?.toolUsePromptTokenCount ?? 0,
             total_token_count: usage_data?.totalTokenCount ?? 0,
         };
+        this.finish_reasons = toFinishReasons(this.response.candidates);
     }
     toLogRecord(config) {
         const attributes = {
@@ -436,6 +460,7 @@ export class ApiResponseEvent {
             prompt_id: this.prompt.prompt_id,
             auth_type: this.auth_type,
             status_code: this.status_code,
+            finish_reasons: this.finish_reasons,
         };
         if (this.response_text) {
             attributes['response_text'] = this.response_text;
@@ -457,7 +482,7 @@ export class ApiResponseEvent {
             'event.name': EVENT_GEN_AI_OPERATION_DETAILS,
             'event.timestamp': this['event.timestamp'],
             'gen_ai.response.id': this.response.response_id,
-            'gen_ai.response.finish_reasons': toFinishReasons(this.response.candidates),
+            'gen_ai.response.finish_reasons': this.finish_reasons,
             'gen_ai.output.messages': JSON.stringify(toOutputMessages(this.response.candidates)),
             ...toGenerateContentConfigAttributes(this.prompt.generate_content_config),
             ...getConventionAttributes(this),
@@ -910,14 +935,16 @@ export class ExtensionInstallEvent {
     'event.name';
     'event.timestamp';
     extension_name;
+    hashed_extension_name;
     extension_id;
     extension_version;
     extension_source;
     status;
-    constructor(extension_name, extension_id, extension_version, extension_source, status) {
+    constructor(extension_name, hashed_extension_name, extension_id, extension_version, extension_source, status) {
         this['event.name'] = 'extension_install';
         this['event.timestamp'] = new Date().toISOString();
         this.extension_name = extension_name;
+        this.hashed_extension_name = hashed_extension_name;
         this.extension_id = extension_id;
         this.extension_version = extension_version;
         this.extension_source = extension_source;
@@ -981,12 +1008,14 @@ export class ExtensionUninstallEvent {
     'event.name';
     'event.timestamp';
     extension_name;
+    hashed_extension_name;
     extension_id;
     status;
-    constructor(extension_name, extension_id, status) {
+    constructor(extension_name, hashed_extension_name, extension_id, status) {
         this['event.name'] = 'extension_uninstall';
         this['event.timestamp'] = new Date().toISOString();
         this.extension_name = extension_name;
+        this.hashed_extension_name = hashed_extension_name;
         this.extension_id = extension_id;
         this.status = status;
     }
@@ -1008,15 +1037,17 @@ export class ExtensionUpdateEvent {
     'event.name';
     'event.timestamp';
     extension_name;
+    hashed_extension_name;
     extension_id;
     extension_previous_version;
     extension_version;
     extension_source;
     status;
-    constructor(extension_name, extension_id, extension_version, extension_previous_version, extension_source, status) {
+    constructor(extension_name, hashed_extension_name, extension_id, extension_version, extension_previous_version, extension_source, status) {
         this['event.name'] = 'extension_update';
         this['event.timestamp'] = new Date().toISOString();
         this.extension_name = extension_name;
+        this.hashed_extension_name = hashed_extension_name;
         this.extension_id = extension_id;
         this.extension_version = extension_version;
         this.extension_previous_version = extension_previous_version;
@@ -1044,12 +1075,14 @@ export class ExtensionEnableEvent {
     'event.name';
     'event.timestamp';
     extension_name;
+    hashed_extension_name;
     extension_id;
     setting_scope;
-    constructor(extension_name, extension_id, settingScope) {
+    constructor(extension_name, hashed_extension_name, extension_id, settingScope) {
         this['event.name'] = 'extension_enable';
         this['event.timestamp'] = new Date().toISOString();
         this.extension_name = extension_name;
+        this.hashed_extension_name = hashed_extension_name;
         this.extension_id = extension_id;
         this.setting_scope = settingScope;
     }
@@ -1126,12 +1159,14 @@ export class ExtensionDisableEvent {
     'event.name';
     'event.timestamp';
     extension_name;
+    hashed_extension_name;
     extension_id;
     setting_scope;
-    constructor(extension_name, extension_id, settingScope) {
+    constructor(extension_name, hashed_extension_name, extension_id, settingScope) {
         this['event.name'] = 'extension_disable';
         this['event.timestamp'] = new Date().toISOString();
         this.extension_name = extension_name;
+        this.hashed_extension_name = hashed_extension_name;
         this.extension_id = extension_id;
         this.setting_scope = settingScope;
     }
@@ -1148,48 +1183,79 @@ export class ExtensionDisableEvent {
         return `Disabled extension ${this.extension_name}`;
     }
 }
-export const EVENT_SMART_EDIT_STRATEGY = 'gemini_cli.smart_edit_strategy';
-export class SmartEditStrategyEvent {
+export const EVENT_EDIT_STRATEGY = 'gemini_cli.edit_strategy';
+export class EditStrategyEvent {
     'event.name';
     'event.timestamp';
     strategy;
     constructor(strategy) {
-        this['event.name'] = 'smart_edit_strategy';
+        this['event.name'] = 'edit_strategy';
         this['event.timestamp'] = new Date().toISOString();
         this.strategy = strategy;
     }
     toOpenTelemetryAttributes(config) {
         return {
             ...getCommonAttributes(config),
-            'event.name': EVENT_SMART_EDIT_STRATEGY,
+            'event.name': EVENT_EDIT_STRATEGY,
             'event.timestamp': this['event.timestamp'],
             strategy: this.strategy,
         };
     }
     toLogBody() {
-        return `Smart Edit Tool Strategy: ${this.strategy}`;
+        return `Edit Tool Strategy: ${this.strategy}`;
     }
 }
-export const EVENT_SMART_EDIT_CORRECTION = 'gemini_cli.smart_edit_correction';
-export class SmartEditCorrectionEvent {
+export const EVENT_EDIT_CORRECTION = 'gemini_cli.edit_correction';
+export class EditCorrectionEvent {
     'event.name';
     'event.timestamp';
     correction;
     constructor(correction) {
-        this['event.name'] = 'smart_edit_correction';
+        this['event.name'] = 'edit_correction';
         this['event.timestamp'] = new Date().toISOString();
         this.correction = correction;
     }
     toOpenTelemetryAttributes(config) {
         return {
             ...getCommonAttributes(config),
-            'event.name': EVENT_SMART_EDIT_CORRECTION,
+            'event.name': EVENT_EDIT_CORRECTION,
             'event.timestamp': this['event.timestamp'],
             correction: this.correction,
         };
     }
     toLogBody() {
-        return `Smart Edit Tool Correction: ${this.correction}`;
+        return `Edit Tool Correction: ${this.correction}`;
+    }
+}
+export const EVENT_STARTUP_STATS = 'gemini_cli.startup_stats';
+export class StartupStatsEvent {
+    'event.name';
+    'event.timestamp';
+    phases;
+    os_platform;
+    os_release;
+    is_docker;
+    constructor(phases, os_platform, os_release, is_docker) {
+        this['event.name'] = 'startup_stats';
+        this['event.timestamp'] = new Date().toISOString();
+        this.phases = phases;
+        this.os_platform = os_platform;
+        this.os_release = os_release;
+        this.is_docker = is_docker;
+    }
+    toOpenTelemetryAttributes(config) {
+        return {
+            ...getCommonAttributes(config),
+            'event.name': EVENT_STARTUP_STATS,
+            'event.timestamp': this['event.timestamp'],
+            phases: JSON.stringify(this.phases),
+            os_platform: this.os_platform,
+            os_release: this.os_release,
+            is_docker: this.is_docker,
+        };
+    }
+    toLogBody() {
+        return `Startup stats: ${this.phases.length} phases recorded.`;
     }
 }
 class BaseAgentEvent {
@@ -1301,4 +1367,68 @@ export class WebFetchFallbackAttemptEvent {
         return `Web fetch fallback attempt. Reason: ${this.reason}`;
     }
 }
+export const EVENT_HOOK_CALL = 'gemini_cli.hook_call';
+export class HookCallEvent {
+    'event.name';
+    'event.timestamp';
+    hook_event_name;
+    hook_type;
+    hook_name;
+    hook_input;
+    hook_output;
+    exit_code;
+    stdout;
+    stderr;
+    duration_ms;
+    success;
+    error;
+    constructor(hookEventName, hookType, hookName, hookInput, durationMs, success, hookOutput, exitCode, stdout, stderr, error) {
+        this['event.name'] = 'hook_call';
+        this['event.timestamp'] = new Date().toISOString();
+        this.hook_event_name = hookEventName;
+        this.hook_type = hookType;
+        this.hook_name = hookName;
+        this.hook_input = hookInput;
+        this.hook_output = hookOutput;
+        this.exit_code = exitCode;
+        this.stdout = stdout;
+        this.stderr = stderr;
+        this.duration_ms = durationMs;
+        this.success = success;
+        this.error = error;
+    }
+    toOpenTelemetryAttributes(config) {
+        const attributes = {
+            ...getCommonAttributes(config),
+            'event.name': EVENT_HOOK_CALL,
+            'event.timestamp': this['event.timestamp'],
+            hook_event_name: this.hook_event_name,
+            hook_type: this.hook_type,
+            // Sanitize hook_name unless full logging is enabled
+            hook_name: config.getTelemetryLogPromptsEnabled()
+                ? this.hook_name
+                : sanitizeHookName(this.hook_name),
+            duration_ms: this.duration_ms,
+            success: this.success,
+            exit_code: this.exit_code,
+        };
+        // Only include potentially sensitive data if telemetry logging of prompts is enabled
+        if (config.getTelemetryLogPromptsEnabled()) {
+            attributes['hook_input'] = safeJsonStringify(this.hook_input, 2);
+            attributes['hook_output'] = safeJsonStringify(this.hook_output, 2);
+            attributes['stdout'] = this.stdout;
+            attributes['stderr'] = this.stderr;
+        }
+        if (this.error) {
+            // Always log errors
+            attributes['error'] = this.error;
+        }
+        return attributes;
+    }
+    toLogBody() {
+        const hookId = `${this.hook_event_name}.${this.hook_name}`;
+        const status = `${this.success ? 'succeeded' : 'failed'}`;
+        return `Hook call ${hookId} ${status} in ${this.duration_ms}ms`;
+    }
+}
 //# sourceMappingURL=types.js.map