mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-19 09:33:53 +00:00
#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. ```
86 lines
2.3 KiB
JavaScript
Executable File
86 lines
2.3 KiB
JavaScript
Executable File
#!/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);
|
|
}
|