@google/gemini-cli-core 0.0.1

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

@@ -0,0 +1,284 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { GenerateContentResponseUsageMetadata } from '@google/genai';
+import type { Config } from '../config/config.js';
+import type { ApprovalMode } from '../config/config.js';
+import type { CompletedToolCall } from '../core/coreToolScheduler.js';
+import { ToolCallDecision } from './tool-call-decision.js';
+import type { FileOperation } from './metrics.js';
+export { ToolCallDecision };
+import type { ToolRegistry } from '../tools/tool-registry.js';
+import type { OutputFormat } from '../output/types.js';
+export interface BaseTelemetryEvent {
+    'event.name': string;
+    /** Current timestamp in ISO 8601 format */
+    'event.timestamp': string;
+}
+type CommonFields = keyof BaseTelemetryEvent;
+export declare class StartSessionEvent implements BaseTelemetryEvent {
+    'event.name': 'cli_config';
+    'event.timestamp': string;
+    model: string;
+    embedding_model: string;
+    sandbox_enabled: boolean;
+    core_tools_enabled: string;
+    approval_mode: string;
+    api_key_enabled: boolean;
+    vertex_ai_enabled: boolean;
+    debug_enabled: boolean;
+    mcp_servers: string;
+    telemetry_enabled: boolean;
+    telemetry_log_user_prompts_enabled: boolean;
+    file_filtering_respect_git_ignore: boolean;
+    mcp_servers_count: number;
+    mcp_tools_count?: number;
+    mcp_tools?: string;
+    output_format: OutputFormat;
+    constructor(config: Config, toolRegistry?: ToolRegistry);
+}
+export declare class EndSessionEvent implements BaseTelemetryEvent {
+    'event.name': 'end_session';
+    'event.timestamp': string;
+    session_id?: string;
+    constructor(config?: Config);
+}
+export declare class UserPromptEvent implements BaseTelemetryEvent {
+    'event.name': 'user_prompt';
+    'event.timestamp': string;
+    prompt_length: number;
+    prompt_id: string;
+    auth_type?: string;
+    prompt?: string;
+    constructor(prompt_length: number, prompt_Id: string, auth_type?: string, prompt?: string);
+}
+export declare class ToolCallEvent implements BaseTelemetryEvent {
+    'event.name': 'tool_call';
+    'event.timestamp': string;
+    function_name: string;
+    function_args: Record<string, unknown>;
+    duration_ms: number;
+    success: boolean;
+    decision?: ToolCallDecision;
+    error?: string;
+    error_type?: string;
+    prompt_id: string;
+    tool_type: 'native' | 'mcp';
+    content_length?: number;
+    metadata?: {
+        [key: string]: any;
+    };
+    constructor(call: CompletedToolCall);
+}
+export declare class ApiRequestEvent implements BaseTelemetryEvent {
+    'event.name': 'api_request';
+    'event.timestamp': string;
+    model: string;
+    prompt_id: string;
+    request_text?: string;
+    constructor(model: string, prompt_id: string, request_text?: string);
+}
+export declare class ApiErrorEvent implements BaseTelemetryEvent {
+    'event.name': 'api_error';
+    'event.timestamp': string;
+    model: string;
+    error: string;
+    error_type?: string;
+    status_code?: number | string;
+    duration_ms: number;
+    prompt_id: string;
+    auth_type?: string;
+    constructor(model: string, error: string, duration_ms: number, prompt_id: string, auth_type?: string, error_type?: string, status_code?: number | string);
+}
+export declare class ApiResponseEvent implements BaseTelemetryEvent {
+    'event.name': 'api_response';
+    'event.timestamp': string;
+    model: string;
+    status_code?: number | string;
+    duration_ms: number;
+    input_token_count: number;
+    output_token_count: number;
+    cached_content_token_count: number;
+    thoughts_token_count: number;
+    tool_token_count: number;
+    total_token_count: number;
+    response_text?: string;
+    prompt_id: string;
+    auth_type?: string;
+    constructor(model: string, duration_ms: number, prompt_id: string, auth_type?: string, usage_data?: GenerateContentResponseUsageMetadata, response_text?: string);
+}
+export declare class FlashFallbackEvent implements BaseTelemetryEvent {
+    'event.name': 'flash_fallback';
+    'event.timestamp': string;
+    auth_type: string;
+    constructor(auth_type: string);
+}
+export declare class RipgrepFallbackEvent implements BaseTelemetryEvent {
+    error?: string | undefined;
+    'event.name': 'ripgrep_fallback';
+    'event.timestamp': string;
+    constructor(error?: string | undefined);
+}
+export declare enum LoopType {
+    CONSECUTIVE_IDENTICAL_TOOL_CALLS = "consecutive_identical_tool_calls",
+    CHANTING_IDENTICAL_SENTENCES = "chanting_identical_sentences",
+    LLM_DETECTED_LOOP = "llm_detected_loop"
+}
+export declare class LoopDetectedEvent implements BaseTelemetryEvent {
+    'event.name': 'loop_detected';
+    'event.timestamp': string;
+    loop_type: LoopType;
+    prompt_id: string;
+    constructor(loop_type: LoopType, prompt_id: string);
+}
+export declare class LoopDetectionDisabledEvent implements BaseTelemetryEvent {
+    'event.name': 'loop_detection_disabled';
+    'event.timestamp': string;
+    prompt_id: string;
+    constructor(prompt_id: string);
+}
+export declare class NextSpeakerCheckEvent implements BaseTelemetryEvent {
+    'event.name': 'next_speaker_check';
+    'event.timestamp': string;
+    prompt_id: string;
+    finish_reason: string;
+    result: string;
+    constructor(prompt_id: string, finish_reason: string, result: string);
+}
+export interface SlashCommandEvent extends BaseTelemetryEvent {
+    'event.name': 'slash_command';
+    'event.timestamp': string;
+    command: string;
+    subcommand?: string;
+    status?: SlashCommandStatus;
+}
+export declare function makeSlashCommandEvent({ command, subcommand, status, }: Omit<SlashCommandEvent, CommonFields>): SlashCommandEvent;
+export declare enum SlashCommandStatus {
+    SUCCESS = "success",
+    ERROR = "error"
+}
+export interface ChatCompressionEvent extends BaseTelemetryEvent {
+    'event.name': 'chat_compression';
+    'event.timestamp': string;
+    tokens_before: number;
+    tokens_after: number;
+}
+export declare function makeChatCompressionEvent({ tokens_before, tokens_after, }: Omit<ChatCompressionEvent, CommonFields>): ChatCompressionEvent;
+export declare class MalformedJsonResponseEvent implements BaseTelemetryEvent {
+    'event.name': 'malformed_json_response';
+    'event.timestamp': string;
+    model: string;
+    constructor(model: string);
+}
+export declare enum IdeConnectionType {
+    START = "start",
+    SESSION = "session"
+}
+export declare class IdeConnectionEvent {
+    'event.name': 'ide_connection';
+    'event.timestamp': string;
+    connection_type: IdeConnectionType;
+    constructor(connection_type: IdeConnectionType);
+}
+export declare class ConversationFinishedEvent {
+    'event_name': 'conversation_finished';
+    'event.timestamp': string;
+    approvalMode: ApprovalMode;
+    turnCount: number;
+    constructor(approvalMode: ApprovalMode, turnCount: number);
+}
+export declare class KittySequenceOverflowEvent {
+    'event.name': 'kitty_sequence_overflow';
+    'event.timestamp': string;
+    sequence_length: number;
+    truncated_sequence: string;
+    constructor(sequence_length: number, truncated_sequence: string);
+}
+export declare class FileOperationEvent implements BaseTelemetryEvent {
+    'event.name': 'file_operation';
+    'event.timestamp': string;
+    tool_name: string;
+    operation: FileOperation;
+    lines?: number;
+    mimetype?: string;
+    extension?: string;
+    programming_language?: string;
+    constructor(tool_name: string, operation: FileOperation, lines?: number, mimetype?: string, extension?: string, programming_language?: string);
+}
+export declare class InvalidChunkEvent implements BaseTelemetryEvent {
+    'event.name': 'invalid_chunk';
+    'event.timestamp': string;
+    error_message?: string;
+    constructor(error_message?: string);
+}
+export declare class ContentRetryEvent implements BaseTelemetryEvent {
+    'event.name': 'content_retry';
+    'event.timestamp': string;
+    attempt_number: number;
+    error_type: string;
+    retry_delay_ms: number;
+    constructor(attempt_number: number, error_type: string, retry_delay_ms: number);
+}
+export declare class ContentRetryFailureEvent implements BaseTelemetryEvent {
+    'event.name': 'content_retry_failure';
+    'event.timestamp': string;
+    total_attempts: number;
+    final_error_type: string;
+    total_duration_ms?: number;
+    constructor(total_attempts: number, final_error_type: string, total_duration_ms?: number);
+}
+export declare class ModelRoutingEvent implements BaseTelemetryEvent {
+    'event.name': 'model_routing';
+    'event.timestamp': string;
+    decision_model: string;
+    decision_source: string;
+    routing_latency_ms: number;
+    reasoning?: string;
+    failed: boolean;
+    error_message?: string;
+    constructor(decision_model: string, decision_source: string, routing_latency_ms: number, reasoning: string | undefined, failed: boolean, error_message: string | undefined);
+}
+export type TelemetryEvent = StartSessionEvent | EndSessionEvent | UserPromptEvent | ToolCallEvent | ApiRequestEvent | ApiErrorEvent | ApiResponseEvent | FlashFallbackEvent | LoopDetectedEvent | LoopDetectionDisabledEvent | NextSpeakerCheckEvent | KittySequenceOverflowEvent | MalformedJsonResponseEvent | IdeConnectionEvent | ConversationFinishedEvent | SlashCommandEvent | FileOperationEvent | InvalidChunkEvent | ContentRetryEvent | ContentRetryFailureEvent | ExtensionEnableEvent | ExtensionInstallEvent | ExtensionUninstallEvent | ModelRoutingEvent | ToolOutputTruncatedEvent;
+export declare class ExtensionInstallEvent implements BaseTelemetryEvent {
+    'event.name': 'extension_install';
+    'event.timestamp': string;
+    extension_name: string;
+    extension_version: string;
+    extension_source: string;
+    status: 'success' | 'error';
+    constructor(extension_name: string, extension_version: string, extension_source: string, status: 'success' | 'error');
+}
+export declare class ToolOutputTruncatedEvent implements BaseTelemetryEvent {
+    readonly eventName = "tool_output_truncated";
+    readonly 'event.timestamp': string;
+    'event.name': string;
+    tool_name: string;
+    original_content_length: number;
+    truncated_content_length: number;
+    threshold: number;
+    lines: number;
+    prompt_id: string;
+    constructor(prompt_id: string, details: {
+        toolName: string;
+        originalContentLength: number;
+        truncatedContentLength: number;
+        threshold: number;
+        lines: number;
+    });
+}
+export declare class ExtensionUninstallEvent implements BaseTelemetryEvent {
+    'event.name': 'extension_uninstall';
+    'event.timestamp': string;
+    extension_name: string;
+    status: 'success' | 'error';
+    constructor(extension_name: string, status: 'success' | 'error');
+}
+export declare class ExtensionEnableEvent implements BaseTelemetryEvent {
+    'event.name': 'extension_enable';
+    'event.timestamp': string;
+    extension_name: string;
+    setting_scope: string;
+    constructor(extension_name: string, settingScope: string);
+}