diff options
| author | Jerop Kipruto <[email protected]> | 2025-06-15 00:47:32 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-06-15 00:47:32 -0400 |
| commit | 53753f0455458dda4055f42ca9caf3aa898bc3c4 (patch) | |
| tree | 49b4130263c3fc9d60708ff6762d1afba5023286 /scripts/telemetry.js | |
| parent | 32dd298351057aa56829663332e13954b1d2f953 (diff) | |
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
> [email protected] 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.
```
Diffstat (limited to 'scripts/telemetry.js')
| -rwxr-xr-x | scripts/telemetry.js | 85 |
1 files changed, 85 insertions, 0 deletions
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); +} |
