summaryrefslogtreecommitdiff
path: root/packages/cli/src
diff options
context:
space:
mode:
Diffstat (limited to 'packages/cli/src')
-rw-r--r--packages/cli/src/config/config.test.ts97
-rw-r--r--packages/cli/src/config/config.ts39
-rw-r--r--packages/cli/src/config/settings.ts4
3 files changed, 127 insertions, 13 deletions
diff --git a/packages/cli/src/config/config.test.ts b/packages/cli/src/config/config.test.ts
index 1d8c486a..6afe7f6e 100644
--- a/packages/cli/src/config/config.test.ts
+++ b/packages/cli/src/config/config.test.ts
@@ -127,31 +127,120 @@ describe('loadCliConfig telemetry', () => {
it('should use telemetry value from settings if CLI flag is not present (settings true)', async () => {
process.argv = ['node', 'script.js'];
- const settings: Settings = { telemetry: true };
+ const settings: Settings = { telemetry: { enabled: true } };
const config = await loadCliConfig(settings, [], [], 'test-session');
expect(config.getTelemetryEnabled()).toBe(true);
});
it('should use telemetry value from settings if CLI flag is not present (settings false)', async () => {
process.argv = ['node', 'script.js'];
- const settings: Settings = { telemetry: false };
+ const settings: Settings = { telemetry: { enabled: false } };
const config = await loadCliConfig(settings, [], [], 'test-session');
expect(config.getTelemetryEnabled()).toBe(false);
});
it('should prioritize --telemetry CLI flag (true) over settings (false)', async () => {
process.argv = ['node', 'script.js', '--telemetry'];
- const settings: Settings = { telemetry: false };
+ const settings: Settings = { telemetry: { enabled: false } };
const config = await loadCliConfig(settings, [], [], 'test-session');
expect(config.getTelemetryEnabled()).toBe(true);
});
it('should prioritize --no-telemetry CLI flag (false) over settings (true)', async () => {
process.argv = ['node', 'script.js', '--no-telemetry'];
- const settings: Settings = { telemetry: true };
+ const settings: Settings = { telemetry: { enabled: true } };
const config = await loadCliConfig(settings, [], [], 'test-session');
expect(config.getTelemetryEnabled()).toBe(false);
});
+
+ it('should use telemetry OTLP endpoint from settings if CLI flag is not present', async () => {
+ process.argv = ['node', 'script.js'];
+ const settings: Settings = {
+ telemetry: { otlpEndpoint: 'http://settings.example.com' },
+ };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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',
+ ];
+ const settings: Settings = {
+ telemetry: { otlpEndpoint: 'http://settings.example.com' },
+ };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = { telemetry: { enabled: true } };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = {
+ telemetry: { target: ServerConfig.DEFAULT_TELEMETRY_TARGET },
+ };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = {
+ telemetry: { target: ServerConfig.DEFAULT_TELEMETRY_TARGET },
+ };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = { telemetry: { enabled: true } };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = { telemetry: { logPrompts: false } };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = { telemetry: { logPrompts: false } };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = { telemetry: { logPrompts: true } };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ 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'];
+ const settings: Settings = { telemetry: { enabled: true } };
+ const config = await loadCliConfig(settings, [], [], 'test-session');
+ expect(config.getTelemetryLogPromptsEnabled()).toBe(true);
+ });
});
describe('API Key Handling', () => {
diff --git a/packages/cli/src/config/config.ts b/packages/cli/src/config/config.ts
index ca7cfa48..b737daa4 100644
--- a/packages/cli/src/config/config.ts
+++ b/packages/cli/src/config/config.ts
@@ -18,6 +18,7 @@ import {
DEFAULT_GEMINI_MODEL,
DEFAULT_GEMINI_EMBEDDING_MODEL,
FileDiscoveryService,
+ TelemetryTarget,
} from '@gemini-cli/core';
import { Settings } from './settings.js';
import { getEffectiveModel } from '../utils/modelCheck.js';
@@ -47,6 +48,9 @@ interface CliArgs {
yolo: boolean | undefined;
telemetry: boolean | undefined;
checkpoint: boolean | undefined;
+ telemetryTarget: string | undefined;
+ telemetryOtlpEndpoint: string | undefined;
+ telemetryLogPrompts: boolean | undefined;
}
async function parseArguments(): Promise<CliArgs> {
@@ -93,7 +97,24 @@ async function parseArguments(): Promise<CliArgs> {
})
.option('telemetry', {
type: 'boolean',
- description: 'Enable telemetry?',
+ description:
+ 'Enable telemetry? This flag specifically controls if telemetry is sent. Other --telemetry-* flags set specific values but do not enable telemetry on their own.',
+ })
+ .option('telemetry-target', {
+ type: 'string',
+ choices: ['local', 'gcp'],
+ description:
+ 'Set the telemetry target (local or gcp). Overrides settings files.',
+ })
+ .option('telemetry-otlp-endpoint', {
+ type: 'string',
+ description:
+ 'Set the OTLP endpoint for telemetry. Overrides environment variables and settings files.',
+ })
+ .option('telemetry-log-prompts', {
+ type: 'boolean',
+ description:
+ 'Enable or disable logging of user prompts for telemetry. Overrides settings files.',
})
.option('checkpoint', {
alias: 'c',
@@ -190,10 +211,16 @@ export async function loadCliConfig(
showMemoryUsage:
argv.show_memory_usage || settings.showMemoryUsage || false,
accessibility: settings.accessibility,
- telemetry:
- argv.telemetry !== undefined
- ? argv.telemetry
- : (settings.telemetry ?? false),
+ telemetry: {
+ enabled: argv.telemetry ?? settings.telemetry?.enabled,
+ target: (argv.telemetryTarget ??
+ settings.telemetry?.target) as TelemetryTarget,
+ otlpEndpoint:
+ argv.telemetryOtlpEndpoint ??
+ process.env.OTEL_EXPORTER_OTLP_ENDPOINT ??
+ settings.telemetry?.otlpEndpoint,
+ logPrompts: argv.telemetryLogPrompts ?? settings.telemetry?.logPrompts,
+ },
// Git-aware file filtering settings
fileFilteringRespectGitIgnore: settings.fileFiltering?.respectGitIgnore,
checkpoint: argv.checkpoint,
@@ -203,8 +230,6 @@ export async function loadCliConfig(
process.env.HTTP_PROXY ||
process.env.http_proxy,
cwd: process.cwd(),
- telemetryOtlpEndpoint:
- process.env.OTEL_EXPORTER_OTLP_ENDPOINT ?? settings.telemetryOtlpEndpoint,
fileDiscoveryService: fileService,
bugCommand: settings.bugCommand,
});
diff --git a/packages/cli/src/config/settings.ts b/packages/cli/src/config/settings.ts
index a0030a05..b17b4c9d 100644
--- a/packages/cli/src/config/settings.ts
+++ b/packages/cli/src/config/settings.ts
@@ -11,6 +11,7 @@ import {
MCPServerConfig,
getErrorMessage,
BugCommandSettings,
+ TelemetrySettings,
} from '@gemini-cli/core';
import stripJsonComments from 'strip-json-comments';
import { DefaultLight } from '../ui/themes/default-light.js';
@@ -41,8 +42,7 @@ export interface Settings {
showMemoryUsage?: boolean;
contextFileName?: string | string[];
accessibility?: AccessibilitySettings;
- telemetry?: boolean;
- telemetryOtlpEndpoint?: string;
+ telemetry?: TelemetrySettings;
preferredEditor?: string;
bugCommand?: BugCommandSettings;
generated by cgit v1.2.3 (git 2.51.0) at 2025-11-07 21:14:30 +0000