2025-06-05 16:04:25 -04:00
|
|
|
/**
|
|
|
|
|
* @license
|
|
|
|
|
* Copyright 2025 Google LLC
|
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
*/
|
|
|
|
|
|
Add telemetry command and refactor telemetry settings (#1060)
#750
### Telemetry Settings
Refactors telemetry configuration to use a nested `telemetry` object in `settings.json`, for example:
```json
{
"telemetry": {
"enabled": true,
"target": "gcp"
"log-prompts": "true"
},
"sandbox": false
}
```
The above includes
- Centralized telemetry settings under a `telemetry` object in `settings.json`.
- CLI flags for the `gemini` command to override all telemetry sub-settings:
- `--telemetry` / `--no-telemetry`
- `--telemetry-target <local|gcp>`
- `--telemetry-otlp-endpoint <URL>`
- `--telemetry-log-prompts` / `--no-telemetry-log-prompts`
- Updates `packages/cli/src/config/config.ts` and `packages/core/src/config/config.ts` to read from the new settings structure and respect the new CLI flags.
- Modifies `scripts/handle-telemetry.js`, `scripts/local_telemetry.js`, and `scripts/telemetry_utils.js` to align with the new settings structure.
- Updates `docs/core/telemetry.md` to reflect the new settings structure, CLI flags, and order of precedence.
- Renames `logUserPromptsEnabled` to `logPrompts` for brevity.
### `npm run telemetry`
Add a new `npm run telemetry` command that uses `scripts/telemetry.js`, automates the entire process of setting up a local and GCP telemetry pipelines, including configuring the necessary settings in the `.gemini/settings.json` workspace file and installing required binaries (e.g. `otelcol-contrib`).
---
```shell
$ npm run telemetry -- --target=gcp
> gemini-cli@0.1.0 telemetry
> node scripts/telemetry.js --target=gcp
⚙️ Using command-line target: gcp
🚀 Running telemetry script for target: gcp.
✨ Starting Local Telemetry Exporter for Google Cloud ✨
⚙️ Enabled telemetry in workspace settings.
🔧 Set telemetry OTLP endpoint to http://localhost:4317.
🎯 Set telemetry target to gcp.
✅ Workspace settings updated.
✅ Using Google Cloud Project ID: foo-bar
🔑 Please ensure you are authenticated with Google Cloud:
- Run `gcloud auth application-default login` OR ensure `GOOGLE_APPLICATION_CREDENTIALS` environment variable points to a valid service account key.
- The account needs "Cloud Trace Agent", "Monitoring Metric Writer", and "Logs Writer" roles.
✅ otelcol-contrib already exists at /Users/jerop/github/gemini-cli/.gemini/otel/bin/otelcol-contrib
🧹 Cleaning up old processes and logs...
✅ Deleted old GCP collector log.
📄 Wrote OTEL collector config to /Users/jerop/github/gemini-cli/.gemini/otel/collector-gcp.yaml
🚀 Starting OTEL collector for GCP... Logs: /Users/jerop/github/gemini-cli/.gemini/otel/collector-gcp.log
⏳ Waiting for OTEL collector to start (PID: 17013)...
✅ OTEL collector started successfully on port 4317.
✨ Local OTEL collector for GCP is running.
🚀 To send telemetry, run the Gemini CLI in a separate terminal window.
📄 Collector logs are being written to: /Users/jerop/github/gemini-cli/.gemini/otel/collector-gcp.log
📊 View your telemetry data in Google Cloud Console:
- Logs: https://console.cloud.google.com/logs/query;query=logName%3D%22projects%2Ffoo-bar%2Flogs%2Fgemini_cli%22?project=foo-bar
- Metrics: https://console.cloud.google.com/monitoring/metrics-explorer?project=foo-bar
- Traces: https://console.cloud.google.com/traces/list?project=foo-bar
Press Ctrl+C to exit.
^C
👋 Shutting down...
⚙️ Disabled telemetry in workspace settings.
🔧 Cleared telemetry OTLP endpoint.
🎯 Cleared telemetry target.
✅ Workspace settings updated.
🛑 Stopping otelcol-contrib (PID: 17013)...
✅ otelcol-contrib stopped.
```
2025-06-15 00:47:32 -04:00
|
|
|
export enum TelemetryTarget {
|
|
|
|
|
GCP = 'gcp',
|
|
|
|
|
LOCAL = 'local',
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const DEFAULT_TELEMETRY_TARGET = TelemetryTarget.LOCAL;
|
|
|
|
|
const DEFAULT_OTLP_ENDPOINT = 'http://localhost:4317';
|
|
|
|
|
|
|
|
|
|
export { DEFAULT_TELEMETRY_TARGET, DEFAULT_OTLP_ENDPOINT };
|
2025-06-05 16:04:25 -04:00
|
|
|
export {
|
|
|
|
|
initializeTelemetry,
|
|
|
|
|
shutdownTelemetry,
|
|
|
|
|
isTelemetrySdkInitialized,
|
|
|
|
|
} from './sdk.js';
|
2025-09-23 03:23:06 +09:00
|
|
|
export {
|
|
|
|
|
resolveTelemetrySettings,
|
|
|
|
|
parseBooleanEnvFlag,
|
|
|
|
|
parseTelemetryTargetValue,
|
|
|
|
|
} from './config.js';
|
2025-09-17 04:13:57 +09:00
|
|
|
export {
|
|
|
|
|
GcpTraceExporter,
|
|
|
|
|
GcpMetricExporter,
|
|
|
|
|
GcpLogExporter,
|
|
|
|
|
} from './gcp-exporters.js';
|
2025-06-05 16:04:25 -04:00
|
|
|
export {
|
|
|
|
|
logCliConfiguration,
|
|
|
|
|
logUserPrompt,
|
|
|
|
|
logToolCall,
|
|
|
|
|
logApiRequest,
|
|
|
|
|
logApiError,
|
|
|
|
|
logApiResponse,
|
2025-07-12 02:40:25 +05:30
|
|
|
logFlashFallback,
|
2025-07-29 16:20:37 -04:00
|
|
|
logSlashCommand,
|
2025-08-25 16:06:47 -04:00
|
|
|
logConversationFinishedEvent,
|
2025-08-13 13:32:54 -04:00
|
|
|
logKittySequenceOverflow,
|
2025-08-18 15:59:13 -04:00
|
|
|
logChatCompression,
|
2025-09-11 08:40:46 -07:00
|
|
|
logToolOutputTruncated,
|
2025-09-22 12:55:43 -04:00
|
|
|
logExtensionEnable,
|
|
|
|
|
logExtensionInstallEvent,
|
|
|
|
|
logExtensionUninstall,
|
2025-10-10 14:28:13 -07:00
|
|
|
logExtensionUpdateEvent,
|
2025-10-09 13:01:17 -04:00
|
|
|
logWebFetchFallbackAttempt,
|
2025-06-05 16:04:25 -04:00
|
|
|
} from './loggers.js';
|
2025-08-26 00:04:53 +02:00
|
|
|
export type { SlashCommandEvent, ChatCompressionEvent } from './types.js';
|
2025-06-05 16:04:25 -04:00
|
|
|
export {
|
2025-08-26 00:04:53 +02:00
|
|
|
SlashCommandStatus,
|
2025-06-22 09:26:48 -05:00
|
|
|
EndSessionEvent,
|
2025-06-05 16:04:25 -04:00
|
|
|
UserPromptEvent,
|
|
|
|
|
ApiRequestEvent,
|
|
|
|
|
ApiErrorEvent,
|
|
|
|
|
ApiResponseEvent,
|
2025-07-12 02:40:25 +05:30
|
|
|
FlashFallbackEvent,
|
2025-08-26 00:04:53 +02:00
|
|
|
StartSessionEvent,
|
|
|
|
|
ToolCallEvent,
|
2025-08-25 16:06:47 -04:00
|
|
|
ConversationFinishedEvent,
|
2025-08-13 13:32:54 -04:00
|
|
|
KittySequenceOverflowEvent,
|
2025-09-11 08:40:46 -07:00
|
|
|
ToolOutputTruncatedEvent,
|
2025-10-09 13:01:17 -04:00
|
|
|
WebFetchFallbackAttemptEvent,
|
2025-10-17 16:16:12 -07:00
|
|
|
ToolCallDecision,
|
2025-06-05 16:04:25 -04:00
|
|
|
} from './types.js';
|
2025-08-26 00:04:53 +02:00
|
|
|
export { makeSlashCommandEvent, makeChatCompressionEvent } from './types.js';
|
|
|
|
|
export type { TelemetryEvent } from './types.js';
|
2025-06-05 16:04:25 -04:00
|
|
|
export { SpanStatusCode, ValueType } from '@opentelemetry/api';
|
|
|
|
|
export { SemanticAttributes } from '@opentelemetry/semantic-conventions';
|
2025-06-29 20:44:33 -04:00
|
|
|
export * from './uiTelemetry.js';
|
2025-10-08 01:23:17 +02:00
|
|
|
export {
|
|
|
|
|
MemoryMonitor,
|
|
|
|
|
initializeMemoryMonitor,
|
|
|
|
|
getMemoryMonitor,
|
|
|
|
|
recordCurrentMemoryUsage,
|
|
|
|
|
startGlobalMemoryMonitoring,
|
|
|
|
|
stopGlobalMemoryMonitoring,
|
|
|
|
|
} from './memory-monitor.js';
|
|
|
|
|
export type { MemorySnapshot, ProcessMetrics } from './memory-monitor.js';
|
2025-09-10 00:49:10 +02:00
|
|
|
export { HighWaterMarkTracker } from './high-water-mark-tracker.js';
|
|
|
|
|
export { RateLimiter } from './rate-limiter.js';
|
2025-09-18 01:56:00 +02:00
|
|
|
export { ActivityType } from './activity-types.js';
|
|
|
|
|
export {
|
|
|
|
|
ActivityDetector,
|
|
|
|
|
getActivityDetector,
|
|
|
|
|
recordUserActivity,
|
|
|
|
|
isUserActive,
|
|
|
|
|
} from './activity-detector.js';
|
2025-10-20 19:29:53 +02:00
|
|
|
export {
|
|
|
|
|
ActivityMonitor,
|
|
|
|
|
initializeActivityMonitor,
|
|
|
|
|
getActivityMonitor,
|
|
|
|
|
startGlobalActivityMonitoring,
|
|
|
|
|
stopGlobalActivityMonitoring,
|
|
|
|
|
} from './activity-monitor.js';
|
2025-09-25 18:12:46 +02:00
|
|
|
export {
|
|
|
|
|
// Core metrics functions
|
|
|
|
|
recordToolCallMetrics,
|
|
|
|
|
recordTokenUsageMetrics,
|
|
|
|
|
recordApiResponseMetrics,
|
|
|
|
|
recordApiErrorMetrics,
|
|
|
|
|
recordFileOperationMetric,
|
|
|
|
|
recordInvalidChunk,
|
|
|
|
|
recordContentRetry,
|
|
|
|
|
recordContentRetryFailure,
|
|
|
|
|
recordModelRoutingMetrics,
|
2025-10-01 16:24:55 -04:00
|
|
|
// Custom metrics for token usage and API responses
|
|
|
|
|
recordCustomTokenUsageMetrics,
|
|
|
|
|
recordCustomApiResponseMetrics,
|
2025-10-22 17:39:27 -04:00
|
|
|
recordExitFail,
|
2025-10-01 16:24:55 -04:00
|
|
|
// OpenTelemetry GenAI semantic convention for token usage and operation duration
|
|
|
|
|
recordGenAiClientTokenUsage,
|
|
|
|
|
recordGenAiClientOperationDuration,
|
|
|
|
|
getConventionAttributes,
|
2025-09-25 18:12:46 +02:00
|
|
|
// Performance monitoring functions
|
|
|
|
|
recordStartupPerformance,
|
|
|
|
|
recordMemoryUsage,
|
|
|
|
|
recordCpuUsage,
|
|
|
|
|
recordToolQueueDepth,
|
|
|
|
|
recordToolExecutionBreakdown,
|
|
|
|
|
recordTokenEfficiency,
|
|
|
|
|
recordApiRequestBreakdown,
|
|
|
|
|
recordPerformanceScore,
|
|
|
|
|
recordPerformanceRegression,
|
|
|
|
|
recordBaselineComparison,
|
|
|
|
|
isPerformanceMonitoringActive,
|
2025-10-10 13:18:38 -07:00
|
|
|
recordFlickerFrame,
|
2025-09-25 18:12:46 +02:00
|
|
|
// Performance monitoring types
|
|
|
|
|
PerformanceMetricType,
|
|
|
|
|
MemoryMetricType,
|
|
|
|
|
ToolExecutionPhase,
|
|
|
|
|
ApiRequestPhase,
|
|
|
|
|
FileOperation,
|
2025-10-01 16:24:55 -04:00
|
|
|
// OpenTelemetry Semantic Convention types
|
|
|
|
|
GenAiOperationName,
|
|
|
|
|
GenAiProviderName,
|
|
|
|
|
GenAiTokenType,
|
2025-09-25 18:12:46 +02:00
|
|
|
} from './metrics.js';
|