diff options
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/local_telemetry.js | 27 | ||||
| -rwxr-xr-x | scripts/telemetry.js | 85 | ||||
| -rwxr-xr-x | scripts/telemetry_gcp.js | 12 | ||||
| -rw-r--r-- | scripts/telemetry_utils.js | 39 |
4 files changed, 143 insertions, 20 deletions
diff --git a/scripts/local_telemetry.js b/scripts/local_telemetry.js index 74e7f750..5d8c564f 100755 --- a/scripts/local_telemetry.js +++ b/scripts/local_telemetry.js @@ -348,8 +348,13 @@ async function main() { // Restore original settings const finalSettings = readJsonFile(WORKSPACE_SETTINGS_FILE); - delete finalSettings.telemetry; - delete finalSettings.telemetryOtlpEndpoint; + if (finalSettings.telemetry) { + delete finalSettings.telemetry.enabled; + delete finalSettings.telemetry.otlpEndpoint; + if (Object.keys(finalSettings.telemetry).length === 0) { + delete finalSettings.telemetry; + } + } finalSettings.sandbox = originalSandboxSetting; writeJsonFile(WORKSPACE_SETTINGS_FILE, finalSettings); console.log('ā
Restored original telemetry and sandbox settings.'); @@ -393,8 +398,12 @@ async function main() { const originalSandboxSetting = workspaceSettings.sandbox; let settingsModified = false; - if (workspaceSettings.telemetry !== true) { - workspaceSettings.telemetry = true; + if (typeof workspaceSettings.telemetry !== 'object') { + workspaceSettings.telemetry = {}; + } + + if (workspaceSettings.telemetry.enabled !== true) { + workspaceSettings.telemetry.enabled = true; settingsModified = true; console.log('āļø Enabled telemetry in workspace settings.'); } @@ -405,12 +414,18 @@ async function main() { console.log('ā
Disabled sandbox mode for local telemetry.'); } - if (workspaceSettings.telemetryOtlpEndpoint !== 'http://localhost:4317') { - workspaceSettings.telemetryOtlpEndpoint = 'http://localhost:4317'; + if (workspaceSettings.telemetry.otlpEndpoint !== 'http://localhost:4317') { + workspaceSettings.telemetry.otlpEndpoint = 'http://localhost:4317'; settingsModified = true; console.log('š§ Set telemetry endpoint to http://localhost:4317.'); } + if (workspaceSettings.telemetry.target !== 'local') { + workspaceSettings.telemetry.target = 'local'; + settingsModified = true; + console.log('šÆ Set telemetry target to local.'); + } + if (settingsModified) { writeJsonFile(WORKSPACE_SETTINGS_FILE, workspaceSettings); console.log('ā
Workspace settings updated.'); diff --git a/scripts/telemetry.js b/scripts/telemetry.js new file mode 100755 index 00000000..9d441072 --- /dev/null +++ b/scripts/telemetry.js @@ -0,0 +1,85 @@ +#!/usr/bin/env node + +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { execSync } from 'child_process'; +import { join } from 'path'; +import { existsSync, readFileSync } from 'fs'; + +const projectRoot = join(import.meta.dirname, '..'); + +const SETTINGS_DIRECTORY_NAME = '.gemini'; +const USER_SETTINGS_DIR = join( + process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH || '', + SETTINGS_DIRECTORY_NAME, +); +const USER_SETTINGS_PATH = join(USER_SETTINGS_DIR, 'settings.json'); +const WORKSPACE_SETTINGS_PATH = join( + projectRoot, + SETTINGS_DIRECTORY_NAME, + 'settings.json', +); + +let settingsTarget = undefined; + +function loadSettingsValue(filePath) { + try { + if (existsSync(filePath)) { + const content = readFileSync(filePath, 'utf-8'); + const jsonContent = content.replace(/\/\/[^\n]*/g, ''); + const settings = JSON.parse(jsonContent); + return settings.telemetry?.target; + } + } catch (e) { + console.warn( + `ā ļø Warning: Could not parse settings file at ${filePath}: ${e.message}`, + ); + } + return undefined; +} + +settingsTarget = loadSettingsValue(WORKSPACE_SETTINGS_PATH); + +if (!settingsTarget) { + settingsTarget = loadSettingsValue(USER_SETTINGS_PATH); +} + +let target = settingsTarget || 'local'; +const allowedTargets = ['local', 'gcp']; + +const targetArg = process.argv.find((arg) => arg.startsWith('--target=')); +if (targetArg) { + const potentialTarget = targetArg.split('=')[1]; + if (allowedTargets.includes(potentialTarget)) { + target = potentialTarget; + console.log(`āļø Using command-line target: ${target}`); + } else { + console.error( + `š Error: Invalid target '${potentialTarget}'. Allowed targets are: ${allowedTargets.join(', ')}.`, + ); + process.exit(1); + } +} else if (settingsTarget) { + console.log( + `āļø Using telemetry target from settings.json: ${settingsTarget}`, + ); +} + +const scriptPath = join( + projectRoot, + 'scripts', + target === 'gcp' ? 'telemetry_gcp.js' : 'local_telemetry.js', +); + +try { + console.log(`š Running telemetry script for target: ${target}.`); + execSync(`node ${scriptPath}`, { stdio: 'inherit', cwd: projectRoot }); +} catch (error) { + console.error(`š Failed to run telemetry script for target: ${target}`); + console.error(error); + process.exit(1); +} diff --git a/scripts/telemetry_gcp.js b/scripts/telemetry_gcp.js index 6fc3ebe4..c88a9dbc 100755 --- a/scripts/telemetry_gcp.js +++ b/scripts/telemetry_gcp.js @@ -70,6 +70,7 @@ async function main() { const originalSandboxSetting = manageTelemetrySettings( true, 'http://localhost:4317', + 'gcp', ); registerCleanup( () => [collectorProcess].filter((p) => p), // Function to get processes @@ -80,9 +81,12 @@ async function main() { const projectId = process.env.GOOGLE_CLOUD_PROJECT; if (!projectId) { console.error( - 'š Error: GOOGLE_CLOUD_PROJECT environment variable is not set.', + 'š Error: GOOGLE_CLOUD_PROJECT environment variable is not exported.', ); - console.log('Please set it to your Google Cloud Project ID and try again.'); + console.log( + ' Please set it to your Google Cloud Project ID and try again.', + ); + console.log(' `export GOOGLE_CLOUD_PROJECT=your-project-id`'); process.exit(1); } console.log(`ā
Using Google Cloud Project ID: ${projectId}`); @@ -167,13 +171,13 @@ async function main() { console.log(`\nš Collector logs are being written to: ${OTEL_LOG_FILE}`); console.log(`\nš View your telemetry data in Google Cloud Console:`); console.log( - ` - Traces: https://console.cloud.google.com/traces/list?project=${projectId}`, + ` - Logs: https://console.cloud.google.com/logs/query;query=logName%3D%22projects%2F${projectId}%2Flogs%2Fgemini_cli%22?project=${projectId}`, ); console.log( ` - Metrics: https://console.cloud.google.com/monitoring/metrics-explorer?project=${projectId}`, ); console.log( - ` - Logs: https://console.cloud.google.com/logs/query;query=logName%3D%22projects%2F${projectId}%2Flogs%2Fgemini_cli%22?project=${projectId}`, + ` - Traces: https://console.cloud.google.com/traces/list?project=${projectId}`, ); console.log(`\nPress Ctrl+C to exit.`); } 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 |