summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorstarsandskies <[email protected]>2025-06-23 15:18:07 -0700
committerGitHub <[email protected]>2025-06-23 22:18:07 +0000
commit160d6a6552968aeeeeb4fa7cb80dcbd1feb61dd0 (patch)
treea93de8b6bb42f3d2f106ca710b980b89d0fec99d
parentb443b5e800ec3ab20aacfca759229b3939abcaeb (diff)
Docs: Add `telemetry` to the list of configuration options (#1348)
-rw-r--r--docs/cli/configuration.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
index 79eda825..3ce29312 100644
--- a/docs/cli/configuration.md
+++ b/docs/cli/configuration.md
@@ -161,6 +161,24 @@ In addition to a project settings file, a project's `.gemini` directory can cont
- **Default:** `vscode`
- **Example:** `"preferredEditor": "vscode"`
+- **`telemetry`** (object)
+ - **Description:** Configures logging and metrics collection for Gemini CLI. For more information, see [Telemetry](../core/telemetry.md).
+ - **Default:** `{"enabled": false, "target": "local", "otlpEndpoint": "http://localhost:4317", "logPrompts": true}`
+ - **Properties:**
+ - **`enabled`** (boolean): Whether or not telemtery is enabled.
+ - **`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.
+ - **Example:**
+ ```json
+ "telemetry": {
+ "enabled": true,
+ "target": "local",
+ "otlpEndpoint": "http://localhost:16686",
+ "logPrompts": false
+ }
+ ```
+
### Example `settings.json`:
```json