From 53753f0455458dda4055f42ca9caf3aa898bc3c4 Mon Sep 17 00:00:00 2001 From: Jerop Kipruto Date: Sun, 15 Jun 2025 00:47:32 -0400 Subject: Add telemetry command and refactor telemetry settings (#1060) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit #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 ` - `--telemetry-otlp-endpoint ` - `--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. ``` --- scripts/telemetry_utils.js | 39 +++++++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 10 deletions(-) (limited to 'scripts/telemetry_utils.js') diff --git a/scripts/telemetry_utils.js b/scripts/telemetry_utils.js index 62eb910b..05f607a2 100644 --- a/scripts/telemetry_utils.js +++ b/scripts/telemetry_utils.js @@ -10,7 +10,7 @@ import path from 'path'; import fs from 'fs'; import net from 'net'; import os from 'os'; -import { execSync } from 'child_process'; // Removed spawn, it's not used here +import { execSync } from 'child_process'; import { fileURLToPath } from 'url'; const __filename = fileURLToPath(import.meta.url); @@ -251,15 +251,20 @@ export async function ensureBinary( export function manageTelemetrySettings( enable, oTelEndpoint = 'http://localhost:4317', + target = 'local', originalSandboxSettingToRestore, ) { const workspaceSettings = readJsonFile(WORKSPACE_SETTINGS_FILE); const currentSandboxSetting = workspaceSettings.sandbox; let settingsModified = false; + if (typeof workspaceSettings.telemetry !== 'object') { + workspaceSettings.telemetry = {}; + } + if (enable) { - if (workspaceSettings.telemetry !== true) { - workspaceSettings.telemetry = true; + if (workspaceSettings.telemetry.enabled !== true) { + workspaceSettings.telemetry.enabled = true; settingsModified = true; console.log('โš™๏ธ Enabled telemetry in workspace settings.'); } @@ -268,22 +273,36 @@ export function manageTelemetrySettings( settingsModified = true; console.log('โœ… Disabled sandbox mode for telemetry.'); } - if (workspaceSettings.telemetryOtlpEndpoint !== oTelEndpoint) { - workspaceSettings.telemetryOtlpEndpoint = oTelEndpoint; + if (workspaceSettings.telemetry.otlpEndpoint !== oTelEndpoint) { + workspaceSettings.telemetry.otlpEndpoint = oTelEndpoint; settingsModified = true; console.log(`๐Ÿ”ง Set telemetry OTLP endpoint to ${oTelEndpoint}.`); } + if (workspaceSettings.telemetry.target !== target) { + workspaceSettings.telemetry.target = target; + settingsModified = true; + console.log(`๐ŸŽฏ Set telemetry target to ${target}.`); + } } else { - if (workspaceSettings.telemetry === true) { - delete workspaceSettings.telemetry; + if (workspaceSettings.telemetry.enabled === true) { + delete workspaceSettings.telemetry.enabled; settingsModified = true; - console.log('โš™๏ธ Disabled telemetry in workspace settings.'); + console.log('โš™๏ธ Disabled telemetry in workspace settings.'); } - if (workspaceSettings.telemetryOtlpEndpoint) { - delete workspaceSettings.telemetryOtlpEndpoint; + if (workspaceSettings.telemetry.otlpEndpoint) { + delete workspaceSettings.telemetry.otlpEndpoint; settingsModified = true; console.log('๐Ÿ”ง Cleared telemetry OTLP endpoint.'); } + if (workspaceSettings.telemetry.target) { + delete workspaceSettings.telemetry.target; + settingsModified = true; + console.log('๐ŸŽฏ Cleared telemetry target.'); + } + if (Object.keys(workspaceSettings.telemetry).length === 0) { + delete workspaceSettings.telemetry; + } + if ( originalSandboxSettingToRestore !== undefined && workspaceSettings.sandbox !== originalSandboxSettingToRestore -- cgit v1.2.3