diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli/configuration.md | 10 | ||||
| -rw-r--r-- | docs/core/index.md | 1 | ||||
| -rw-r--r-- | docs/telemetry.md | 4 |
3 files changed, 7 insertions, 8 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 65bf80a0..0c0aec5a 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -162,7 +162,7 @@ In addition to a project settings file, a project's `.gemini` directory can cont - **Example:** `"preferredEditor": "vscode"` - **`telemetry`** (object) - - **Description:** Configures logging and metrics collection for Gemini CLI. For more information, see [Telemetry](../core/telemetry.md). + - **Description:** Configures logging and metrics collection for Gemini CLI. For more information, see [Telemetry](../telemetry.md). - **Default:** `{"enabled": false, "target": "local", "otlpEndpoint": "http://localhost:4317", "logPrompts": true}` - **Properties:** - **`enabled`** (boolean): Whether or not telemtery is enabled. @@ -307,13 +307,13 @@ Arguments passed directly when running the CLI can override other configurations - **`--yolo`**: - Enables YOLO mode, which automatically approves all tool calls. - **`--telemetry`**: - - Enables [telemetry](../core/telemetry.md). + - Enables [telemetry](../telemetry.md). - **`--telemetry-target`**: - - Sets the telemetry target. See [telemetry](../core/telemetry.md) for more information. + - Sets the telemetry target. See [telemetry](../telemetry.md) for more information. - **`--telemetry-otlp-endpoint`**: - - Sets the OTLP endpoint for telemetry. See [telemetry](../core/telemetry.md) for more information. + - Sets the OTLP endpoint for telemetry. See [telemetry](../telemetry.md) for more information. - **`--telemetry-log-prompts`**: - - Enables logging of prompts for telemetry. See [telemetry](../core/telemetry.md) for more information. + - Enables logging of prompts for telemetry. See [telemetry](../telemetry.md) for more information. - **`--checkpointing`**: - Enables [checkpointing](./commands.md#checkpointing-commands). - **`--version`**: diff --git a/docs/core/index.md b/docs/core/index.md index bf61742e..d77e6bda 100644 --- a/docs/core/index.md +++ b/docs/core/index.md @@ -4,7 +4,6 @@ Gemini CLI's core package (`packages/core`) is the backend portion of Gemini CLI ## Navigating this section -- **[Telemetry](./telemetry.md):** Information on monitoring Gemini CLI's performance, health, and usage. - **[Core tools API](./tools-api.md):** Information on how tools are defined, registered, and used by the core. ## Role of the core diff --git a/docs/telemetry.md b/docs/telemetry.md index 44225ba3..bca3adc9 100644 --- a/docs/telemetry.md +++ b/docs/telemetry.md @@ -2,13 +2,13 @@ Telemetry provides data about Gemini CLI's performance, health, and usage. By enabling it, you can monitor operations, debug issues, and optimize tool usage through traces, metrics, and structured logs. -Gemini CLI's telemtry system is built on the **[OpenTelemetry] (OTEL)** standard, allowing you to send data to any compatible backend. +Gemini CLI's telemetry system is built on the **[OpenTelemetry] (OTEL)** standard, allowing you to send data to any compatible backend. [OpenTelemetry]: https://opentelemetry.io/ ## Enabling telemetry -You can enable telemetry in multiple ways. Configuration is primarily managed via the [`.gemini/settings.json` file](../cli/configuration.md) and environment variables, but CLI flags can override these settings for a specific session. +You can enable telemetry in multiple ways. Configuration is primarily managed via the [`.gemini/settings.json` file](./cli/configuration.md) and environment variables, but CLI flags can override these settings for a specific session. ### Order of precedence |