2025-05-14 12:37:17 -07:00
|
|
|
/**
|
|
|
|
|
* @license
|
|
|
|
|
* Copyright 2025 Google LLC
|
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
|
|
|
import * as os from 'os';
|
2025-07-11 16:52:56 -07:00
|
|
|
import { loadCliConfig, parseArguments } from './config.js';
|
2025-05-30 22:18:01 +00:00
|
|
|
import { Settings } from './settings.js';
|
2025-06-13 13:57:00 -07:00
|
|
|
import { Extension } from './extension.js';
|
2025-06-25 05:41:11 -07:00
|
|
|
import * as ServerConfig from '@google/gemini-cli-core';
|
2025-05-14 12:37:17 -07:00
|
|
|
|
|
|
|
|
vi.mock('os', async (importOriginal) => {
|
|
|
|
|
const actualOs = await importOriginal<typeof os>();
|
|
|
|
|
return {
|
|
|
|
|
...actualOs,
|
2025-06-22 09:26:48 -05:00
|
|
|
homedir: vi.fn(() => '/mock/home/user'),
|
2025-05-14 12:37:17 -07:00
|
|
|
};
|
|
|
|
|
});
|
|
|
|
|
|
2025-06-16 11:12:42 -07:00
|
|
|
vi.mock('open', () => ({
|
|
|
|
|
default: vi.fn(),
|
|
|
|
|
}));
|
|
|
|
|
|
2025-05-30 22:18:01 +00:00
|
|
|
vi.mock('read-package-up', () => ({
|
|
|
|
|
readPackageUp: vi.fn(() =>
|
|
|
|
|
Promise.resolve({ packageJson: { version: 'test-version' } }),
|
|
|
|
|
),
|
|
|
|
|
}));
|
|
|
|
|
|
2025-06-25 05:41:11 -07:00
|
|
|
vi.mock('@google/gemini-cli-core', async () => {
|
|
|
|
|
const actualServer = await vi.importActual<typeof ServerConfig>(
|
|
|
|
|
'@google/gemini-cli-core',
|
|
|
|
|
);
|
2025-05-30 22:18:01 +00:00
|
|
|
return {
|
|
|
|
|
...actualServer,
|
|
|
|
|
loadEnvironment: vi.fn(),
|
2025-06-13 20:25:59 -04:00
|
|
|
loadServerHierarchicalMemory: vi.fn(
|
2025-07-23 14:48:35 -07:00
|
|
|
(cwd, debug, fileService, extensionPaths, _maxDirs) =>
|
2025-06-13 20:25:59 -04:00
|
|
|
Promise.resolve({
|
|
|
|
|
memoryContent: extensionPaths?.join(',') || '',
|
|
|
|
|
fileCount: extensionPaths?.length || 0,
|
|
|
|
|
}),
|
2025-05-30 22:18:01 +00:00
|
|
|
),
|
2025-07-20 00:55:33 -07:00
|
|
|
DEFAULT_MEMORY_FILE_FILTERING_OPTIONS: {
|
|
|
|
|
respectGitIgnore: false,
|
|
|
|
|
respectGeminiIgnore: true,
|
|
|
|
|
},
|
|
|
|
|
DEFAULT_FILE_FILTERING_OPTIONS: {
|
|
|
|
|
respectGitIgnore: true,
|
|
|
|
|
respectGeminiIgnore: true,
|
|
|
|
|
},
|
2025-05-30 22:18:01 +00:00
|
|
|
};
|
|
|
|
|
});
|
|
|
|
|
|
2025-07-11 16:52:56 -07:00
|
|
|
describe('parseArguments', () => {
|
|
|
|
|
const originalArgv = process.argv;
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
process.argv = originalArgv;
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should throw an error when both --prompt and --prompt-interactive are used together', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
|
|
|
|
'--prompt',
|
|
|
|
|
'test prompt',
|
|
|
|
|
'--prompt-interactive',
|
|
|
|
|
'interactive prompt',
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
const mockExit = vi.spyOn(process, 'exit').mockImplementation(() => {
|
|
|
|
|
throw new Error('process.exit called');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const mockConsoleError = vi
|
|
|
|
|
.spyOn(console, 'error')
|
|
|
|
|
.mockImplementation(() => {});
|
|
|
|
|
|
|
|
|
|
await expect(parseArguments()).rejects.toThrow('process.exit called');
|
|
|
|
|
|
|
|
|
|
expect(mockConsoleError).toHaveBeenCalledWith(
|
|
|
|
|
expect.stringContaining(
|
|
|
|
|
'Cannot use both --prompt (-p) and --prompt-interactive (-i) together',
|
|
|
|
|
),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
mockExit.mockRestore();
|
|
|
|
|
mockConsoleError.mockRestore();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should throw an error when using short flags -p and -i together', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
|
|
|
|
'-p',
|
|
|
|
|
'test prompt',
|
|
|
|
|
'-i',
|
|
|
|
|
'interactive prompt',
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
const mockExit = vi.spyOn(process, 'exit').mockImplementation(() => {
|
|
|
|
|
throw new Error('process.exit called');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const mockConsoleError = vi
|
|
|
|
|
.spyOn(console, 'error')
|
|
|
|
|
.mockImplementation(() => {});
|
|
|
|
|
|
|
|
|
|
await expect(parseArguments()).rejects.toThrow('process.exit called');
|
|
|
|
|
|
|
|
|
|
expect(mockConsoleError).toHaveBeenCalledWith(
|
|
|
|
|
expect.stringContaining(
|
|
|
|
|
'Cannot use both --prompt (-p) and --prompt-interactive (-i) together',
|
|
|
|
|
),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
mockExit.mockRestore();
|
|
|
|
|
mockConsoleError.mockRestore();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should allow --prompt without --prompt-interactive', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--prompt', 'test prompt'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
expect(argv.prompt).toBe('test prompt');
|
|
|
|
|
expect(argv.promptInteractive).toBeUndefined();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should allow --prompt-interactive without --prompt', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
|
|
|
|
'--prompt-interactive',
|
|
|
|
|
'interactive prompt',
|
|
|
|
|
];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
expect(argv.promptInteractive).toBe('interactive prompt');
|
|
|
|
|
expect(argv.prompt).toBeUndefined();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should allow -i flag as alias for --prompt-interactive', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '-i', 'interactive prompt'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
expect(argv.promptInteractive).toBe('interactive prompt');
|
|
|
|
|
expect(argv.prompt).toBeUndefined();
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2025-05-30 22:18:01 +00:00
|
|
|
describe('loadCliConfig', () => {
|
|
|
|
|
const originalArgv = process.argv;
|
|
|
|
|
const originalEnv = { ...process.env };
|
|
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
vi.resetAllMocks();
|
2025-06-22 09:26:48 -05:00
|
|
|
vi.mocked(os.homedir).mockReturnValue('/mock/home/user');
|
2025-05-30 22:18:01 +00:00
|
|
|
process.env.GEMINI_API_KEY = 'test-api-key'; // Ensure API key is set for tests
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
process.argv = originalArgv;
|
|
|
|
|
process.env = originalEnv;
|
|
|
|
|
vi.restoreAllMocks();
|
|
|
|
|
});
|
|
|
|
|
|
2025-07-08 16:56:12 -04:00
|
|
|
it('should set showMemoryUsage to true when --show-memory-usage flag is present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--show-memory-usage'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-05-30 22:18:01 +00:00
|
|
|
const settings: Settings = {};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-07 11:12:30 -07:00
|
|
|
expect(config.getShowMemoryUsage()).toBe(true);
|
2025-05-30 22:18:01 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should set showMemoryUsage to false when --memory flag is not present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-05-30 22:18:01 +00:00
|
|
|
const settings: Settings = {};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-07 11:12:30 -07:00
|
|
|
expect(config.getShowMemoryUsage()).toBe(false);
|
2025-05-30 22:18:01 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should set showMemoryUsage to false by default from settings if CLI flag is not present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-05-30 22:18:01 +00:00
|
|
|
const settings: Settings = { showMemoryUsage: false };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-07 11:12:30 -07:00
|
|
|
expect(config.getShowMemoryUsage()).toBe(false);
|
2025-05-30 22:18:01 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize CLI flag over settings for showMemoryUsage (CLI true, settings false)', async () => {
|
2025-07-08 16:56:12 -04:00
|
|
|
process.argv = ['node', 'script.js', '--show-memory-usage'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-05-30 22:18:01 +00:00
|
|
|
const settings: Settings = { showMemoryUsage: false };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-07 11:12:30 -07:00
|
|
|
expect(config.getShowMemoryUsage()).toBe(true);
|
2025-05-30 22:18:01 +00:00
|
|
|
});
|
2025-07-18 02:57:37 +08:00
|
|
|
|
|
|
|
|
it(`should leave proxy to empty by default`, async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getProxy()).toBeFalsy();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const proxy_url = 'http://localhost:7890';
|
|
|
|
|
const testCases = [
|
|
|
|
|
{
|
|
|
|
|
input: {
|
|
|
|
|
env_name: 'https_proxy',
|
|
|
|
|
proxy_url,
|
|
|
|
|
},
|
|
|
|
|
expected: proxy_url,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
input: {
|
|
|
|
|
env_name: 'http_proxy',
|
|
|
|
|
proxy_url,
|
|
|
|
|
},
|
|
|
|
|
expected: proxy_url,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
input: {
|
|
|
|
|
env_name: 'HTTPS_PROXY',
|
|
|
|
|
proxy_url,
|
|
|
|
|
},
|
|
|
|
|
expected: proxy_url,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
input: {
|
|
|
|
|
env_name: 'HTTP_PROXY',
|
|
|
|
|
proxy_url,
|
|
|
|
|
},
|
|
|
|
|
expected: proxy_url,
|
|
|
|
|
},
|
|
|
|
|
];
|
|
|
|
|
testCases.forEach(({ input, expected }) => {
|
|
|
|
|
it(`should set proxy to ${expected} according to environment variable [${input.env_name}]`, async () => {
|
|
|
|
|
process.env[input.env_name] = input.proxy_url;
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getProxy()).toBe(expected);
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should set proxy when --proxy flag is present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--proxy', 'http://localhost:7890'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getProxy()).toBe('http://localhost:7890');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize CLI flag over environment variable for proxy (CLI http://localhost:7890, environment variable http://localhost:7891)', async () => {
|
|
|
|
|
process.env['http_proxy'] = 'http://localhost:7891';
|
|
|
|
|
process.argv = ['node', 'script.js', '--proxy', 'http://localhost:7890'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getProxy()).toBe('http://localhost:7890');
|
|
|
|
|
});
|
2025-05-30 22:18:01 +00:00
|
|
|
});
|
2025-05-14 12:37:17 -07:00
|
|
|
|
2025-06-05 16:04:25 -04:00
|
|
|
describe('loadCliConfig telemetry', () => {
|
|
|
|
|
const originalArgv = process.argv;
|
|
|
|
|
const originalEnv = { ...process.env };
|
|
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
vi.resetAllMocks();
|
2025-06-22 09:26:48 -05:00
|
|
|
vi.mocked(os.homedir).mockReturnValue('/mock/home/user');
|
2025-06-05 16:04:25 -04:00
|
|
|
process.env.GEMINI_API_KEY = 'test-api-key';
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
process.argv = originalArgv;
|
|
|
|
|
process.env = originalEnv;
|
|
|
|
|
vi.restoreAllMocks();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should set telemetry to false by default when no flag or setting is present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-06-05 16:04:25 -04:00
|
|
|
const settings: Settings = {};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(false);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should set telemetry to true when --telemetry flag is present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--telemetry'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-06-05 16:04:25 -04:00
|
|
|
const settings: Settings = {};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(true);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should set telemetry to false when --no-telemetry flag is present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--no-telemetry'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-06-05 16:04:25 -04:00
|
|
|
const settings: Settings = {};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(false);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use telemetry value from settings if CLI flag is not present (settings true)', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: true } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(true);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use telemetry value from settings if CLI flag is not present (settings false)', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: false } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(false);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --telemetry CLI flag (true) over settings (false)', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--telemetry'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: false } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(true);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --no-telemetry CLI flag (false) over settings (true)', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--no-telemetry'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: true } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
2025-06-13 13:07:46 -07:00
|
|
|
expect(config.getTelemetryEnabled()).toBe(false);
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
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
|
|
|
|
|
|
|
|
it('should use telemetry OTLP endpoint from settings if CLI flag is not present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = {
|
|
|
|
|
telemetry: { otlpEndpoint: 'http://settings.example.com' },
|
|
|
|
|
};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryOtlpEndpoint()).toBe(
|
|
|
|
|
'http://settings.example.com',
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --telemetry-otlp-endpoint CLI flag over settings', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
|
|
|
|
'--telemetry-otlp-endpoint',
|
|
|
|
|
'http://cli.example.com',
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = {
|
|
|
|
|
telemetry: { otlpEndpoint: 'http://settings.example.com' },
|
|
|
|
|
};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryOtlpEndpoint()).toBe('http://cli.example.com');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use default endpoint if no OTLP endpoint is provided via CLI or settings', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: true } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryOtlpEndpoint()).toBe('http://localhost:4317');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use telemetry target from settings if CLI flag is not present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = {
|
|
|
|
|
telemetry: { target: ServerConfig.DEFAULT_TELEMETRY_TARGET },
|
|
|
|
|
};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryTarget()).toBe(
|
|
|
|
|
ServerConfig.DEFAULT_TELEMETRY_TARGET,
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --telemetry-target CLI flag over settings', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--telemetry-target', 'gcp'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = {
|
|
|
|
|
telemetry: { target: ServerConfig.DEFAULT_TELEMETRY_TARGET },
|
|
|
|
|
};
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryTarget()).toBe('gcp');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use default target if no target is provided via CLI or settings', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: true } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryTarget()).toBe(
|
|
|
|
|
ServerConfig.DEFAULT_TELEMETRY_TARGET,
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use telemetry log prompts from settings if CLI flag is not present', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { logPrompts: false } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryLogPromptsEnabled()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --telemetry-log-prompts CLI flag (true) over settings (false)', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--telemetry-log-prompts'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { logPrompts: false } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryLogPromptsEnabled()).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --no-telemetry-log-prompts CLI flag (false) over settings (true)', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--no-telemetry-log-prompts'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { logPrompts: true } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryLogPromptsEnabled()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should use default log prompts (true) if no value is provided via CLI or settings', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
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
|
|
|
const settings: Settings = { telemetry: { enabled: true } };
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
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
|
|
|
expect(config.getTelemetryLogPromptsEnabled()).toBe(true);
|
|
|
|
|
});
|
2025-06-05 16:04:25 -04:00
|
|
|
});
|
|
|
|
|
|
2025-05-14 12:37:17 -07:00
|
|
|
describe('Hierarchical Memory Loading (config.ts) - Placeholder Suite', () => {
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
vi.resetAllMocks();
|
2025-06-22 09:26:48 -05:00
|
|
|
vi.mocked(os.homedir).mockReturnValue('/mock/home/user');
|
2025-05-14 12:37:17 -07:00
|
|
|
// Other common mocks would be reset here.
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
vi.restoreAllMocks();
|
|
|
|
|
});
|
|
|
|
|
|
2025-06-11 13:34:35 -07:00
|
|
|
it('should pass extension context file paths to loadServerHierarchicalMemory', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const settings: Settings = {};
|
2025-06-13 13:57:00 -07:00
|
|
|
const extensions: Extension[] = [
|
2025-06-11 13:34:35 -07:00
|
|
|
{
|
2025-06-13 13:57:00 -07:00
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
},
|
|
|
|
|
contextFiles: ['/path/to/ext1/GEMINI.md'],
|
2025-06-11 13:34:35 -07:00
|
|
|
},
|
|
|
|
|
{
|
2025-06-13 13:57:00 -07:00
|
|
|
config: {
|
|
|
|
|
name: 'ext2',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
2025-06-11 13:34:35 -07:00
|
|
|
},
|
|
|
|
|
{
|
2025-06-13 13:57:00 -07:00
|
|
|
config: {
|
|
|
|
|
name: 'ext3',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [
|
|
|
|
|
'/path/to/ext3/context1.md',
|
|
|
|
|
'/path/to/ext3/context2.md',
|
|
|
|
|
],
|
2025-06-11 13:34:35 -07:00
|
|
|
},
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
|
|
|
|
await loadCliConfig(settings, extensions, 'session-id', argv);
|
2025-06-11 13:34:35 -07:00
|
|
|
expect(ServerConfig.loadServerHierarchicalMemory).toHaveBeenCalledWith(
|
|
|
|
|
expect.any(String),
|
|
|
|
|
false,
|
2025-06-13 20:25:59 -04:00
|
|
|
expect.any(Object),
|
2025-06-13 13:57:00 -07:00
|
|
|
[
|
|
|
|
|
'/path/to/ext1/GEMINI.md',
|
|
|
|
|
'/path/to/ext3/context1.md',
|
|
|
|
|
'/path/to/ext3/context2.md',
|
|
|
|
|
],
|
2025-07-20 00:55:33 -07:00
|
|
|
{
|
|
|
|
|
respectGitIgnore: false,
|
|
|
|
|
respectGeminiIgnore: true,
|
|
|
|
|
},
|
2025-07-23 14:48:35 -07:00
|
|
|
undefined, // maxDirs
|
2025-06-11 13:34:35 -07:00
|
|
|
);
|
2025-05-14 12:37:17 -07:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// NOTE TO FUTURE DEVELOPERS:
|
|
|
|
|
// To re-enable tests for loadHierarchicalGeminiMemory, ensure that:
|
|
|
|
|
// 1. os.homedir() is reliably mocked *before* the config.ts module is loaded
|
|
|
|
|
// and its functions (which use os.homedir()) are called.
|
|
|
|
|
// 2. fs/promises and fs mocks correctly simulate file/directory existence,
|
|
|
|
|
// readability, and content based on paths derived from the mocked os.homedir().
|
|
|
|
|
// 3. Spies on console functions (for logger output) are correctly set up if needed.
|
|
|
|
|
// Example of a previously failing test structure:
|
|
|
|
|
/*
|
|
|
|
|
it('should correctly use mocked homedir for global path', async () => {
|
2025-06-22 09:26:48 -05:00
|
|
|
const MOCK_GEMINI_DIR_LOCAL = path.join('/mock/home/user', '.gemini');
|
2025-05-14 12:37:17 -07:00
|
|
|
const MOCK_GLOBAL_PATH_LOCAL = path.join(MOCK_GEMINI_DIR_LOCAL, 'GEMINI.md');
|
|
|
|
|
mockFs({
|
|
|
|
|
[MOCK_GLOBAL_PATH_LOCAL]: { type: 'file', content: 'GlobalContentOnly' }
|
|
|
|
|
});
|
|
|
|
|
const memory = await loadHierarchicalGeminiMemory("/some/other/cwd", false);
|
|
|
|
|
expect(memory).toBe('GlobalContentOnly');
|
|
|
|
|
expect(vi.mocked(os.homedir)).toHaveBeenCalled();
|
|
|
|
|
expect(fsPromises.readFile).toHaveBeenCalledWith(MOCK_GLOBAL_PATH_LOCAL, 'utf-8');
|
|
|
|
|
});
|
|
|
|
|
*/
|
|
|
|
|
});
|
2025-06-13 14:51:29 -07:00
|
|
|
|
|
|
|
|
describe('mergeMcpServers', () => {
|
|
|
|
|
it('should not modify the original settings object', async () => {
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
mcpServers: {
|
|
|
|
|
'test-server': {
|
|
|
|
|
url: 'http://localhost:8080',
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
const extensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
mcpServers: {
|
|
|
|
|
'ext1-server': {
|
|
|
|
|
url: 'http://localhost:8081',
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
];
|
|
|
|
|
const originalSettings = JSON.parse(JSON.stringify(settings));
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
await loadCliConfig(settings, extensions, 'test-session', argv);
|
2025-06-13 14:51:29 -07:00
|
|
|
expect(settings).toEqual(originalSettings);
|
|
|
|
|
});
|
|
|
|
|
});
|
2025-07-01 16:13:46 -07:00
|
|
|
|
|
|
|
|
describe('mergeExcludeTools', () => {
|
|
|
|
|
it('should merge excludeTools from settings and extensions', async () => {
|
|
|
|
|
const settings: Settings = { excludeTools: ['tool1', 'tool2'] };
|
|
|
|
|
const extensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool3', 'tool4'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext2',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool5'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
extensions,
|
|
|
|
|
'test-session',
|
|
|
|
|
argv,
|
|
|
|
|
);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(config.getExcludeTools()).toEqual(
|
|
|
|
|
expect.arrayContaining(['tool1', 'tool2', 'tool3', 'tool4', 'tool5']),
|
|
|
|
|
);
|
|
|
|
|
expect(config.getExcludeTools()).toHaveLength(5);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should handle overlapping excludeTools between settings and extensions', async () => {
|
|
|
|
|
const settings: Settings = { excludeTools: ['tool1', 'tool2'] };
|
|
|
|
|
const extensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool2', 'tool3'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
extensions,
|
|
|
|
|
'test-session',
|
|
|
|
|
argv,
|
|
|
|
|
);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(config.getExcludeTools()).toEqual(
|
|
|
|
|
expect.arrayContaining(['tool1', 'tool2', 'tool3']),
|
|
|
|
|
);
|
|
|
|
|
expect(config.getExcludeTools()).toHaveLength(3);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should handle overlapping excludeTools between extensions', async () => {
|
|
|
|
|
const settings: Settings = { excludeTools: ['tool1'] };
|
|
|
|
|
const extensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool2', 'tool3'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext2',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool3', 'tool4'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
extensions,
|
|
|
|
|
'test-session',
|
|
|
|
|
argv,
|
|
|
|
|
);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(config.getExcludeTools()).toEqual(
|
|
|
|
|
expect.arrayContaining(['tool1', 'tool2', 'tool3', 'tool4']),
|
|
|
|
|
);
|
|
|
|
|
expect(config.getExcludeTools()).toHaveLength(4);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should return an empty array when no excludeTools are specified', async () => {
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const extensions: Extension[] = [];
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
extensions,
|
|
|
|
|
'test-session',
|
|
|
|
|
argv,
|
|
|
|
|
);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(config.getExcludeTools()).toEqual([]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should handle settings with excludeTools but no extensions', async () => {
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
2025-07-01 16:13:46 -07:00
|
|
|
const settings: Settings = { excludeTools: ['tool1', 'tool2'] };
|
|
|
|
|
const extensions: Extension[] = [];
|
2025-07-11 16:52:56 -07:00
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
extensions,
|
|
|
|
|
'test-session',
|
|
|
|
|
argv,
|
|
|
|
|
);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(config.getExcludeTools()).toEqual(
|
|
|
|
|
expect.arrayContaining(['tool1', 'tool2']),
|
|
|
|
|
);
|
|
|
|
|
expect(config.getExcludeTools()).toHaveLength(2);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should handle extensions with excludeTools but no settings', async () => {
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const extensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool1', 'tool2'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
extensions,
|
|
|
|
|
'test-session',
|
|
|
|
|
argv,
|
|
|
|
|
);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(config.getExcludeTools()).toEqual(
|
|
|
|
|
expect.arrayContaining(['tool1', 'tool2']),
|
|
|
|
|
);
|
|
|
|
|
expect(config.getExcludeTools()).toHaveLength(2);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should not modify the original settings object', async () => {
|
|
|
|
|
const settings: Settings = { excludeTools: ['tool1'] };
|
|
|
|
|
const extensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: {
|
|
|
|
|
name: 'ext1',
|
|
|
|
|
version: '1.0.0',
|
|
|
|
|
excludeTools: ['tool2'],
|
|
|
|
|
},
|
|
|
|
|
contextFiles: [],
|
|
|
|
|
},
|
|
|
|
|
];
|
|
|
|
|
const originalSettings = JSON.parse(JSON.stringify(settings));
|
2025-07-11 16:52:56 -07:00
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
await loadCliConfig(settings, extensions, 'test-session', argv);
|
2025-07-01 16:13:46 -07:00
|
|
|
expect(settings).toEqual(originalSettings);
|
|
|
|
|
});
|
|
|
|
|
});
|
2025-07-07 09:45:58 -07:00
|
|
|
|
2025-07-07 12:47:27 -07:00
|
|
|
describe('loadCliConfig with allowed-mcp-server-names', () => {
|
2025-07-07 09:45:58 -07:00
|
|
|
const originalArgv = process.argv;
|
|
|
|
|
const originalEnv = { ...process.env };
|
|
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
vi.resetAllMocks();
|
|
|
|
|
vi.mocked(os.homedir).mockReturnValue('/mock/home/user');
|
|
|
|
|
process.env.GEMINI_API_KEY = 'test-api-key';
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
process.argv = originalArgv;
|
|
|
|
|
process.env = originalEnv;
|
|
|
|
|
vi.restoreAllMocks();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const baseSettings: Settings = {
|
|
|
|
|
mcpServers: {
|
|
|
|
|
server1: { url: 'http://localhost:8080' },
|
|
|
|
|
server2: { url: 'http://localhost:8081' },
|
|
|
|
|
server3: { url: 'http://localhost:8082' },
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
it('should allow all MCP servers if the flag is not provided', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(baseSettings, [], 'test-session', argv);
|
2025-07-07 09:45:58 -07:00
|
|
|
expect(config.getMcpServers()).toEqual(baseSettings.mcpServers);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should allow only the specified MCP server', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
2025-07-07 12:47:27 -07:00
|
|
|
'--allowed-mcp-server-names',
|
2025-07-07 09:45:58 -07:00
|
|
|
'server1',
|
|
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(baseSettings, [], 'test-session', argv);
|
2025-07-07 09:45:58 -07:00
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server1: { url: 'http://localhost:8080' },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should allow multiple specified MCP servers', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
2025-07-07 12:47:27 -07:00
|
|
|
'--allowed-mcp-server-names',
|
2025-07-09 11:38:38 -07:00
|
|
|
'server1',
|
|
|
|
|
'--allowed-mcp-server-names',
|
|
|
|
|
'server3',
|
2025-07-07 09:45:58 -07:00
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(baseSettings, [], 'test-session', argv);
|
2025-07-07 09:45:58 -07:00
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server1: { url: 'http://localhost:8080' },
|
|
|
|
|
server3: { url: 'http://localhost:8082' },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should handle server names that do not exist', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
2025-07-07 12:47:27 -07:00
|
|
|
'--allowed-mcp-server-names',
|
2025-07-09 11:38:38 -07:00
|
|
|
'server1',
|
|
|
|
|
'--allowed-mcp-server-names',
|
|
|
|
|
'server4',
|
2025-07-07 09:45:58 -07:00
|
|
|
];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(baseSettings, [], 'test-session', argv);
|
2025-07-07 09:45:58 -07:00
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server1: { url: 'http://localhost:8080' },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2025-07-09 11:38:38 -07:00
|
|
|
it('should allow no MCP servers if the flag is provided but empty', async () => {
|
2025-07-07 12:47:27 -07:00
|
|
|
process.argv = ['node', 'script.js', '--allowed-mcp-server-names', ''];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(baseSettings, [], 'test-session', argv);
|
2025-07-09 11:38:38 -07:00
|
|
|
expect(config.getMcpServers()).toEqual({});
|
2025-07-07 09:45:58 -07:00
|
|
|
});
|
2025-07-15 20:45:24 +00:00
|
|
|
|
|
|
|
|
it('should read allowMCPServers from settings', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
...baseSettings,
|
|
|
|
|
allowMCPServers: ['server1', 'server2'],
|
|
|
|
|
};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server1: { url: 'http://localhost:8080' },
|
|
|
|
|
server2: { url: 'http://localhost:8081' },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should read excludeMCPServers from settings', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
...baseSettings,
|
|
|
|
|
excludeMCPServers: ['server1', 'server2'],
|
|
|
|
|
};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server3: { url: 'http://localhost:8082' },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should override allowMCPServers with excludeMCPServers if overlapping ', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
...baseSettings,
|
|
|
|
|
excludeMCPServers: ['server1'],
|
|
|
|
|
allowMCPServers: ['server1', 'server2'],
|
|
|
|
|
};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server2: { url: 'http://localhost:8081' },
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize mcp server flag if set ', async () => {
|
|
|
|
|
process.argv = [
|
|
|
|
|
'node',
|
|
|
|
|
'script.js',
|
|
|
|
|
'--allowed-mcp-server-names',
|
|
|
|
|
'server1',
|
|
|
|
|
];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
...baseSettings,
|
|
|
|
|
excludeMCPServers: ['server1'],
|
|
|
|
|
allowMCPServers: ['server2'],
|
|
|
|
|
};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getMcpServers()).toEqual({
|
|
|
|
|
server1: { url: 'http://localhost:8080' },
|
|
|
|
|
});
|
|
|
|
|
});
|
2025-07-07 09:45:58 -07:00
|
|
|
});
|
2025-07-08 12:57:34 -04:00
|
|
|
|
|
|
|
|
describe('loadCliConfig extensions', () => {
|
|
|
|
|
const mockExtensions: Extension[] = [
|
|
|
|
|
{
|
|
|
|
|
config: { name: 'ext1', version: '1.0.0' },
|
|
|
|
|
contextFiles: ['/path/to/ext1.md'],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
config: { name: 'ext2', version: '1.0.0' },
|
|
|
|
|
contextFiles: ['/path/to/ext2.md'],
|
|
|
|
|
},
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
it('should not filter extensions if --extensions flag is not used', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-07-08 12:57:34 -04:00
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
mockExtensions,
|
|
|
|
|
'test-session',
|
2025-07-11 16:52:56 -07:00
|
|
|
argv,
|
2025-07-08 12:57:34 -04:00
|
|
|
);
|
|
|
|
|
expect(config.getExtensionContextFilePaths()).toEqual([
|
|
|
|
|
'/path/to/ext1.md',
|
|
|
|
|
'/path/to/ext2.md',
|
|
|
|
|
]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should filter extensions if --extensions flag is used', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--extensions', 'ext1'];
|
2025-07-11 16:52:56 -07:00
|
|
|
const argv = await parseArguments();
|
2025-07-08 12:57:34 -04:00
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(
|
|
|
|
|
settings,
|
|
|
|
|
mockExtensions,
|
|
|
|
|
'test-session',
|
2025-07-11 16:52:56 -07:00
|
|
|
argv,
|
2025-07-08 12:57:34 -04:00
|
|
|
);
|
|
|
|
|
expect(config.getExtensionContextFilePaths()).toEqual(['/path/to/ext1.md']);
|
|
|
|
|
});
|
|
|
|
|
});
|
2025-07-14 12:04:08 -04:00
|
|
|
|
|
|
|
|
describe('loadCliConfig ideMode', () => {
|
|
|
|
|
const originalArgv = process.argv;
|
|
|
|
|
const originalEnv = { ...process.env };
|
|
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
|
vi.resetAllMocks();
|
|
|
|
|
vi.mocked(os.homedir).mockReturnValue('/mock/home/user');
|
|
|
|
|
process.env.GEMINI_API_KEY = 'test-api-key';
|
|
|
|
|
// Explicitly delete TERM_PROGRAM and SANDBOX before each test
|
|
|
|
|
delete process.env.TERM_PROGRAM;
|
|
|
|
|
delete process.env.SANDBOX;
|
2025-07-15 22:13:03 +00:00
|
|
|
delete process.env.GEMINI_CLI_IDE_SERVER_PORT;
|
2025-07-14 12:04:08 -04:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
process.argv = originalArgv;
|
|
|
|
|
process.env = originalEnv;
|
|
|
|
|
vi.restoreAllMocks();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be false by default', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be false if --ide-mode is true but TERM_PROGRAM is not vscode', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be false if settings.ideMode is true but TERM_PROGRAM is not vscode', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = { ideMode: true };
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be true when --ide-mode is set and TERM_PROGRAM is vscode', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
2025-07-15 22:13:03 +00:00
|
|
|
process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
|
2025-07-14 12:04:08 -04:00
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be true when settings.ideMode is true and TERM_PROGRAM is vscode', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
2025-07-15 22:13:03 +00:00
|
|
|
process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
|
2025-07-14 12:04:08 -04:00
|
|
|
const settings: Settings = { ideMode: true };
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --ide-mode (true) over settings (false) when TERM_PROGRAM is vscode', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
2025-07-15 22:13:03 +00:00
|
|
|
process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
|
2025-07-14 12:04:08 -04:00
|
|
|
const settings: Settings = { ideMode: false };
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should prioritize --no-ide-mode (false) over settings (true) even when TERM_PROGRAM is vscode', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--no-ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
|
|
|
|
const settings: Settings = { ideMode: true };
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be false when --ide-mode is true, TERM_PROGRAM is vscode, but SANDBOX is set', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
|
|
|
|
process.env.SANDBOX = 'true';
|
|
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should be false when settings.ideMode is true, TERM_PROGRAM is vscode, but SANDBOX is set', async () => {
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
|
|
|
|
process.env.SANDBOX = 'true';
|
|
|
|
|
const settings: Settings = { ideMode: true };
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
2025-07-15 10:19:59 -04:00
|
|
|
it('should add _ide_server when ideMode is true', async () => {
|
2025-07-14 12:04:08 -04:00
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
2025-07-15 22:13:03 +00:00
|
|
|
process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
|
2025-07-14 12:04:08 -04:00
|
|
|
const settings: Settings = {};
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(config.getIdeMode()).toBe(true);
|
|
|
|
|
const mcpServers = config.getMcpServers();
|
|
|
|
|
expect(mcpServers['_ide_server']).toBeDefined();
|
|
|
|
|
expect(mcpServers['_ide_server'].httpUrl).toBe('http://localhost:3000/mcp');
|
|
|
|
|
expect(mcpServers['_ide_server'].description).toBe('IDE connection');
|
|
|
|
|
expect(mcpServers['_ide_server'].trust).toBe(false);
|
|
|
|
|
});
|
2025-07-15 22:13:03 +00:00
|
|
|
|
2025-07-17 12:59:57 -04:00
|
|
|
it('should warn if ideMode is true and no port is set', async () => {
|
|
|
|
|
const consoleWarnSpy = vi
|
|
|
|
|
.spyOn(console, 'warn')
|
|
|
|
|
.mockImplementation(() => {});
|
2025-07-15 22:13:03 +00:00
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
|
|
|
|
const settings: Settings = {};
|
2025-07-17 12:59:57 -04:00
|
|
|
await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
expect(consoleWarnSpy).toHaveBeenCalledWith(
|
|
|
|
|
'[WARN]',
|
2025-07-16 17:33:56 -04:00
|
|
|
'Could not connect to IDE. Make sure you have the companion VS Code extension installed from the marketplace or via /ide install.',
|
2025-07-15 22:13:03 +00:00
|
|
|
);
|
2025-07-17 12:59:57 -04:00
|
|
|
consoleWarnSpy.mockRestore();
|
2025-07-15 22:13:03 +00:00
|
|
|
});
|
2025-07-16 17:33:56 -04:00
|
|
|
|
|
|
|
|
it('should warn and overwrite if settings contain the reserved _ide_server name and ideMode is active', async () => {
|
|
|
|
|
const consoleWarnSpy = vi
|
|
|
|
|
.spyOn(console, 'warn')
|
|
|
|
|
.mockImplementation(() => {});
|
|
|
|
|
|
|
|
|
|
process.argv = ['node', 'script.js', '--ide-mode'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
process.env.TERM_PROGRAM = 'vscode';
|
|
|
|
|
process.env.GEMINI_CLI_IDE_SERVER_PORT = '3000';
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
mcpServers: {
|
|
|
|
|
_ide_server: new ServerConfig.MCPServerConfig(
|
|
|
|
|
undefined,
|
|
|
|
|
undefined,
|
|
|
|
|
undefined,
|
|
|
|
|
undefined,
|
|
|
|
|
'http://malicious:1234',
|
|
|
|
|
),
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
|
|
|
|
|
expect(consoleWarnSpy).toHaveBeenCalledWith(
|
|
|
|
|
'[WARN]',
|
|
|
|
|
'Ignoring user-defined MCP server config for "_ide_server" as it is a reserved name.',
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
const mcpServers = config.getMcpServers();
|
|
|
|
|
expect(mcpServers['_ide_server']).toBeDefined();
|
|
|
|
|
expect(mcpServers['_ide_server'].httpUrl).toBe('http://localhost:3000/mcp');
|
|
|
|
|
|
|
|
|
|
consoleWarnSpy.mockRestore();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('should NOT warn if settings contain the reserved _ide_server name and ideMode is NOT active', async () => {
|
|
|
|
|
const consoleWarnSpy = vi
|
|
|
|
|
.spyOn(console, 'warn')
|
|
|
|
|
.mockImplementation(() => {});
|
|
|
|
|
|
|
|
|
|
process.argv = ['node', 'script.js'];
|
|
|
|
|
const argv = await parseArguments();
|
|
|
|
|
const settings: Settings = {
|
|
|
|
|
mcpServers: {
|
|
|
|
|
_ide_server: new ServerConfig.MCPServerConfig(
|
|
|
|
|
undefined,
|
|
|
|
|
undefined,
|
|
|
|
|
undefined,
|
|
|
|
|
undefined,
|
|
|
|
|
'http://malicious:1234',
|
|
|
|
|
),
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const config = await loadCliConfig(settings, [], 'test-session', argv);
|
|
|
|
|
|
|
|
|
|
expect(consoleWarnSpy).not.toHaveBeenCalled();
|
|
|
|
|
|
|
|
|
|
const mcpServers = config.getMcpServers();
|
|
|
|
|
expect(mcpServers['_ide_server']).toBeDefined();
|
|
|
|
|
expect(mcpServers['_ide_server'].url).toBe('http://malicious:1234');
|
|
|
|
|
|
|
|
|
|
consoleWarnSpy.mockRestore();
|
|
|
|
|
});
|
2025-07-14 12:04:08 -04:00
|
|
|
});
|