summaryrefslogtreecommitdiff
path: root/docs/cli/configuration.md
diff options
context:
space:
mode:
authorBryan Morgan <[email protected]>2025-06-23 18:25:49 -0400
committerGitHub <[email protected]>2025-06-23 22:25:49 +0000
commite21dbed8c8550ef3e742f4718f369e12960dbb70 (patch)
tree5d41dc1c0a1dea02e605dd3a251e15d0bb01dc1e /docs/cli/configuration.md
parent160d6a6552968aeeeeb4fa7cb80dcbd1feb61dd0 (diff)
[June 25] Updated docs for telemetry and user statistics (#1346)
Diffstat (limited to 'docs/cli/configuration.md')
-rw-r--r--docs/cli/configuration.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
index 3ce29312..3ec40c5c 100644
--- a/docs/cli/configuration.md
+++ b/docs/cli/configuration.md
@@ -169,6 +169,7 @@ In addition to a project settings file, a project's `.gemini` directory can cont
- **`target`** (string): The destination for collected telemetry. Supported values are `local` and `gcp`.
- **`otlpEndpoint`** (string): The endpoint for the OTLP Exporter.
- **`logPrompts`** (boolean): Whether or not to include the content of user prompts in the logs.
+ - **`usageStatisticsEnabled`** (boolean): Enables or disables the collection of usage statistics. See [Usage Statistics](#usage-statistics) for more information.
- **Example:**
```json
"telemetry": {
@@ -195,6 +196,13 @@ In addition to a project settings file, a project's `.gemini` directory can cont
"command": "node",
"args": ["mcp_server.js", "--verbose"]
}
+ },
+ "telemetry": {
+ "enabled": true,
+ "target": "local",
+ "otlpEndpoint": "http://localhost:4317",
+ "logPrompts": true,
+ "usageStatisticsEnabled": false
}
}
```
@@ -374,3 +382,41 @@ When `.gemini/sandbox.Dockerfile` exists, you can use `BUILD_SANDBOX` environmen
```bash
BUILD_SANDBOX=1 gemini -s
```
+
+## Usage Statistics
+
+To help us improve the Gemini CLI, we collect anonymized usage statistics. This data helps us understand how the CLI is used, identify common issues, and prioritize new features.
+
+**What we collect:**
+
+- **Tool Calls:** We log the names of the tools that are called, whether they succeed or fail, and how long they take to execute. We do not collect the arguments passed to the tools or any data returned by them.
+- **API Requests:** We log the Gemini model used for each request, the duration of the request, and whether it was successful. We do not collect the content of the prompts or responses.
+- **Session Information:** We collect information about the configuration of the CLI, such as the enabled tools and the approval mode.
+
+**What we DON'T collect:**
+
+- **Personally Identifiable Information (PII):** We do not collect any personal information, such as your name, email address, or API keys.
+- **Prompt and Response Content:** We do not log the content of your prompts or the responses from the Gemini model.
+- **File Content:** We do not log the content of any files that are read or written by the CLI.
+
+**How to opt out:**
+
+You can opt out of usage statistics collection at any time by setting the `usageStatisticsEnabled` property to `false` in your `settings.json` file:
+
+```json
+{
+ "telemetry": {
+ "usageStatisticsEnabled": false
+ }
+}
+```
+
+You can also disable all telemetry data collection by setting the `enabled` property to `false`:
+
+```json
+{
+ "telemetry": {
+ "enabled": false
+ }
+}
+```