File size: 29,479 Bytes
7a1ad33 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 | # Observability with OpenTelemetry
Observability is the key to turning experimental AI into reliable software.
Gemini CLI provides built-in support for OpenTelemetry, transforming every agent
interaction into a rich stream of logs, metrics, and traces. This three-pillar
approach gives you the high-fidelity visibility needed to understand agent
behavior, optimize performance, and ensure reliability across your entire
workflow.
Whether you are debugging a complex tool interaction locally or monitoring
enterprise-wide usage in the cloud, Gemini CLI's observability system provides
the actionable intelligence needed to move from "black box" AI to predictable,
high-performance systems.
## OpenTelemetry integration
Gemini CLI integrates with **[OpenTelemetry]**, a vendor-neutral,
industry-standard observability framework.
The observability system provides:
- Universal compatibility: Export to any OpenTelemetry backend (Google Cloud,
Jaeger, Prometheus, Datadog, etc.).
- Standardized data: Use consistent formats and collection methods across your
toolchain.
- Future-proof integration: Connect with existing and future observability
infrastructure.
- No vendor lock-in: Switch between backends without changing your
instrumentation.
[OpenTelemetry]: https://opentelemetry.io/
## Configuration
You control telemetry behavior through the `.gemini/settings.json` file.
Environment variables can override these settings.
| Setting | Environment Variable | Description | Values | Default |
| -------------- | --------------------------------- | --------------------------------------------------- | ----------------- | ----------------------- |
| `enabled` | `GEMINI_TELEMETRY_ENABLED` | Enable or disable telemetry | `true`/`false` | `false` |
| `traces` | `GEMINI_TELEMETRY_TRACES_ENABLED` | Enable detailed attribute tracing | `true`/`false` | `false` |
| `target` | `GEMINI_TELEMETRY_TARGET` | Where to send telemetry data | `"gcp"`/`"local"` | `"local"` |
| `otlpEndpoint` | `GEMINI_TELEMETRY_OTLP_ENDPOINT` | OTLP collector endpoint | URL string | `http://localhost:4317` |
| `otlpProtocol` | `GEMINI_TELEMETRY_OTLP_PROTOCOL` | OTLP transport protocol | `"grpc"`/`"http"` | `"grpc"` |
| `outfile` | `GEMINI_TELEMETRY_OUTFILE` | Save telemetry to file (overrides `otlpEndpoint`) | file path | - |
| `logPrompts` | `GEMINI_TELEMETRY_LOG_PROMPTS` | Include prompts in telemetry logs | `true`/`false` | `true` |
| `useCollector` | `GEMINI_TELEMETRY_USE_COLLECTOR` | Use external OTLP collector (advanced) | `true`/`false` | `false` |
| `useCliAuth` | `GEMINI_TELEMETRY_USE_CLI_AUTH` | Use CLI credentials for telemetry (GCP target only) | `true`/`false` | `false` |
| - | `GEMINI_CLI_SURFACE` | Optional custom label for traffic reporting | string | - |
**Note on boolean environment variables:** For boolean settings like `enabled`,
setting the environment variable to `true` or `1` enables the feature.
For detailed configuration information, see the
[Configuration guide](../reference/configuration.md).
## Google Cloud telemetry
You can export telemetry data directly to Google Cloud Trace, Cloud Monitoring,
and Cloud Logging.
### Prerequisites
You must complete several setup steps before enabling Google Cloud telemetry.
1. Set your Google Cloud project ID:
- To send telemetry to a separate project:
**macOS/Linux**
```bash
export OTLP_GOOGLE_CLOUD_PROJECT="your-telemetry-project-id"
```
**Windows (PowerShell)**
```powershell
$env:OTLP_GOOGLE_CLOUD_PROJECT="your-telemetry-project-id"
```
- To send telemetry to the same project as inference:
**macOS/Linux**
```bash
export GOOGLE_CLOUD_PROJECT="your-project-id"
```
**Windows (PowerShell)**
```powershell
$env:GOOGLE_CLOUD_PROJECT="your-project-id"
```
2. Authenticate with Google Cloud using one of these methods:
- **Method A: Application Default Credentials (ADC)**: Use this method for
service accounts or standard `gcloud` authentication.
- For user accounts:
```bash
gcloud auth application-default login
```
- For service accounts:
**macOS/Linux**
```bash
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account.json"
```
**Windows (PowerShell)**
```powershell
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\your\service-account.json"
```
* **Method B: CLI Auth** (Direct export only): Simplest method for local
users. Gemini CLI uses the same OAuth credentials you used for login. To
enable this, set `useCliAuth: true` in your `.gemini/settings.json`:
```json
{
"telemetry": {
"enabled": true,
"target": "gcp",
"useCliAuth": true
}
}
```
<!-- prettier-ignore -->
> [!NOTE]
> This setting requires **Direct export** (in-process exporters)
> and cannot be used when `useCollector` is `true`. If both are enabled,
> telemetry will be disabled.
3. Ensure your account or service account has these IAM roles:
- Cloud Trace Agent
- Monitoring Metric Writer
- Logs Writer
4. Enable the required Google Cloud APIs:
```bash
gcloud services enable \
cloudtrace.googleapis.com \
monitoring.googleapis.com \
logging.googleapis.com \
--project="$OTLP_GOOGLE_CLOUD_PROJECT"
```
### Direct export
We recommend using direct export to send telemetry directly to Google Cloud
services.
1. Enable telemetry in `.gemini/settings.json`:
```json
{
"telemetry": {
"enabled": true,
"target": "gcp"
}
}
```
2. Run Gemini CLI and send prompts.
3. View logs, metrics, and traces in the Google Cloud Console. See
[View Google Cloud telemetry](#view-google-cloud-telemetry) for details.
### View Google Cloud telemetry
After you enable telemetry and run Gemini CLI, you can view your data in the
Google Cloud Console.
- **Logs:** [Logs Explorer](https://console.cloud.google.com/logs/)
- **Metrics:**
[Metrics Explorer](https://console.cloud.google.com/monitoring/metrics-explorer)
- **Traces:** [Trace Explorer](https://console.cloud.google.com/traces/list)
For detailed information on how to use these tools, see the following official
Google Cloud documentation:
- [View and analyze logs with Logs Explorer](https://cloud.google.com/logging/docs/view/logs-explorer-interface)
- [Create charts with Metrics Explorer](https://cloud.google.com/monitoring/charts/metrics-explorer)
- [Find and explore traces](https://cloud.google.com/trace/docs/finding-traces)
#### Monitoring dashboards
Gemini CLI provides a pre-configured
[Google Cloud Monitoring](https://cloud.google.com/monitoring) dashboard to
visualize your telemetry.
Find this dashboard under **Google Cloud Monitoring Dashboard Templates** as
"**Gemini CLI Monitoring**".



To learn more, see
[Instant insights: Gemini CLI’s pre-configured monitoring dashboards](https://cloud.google.com/blog/topics/developers-practitioners/instant-insights-gemini-clis-new-pre-configured-monitoring-dashboards/).
## Local telemetry
You can capture telemetry data locally for development and debugging. We
recommend using file-based output for local development.
1. Enable telemetry in `.gemini/settings.json`:
```json
{
"telemetry": {
"enabled": true,
"target": "local",
"outfile": ".gemini/telemetry.log"
}
}
```
2. Run Gemini CLI and send prompts.
3. View logs and metrics in `.gemini/telemetry.log`.
For advanced local telemetry setups (such as Jaeger or Genkit), see the
[Local development guide](../local-development.md#viewing-traces).
## Client identification
Gemini CLI includes identifiers in its `User-Agent` header to help you
differentiate and report on API traffic from different environments (for
example, identifying calls from Gemini Code Assist versus a standard terminal).
### Automatic identification
Most integrated environments are identified automatically without additional
configuration. The identifier is included as a prefix to the `User-Agent` and as
a "surface" tag in the parenthetical metadata.
| Environment | User-Agent Prefix | Surface Tag |
| :---------------------------------- | :--------------------------- | :---------- |
| **Gemini Code Assist (Agent Mode)** | `GeminiCLI-a2a-server` | `vscode` |
| **Zed (via ACP)** | `GeminiCLI-acp-zed` | `zed` |
| **XCode (via ACP)** | `GeminiCLI-acp-xcode` | `xcode` |
| **IntelliJ IDEA (via ACP)** | `GeminiCLI-acp-intellijidea` | `jetbrains` |
| **Standard Terminal** | `GeminiCLI` | `terminal` |
**Example User-Agent:**
`GeminiCLI-a2a-server/0.34.0/gemini-pro (linux; x64; vscode)`
### Custom identification
You can provide a custom identifier for your own scripts or automation by
setting the `GEMINI_CLI_SURFACE` environment variable. This is useful for
tracking specific internal tools or distribution channels in your GCP logs.
**macOS/Linux**
```bash
export GEMINI_CLI_SURFACE="my-custom-tool"
```
**Windows (PowerShell)**
```powershell
$env:GEMINI_CLI_SURFACE="my-custom-tool"
```
When set, the value appears at the end of the `User-Agent` parenthetical:
`GeminiCLI/0.34.0/gemini-pro (linux; x64; my-custom-tool)`
## Logs, metrics, and traces
This section describes the structure of logs, metrics, and traces generated by
Gemini CLI.
Gemini CLI includes `session.id`, `installation.id`, `active_approval_mode`, and
`user.email` (when authenticated) as common attributes on all data.
### Logs
Logs provide timestamped records of specific events. Gemini CLI logs events
across several categories.
#### Sessions
Session logs capture startup configuration and prompt submissions.
##### `gemini_cli.config`
Emitted at startup with the CLI configuration.
<details>
<summary>Attributes</summary>
- `model` (string)
- `embedding_model` (string)
- `sandbox_enabled` (boolean)
- `core_tools_enabled` (string)
- `approval_mode` (string)
- `api_key_enabled` (boolean)
- `vertex_ai_enabled` (boolean)
- `log_user_prompts_enabled` (boolean)
- `file_filtering_respect_git_ignore` (boolean)
- `debug_mode` (boolean)
- `mcp_servers` (string)
- `mcp_servers_count` (int)
- `mcp_tools` (string)
- `mcp_tools_count` (int)
- `output_format` (string)
- `extensions` (string)
- `extension_ids` (string)
- `extensions_count` (int)
- `auth_type` (string)
- `worktree_active` (boolean)
- `github_workflow_name` (string, optional)
- `github_repository_hash` (string, optional)
- `github_event_name` (string, optional)
- `github_pr_number` (string, optional)
- `github_issue_number` (string, optional)
- `github_custom_tracking_id` (string, optional)
</details>
##### `gemini_cli.user_prompt`
Emitted when you submit a prompt.
<details>
<summary>Attributes</summary>
- `prompt_length` (int)
- `prompt_id` (string)
- `prompt` (string; excluded if `telemetry.logPrompts` is `false`)
- `auth_type` (string)
</details>
#### Approval mode
These logs track changes to and usage of different approval modes.
##### Lifecycle
##### `approval_mode_switch`
Logs when you change the approval mode.
<details>
<summary>Attributes</summary>
- `from_mode` (string)
- `to_mode` (string)
</details>
##### `approval_mode_duration`
Records time spent in an approval mode.
<details>
<summary>Attributes</summary>
- `mode` (string)
- `duration_ms` (int)
</details>
##### Execution
##### `plan_execution`
Logs when you execute a plan and switch from plan mode to active execution.
<details>
<summary>Attributes</summary>
- `approval_mode` (string)
</details>
#### Tools
Tool logs capture executions, truncation, and edit behavior.
##### `gemini_cli.tool_call`
Emitted for each tool (function) call.
<details>
<summary>Attributes</summary>
- `function_name` (string)
- `function_args` (string)
- `duration_ms` (int)
- `success` (boolean)
- `decision` (string: "accept", "reject", "auto_accept", or "modify")
- `error` (string, optional)
- `error_type` (string, optional)
- `prompt_id` (string)
- `tool_type` (string: "native" or "mcp")
- `mcp_server_name` (string, optional)
- `extension_name` (string, optional)
- `extension_id` (string, optional)
- `content_length` (int, optional)
- `start_time` (number, optional)
- `end_time` (number, optional)
- `metadata` (object, optional), which may include:
- `model_added_lines` (number)
- `model_removed_lines` (number)
- `user_added_lines` (number)
- `user_removed_lines` (number)
- `ask_user` (object)
</details>
##### `gemini_cli.tool_output_truncated`
Logs when tool output is truncated.
<details>
<summary>Attributes</summary>
- `tool_name` (string)
- `original_content_length` (int)
- `truncated_content_length` (int)
- `threshold` (int)
- `lines` (int)
- `prompt_id` (string)
</details>
##### `gemini_cli.edit_strategy`
Records the chosen edit strategy.
<details>
<summary>Attributes</summary>
- `strategy` (string)
</details>
##### `gemini_cli.edit_correction`
Records the result of an edit correction.
<details>
<summary>Attributes</summary>
- `correction` (string: "success" or "failure")
</details>
##### `gen_ai.client.inference.operation.details`
Provides detailed GenAI operation data aligned with OpenTelemetry conventions.
<details>
<summary>Attributes</summary>
- `gen_ai.request.model` (string)
- `gen_ai.provider.name` (string)
- `gen_ai.operation.name` (string)
- `gen_ai.input.messages` (json string)
- `gen_ai.output.messages` (json string)
- `gen_ai.response.finish_reasons` (array of strings)
- `gen_ai.usage.input_tokens` (int)
- `gen_ai.usage.output_tokens` (int)
- `gen_ai.request.temperature` (float)
- `gen_ai.request.top_p` (float)
- `gen_ai.request.top_k` (int)
- `gen_ai.request.max_tokens` (int)
- `gen_ai.system_instructions` (json string)
- `server.address` (string)
- `server.port` (int)
</details>
#### Files
File logs track operations performed by tools.
##### `gemini_cli.file_operation`
Emitted for each file creation, read, or update.
<details>
<summary>Attributes</summary>
- `tool_name` (string)
- `operation` (string: "create", "read", or "update")
- `lines` (int, optional)
- `mimetype` (string, optional)
- `extension` (string, optional)
- `programming_language` (string, optional)
</details>
#### API
API logs capture requests, responses, and errors from Gemini API.
##### `gemini_cli.api_request`
Request sent to Gemini API.
<details>
<summary>Attributes</summary>
- `model` (string)
- `prompt_id` (string)
- `role` (string: "user", "model", or "system")
- `request_text` (string, optional)
</details>
##### `gemini_cli.api_response`
Response received from Gemini API.
<details>
<summary>Attributes</summary>
- `model` (string)
- `status_code` (int or string)
- `duration_ms` (int)
- `input_token_count` (int)
- `output_token_count` (int)
- `cached_content_token_count` (int)
- `thoughts_token_count` (int)
- `tool_token_count` (int)
- `total_token_count` (int)
- `prompt_id` (string)
- `auth_type` (string)
- `finish_reasons` (array of strings)
- `response_text` (string, optional)
</details>
##### `gemini_cli.api_error`
Logs when an API request fails.
<details>
<summary>Attributes</summary>
- `error.message` (string)
- `model_name` (string)
- `duration` (int)
- `prompt_id` (string)
- `auth_type` (string)
- `error_type` (string, optional)
- `status_code` (int or string, optional)
- `role` (string, optional)
</details>
##### `gemini_cli.malformed_json_response`
Logs when a JSON response cannot be parsed.
<details>
<summary>Attributes</summary>
- `model` (string)
</details>
#### Model routing
These logs track how Gemini CLI selects and routes requests to models.
##### `gemini_cli.slash_command`
Logs slash command execution.
<details>
<summary>Attributes</summary>
- `command` (string)
- `subcommand` (string, optional)
- `status` (string: "success" or "error")
</details>
##### `gemini_cli.slash_command.model`
Logs model selection via slash command.
<details>
<summary>Attributes</summary>
- `model_name` (string)
</details>
##### `gemini_cli.model_routing`
Records model router decisions and reasoning.
<details>
<summary>Attributes</summary>
- `decision_model` (string)
- `decision_source` (string)
- `routing_latency_ms` (int)
- `reasoning` (string, optional)
- `failed` (boolean)
- `error_message` (string, optional)
- `approval_mode` (string)
</details>
#### Chat and streaming
These logs track chat context compression and streaming chunk errors.
##### `gemini_cli.chat_compression`
Logs chat context compression events.
<details>
<summary>Attributes</summary>
- `tokens_before` (int)
- `tokens_after` (int)
</details>
##### `gemini_cli.chat.invalid_chunk`
Logs invalid chunks received in a stream.
<details>
<summary>Attributes</summary>
- `error_message` (string, optional)
</details>
##### `gemini_cli.chat.content_retry`
Logs retries due to content errors.
<details>
<summary>Attributes</summary>
- `attempt_number` (int)
- `error_type` (string)
- `retry_delay_ms` (int)
- `model` (string)
</details>
##### `gemini_cli.chat.content_retry_failure`
Logs when all content retries fail.
<details>
<summary>Attributes</summary>
- `total_attempts` (int)
- `final_error_type` (string)
- `total_duration_ms` (int, optional)
- `model` (string)
</details>
##### `gemini_cli.conversation_finished`
Logs when a conversation session ends.
<details>
<summary>Attributes</summary>
- `approvalMode` (string)
- `turnCount` (int)
</details>
#### Resilience
Resilience logs record fallback mechanisms and recovery attempts.
##### `gemini_cli.flash_fallback`
Logs switch to a flash model fallback.
<details>
<summary>Attributes</summary>
- `auth_type` (string)
</details>
##### `gemini_cli.ripgrep_fallback`
Logs fallback to standard grep.
<details>
<summary>Attributes</summary>
- `error` (string, optional)
</details>
##### `gemini_cli.web_fetch_fallback_attempt`
Logs web-fetch fallback attempts.
<details>
<summary>Attributes</summary>
- `reason` (string: "private_ip" or "primary_failed")
</details>
##### `gemini_cli.agent.recovery_attempt`
Logs attempts to recover from agent errors.
<details>
<summary>Attributes</summary>
- `agent_name` (string)
- `attempt_number` (int)
- `success` (boolean)
- `error_type` (string, optional)
</details>
#### Extensions
Extension logs track lifecycle events and settings changes.
##### `gemini_cli.extension_install`
Logs when you install an extension.
<details>
<summary>Attributes</summary>
- `extension_name` (string)
- `extension_version` (string)
- `extension_source` (string)
- `status` (string)
</details>
##### `gemini_cli.extension_uninstall`
Logs when you uninstall an extension.
<details>
<summary>Attributes</summary>
- `extension_name` (string)
- `status` (string)
</details>
##### `gemini_cli.extension_enable`
Logs when you enable an extension.
<details>
<summary>Attributes</summary>
- `extension_name` (string)
- `setting_scope` (string)
</details>
##### `gemini_cli.extension_disable`
Logs when you disable an extension.
<details>
<summary>Attributes</summary>
- `extension_name` (string)
- `setting_scope` (string)
</details>
#### Agent runs
Agent logs track the lifecycle of agent executions.
##### `gemini_cli.agent.start`
Logs when an agent run begins.
<details>
<summary>Attributes</summary>
- `agent_id` (string)
- `agent_name` (string)
</details>
##### `gemini_cli.agent.finish`
Logs when an agent run completes.
<details>
<summary>Attributes</summary>
- `agent_id` (string)
- `agent_name` (string)
- `duration_ms` (int)
- `turn_count` (int)
- `terminate_reason` (string)
</details>
#### IDE
IDE logs capture connectivity events for the IDE companion.
##### `gemini_cli.ide_connection`
Logs IDE companion connections.
<details>
<summary>Attributes</summary>
- `connection_type` (string)
</details>
#### UI
UI logs track terminal rendering issues.
##### `kitty_sequence_overflow`
Logs terminal control sequence overflows.
<details>
<summary>Attributes</summary>
- `sequence_length` (int)
- `truncated_sequence` (string)
</details>
#### Miscellaneous
##### `gemini_cli.rewind`
Logs when the conversation state is rewound.
<details>
<summary>Attributes</summary>
- `outcome` (string)
</details>
##### `gemini_cli.conseca.verdict`
Logs security verdicts from ConSeca.
<details>
<summary>Attributes</summary>
- `verdict` (string)
- `decision` (string: "accept", "reject", or "modify")
- `reason` (string, optional)
- `tool_name` (string, optional)
</details>
##### `gemini_cli.hook_call`
Logs execution of lifecycle hooks.
<details>
<summary>Attributes</summary>
- `hook_name` (string)
- `hook_type` (string)
- `duration_ms` (int)
- `success` (boolean)
</details>
##### `gemini_cli.tool_output_masking`
Logs when tool output is masked for privacy.
<details>
<summary>Attributes</summary>
- `tokens_before` (int)
- `tokens_after` (int)
- `masked_count` (int)
- `total_prunable_tokens` (int)
</details>
##### `gemini_cli.keychain.availability`
Logs keychain availability checks.
<details>
<summary>Attributes</summary>
- `available` (boolean)
##### `gemini_cli.startup_stats`
Logs detailed startup performance statistics.
<details>
<summary>Attributes</summary>
- `phases` (json array of startup phases)
- `os_platform` (string)
- `os_release` (string)
- `is_docker` (boolean)
</details>
</details>
### Metrics
Metrics provide numerical measurements of behavior over time.
#### Custom metrics
Gemini CLI exports several custom metrics.
##### Sessions
##### `gemini_cli.session.count`
Incremented once per CLI startup.
##### Onboarding
Tracks onboarding flow from authentication to the user
- `gemini_cli.onboarding.start` (Counter, Int): Incremented when the
authentication flow begins.
- `gemini_cli.onboarding.success` (Counter, Int): Incremented when the user
onboarding flow completes successfully.
<details>
<summary>Attributes (Success)</summary>
- `user_tier` (string)
##### Tools
##### `gemini_cli.tool.call.count`
Counts tool calls.
<details>
<summary>Attributes</summary>
- `function_name` (string)
- `success` (boolean)
- `decision` (string: "accept", "reject", "modify", or "auto_accept")
- `tool_type` (string: "mcp" or "native")
</details>
##### `gemini_cli.tool.call.latency`
Measures tool call latency (in ms).
<details>
<summary>Attributes</summary>
- `function_name` (string)
</details>
##### API
##### `gemini_cli.api.request.count`
Counts all API requests.
<details>
<summary>Attributes</summary>
- `model` (string)
- `status_code` (int or string)
- `error_type` (string, optional)
</details>
##### `gemini_cli.api.request.latency`
Measures API request latency (in ms).
<details>
<summary>Attributes</summary>
- `model` (string)
</details>
##### Token usage
##### `gemini_cli.token.usage`
Counts input, output, thought, cache, and tool tokens.
<details>
<summary>Attributes</summary>
- `model` (string)
- `type` (string: "input", "output", "thought", "cache", or "tool")
</details>
##### Files
##### `gemini_cli.file.operation.count`
Counts file operations.
<details>
<summary>Attributes</summary>
- `operation` (string: "create", "read", or "update")
- `lines` (int, optional)
- `mimetype` (string, optional)
- `extension` (string, optional)
- `programming_language` (string, optional)
</details>
##### `gemini_cli.lines.changed`
Counts added or removed lines.
<details>
<summary>Attributes</summary>
- `function_name` (string, optional)
- `type` (string: "added" or "removed")
</details>
##### Chat and streaming
##### `gemini_cli.chat_compression`
Counts compression operations.
<details>
<summary>Attributes</summary>
- `tokens_before` (int)
- `tokens_after` (int)
</details>
##### `gemini_cli.chat.invalid_chunk.count`
Counts invalid stream chunks.
##### `gemini_cli.chat.content_retry.count`
Counts content error retries.
##### `gemini_cli.chat.content_retry_failure.count`
Counts requests where all retries failed.
##### Model routing
##### `gemini_cli.slash_command.model.call_count`
Counts model selections.
<details>
<summary>Attributes</summary>
- `slash_command.model.model_name` (string)
</details>
##### `gemini_cli.model_routing.latency`
Measures routing decision latency.
<details>
<summary>Attributes</summary>
- `routing.decision_model` (string)
- `routing.decision_source` (string)
- `routing.approval_mode` (string)
</details>
##### `gemini_cli.model_routing.failure.count`
Counts routing failures.
<details>
<summary>Attributes</summary>
- `routing.decision_source` (string)
- `routing.error_message` (string)
- `routing.approval_mode` (string)
</details>
##### Agent runs
##### `gemini_cli.agent.run.count`
Counts agent runs.
<details>
<summary>Attributes</summary>
- `agent_name` (string)
- `terminate_reason` (string)
</details>
##### `gemini_cli.agent.duration`
Measures agent run duration.
<details>
<summary>Attributes</summary>
- `agent_name` (string)
</details>
##### `gemini_cli.agent.turns`
Counts turns per agent run.
<details>
<summary>Attributes</summary>
- `agent_name` (string)
</details>
##### Approval mode
##### `gemini_cli.plan.execution.count`
Counts plan executions.
<details>
<summary>Attributes</summary>
- `approval_mode` (string)
</details>
##### UI
##### `gemini_cli.ui.flicker.count`
Counts terminal flicker events.
##### Performance
Gemini CLI provides detailed performance metrics for advanced monitoring.
##### `gemini_cli.startup.duration`
Measures startup time by phase.
<details>
<summary>Attributes</summary>
- `phase` (string)
- `details` (map, optional)
</details>
##### `gemini_cli.memory.usage`
Measures heap and RSS memory.
<details>
<summary>Attributes</summary>
- `memory_type` (string: "heap_used", "heap_total", "external", "rss")
- `component` (string, optional)
</details>
##### `gemini_cli.cpu.usage`
Measures CPU usage percentage.
<details>
<summary>Attributes</summary>
- `component` (string, optional)
</details>
##### `gemini_cli.tool.queue.depth`
Measures tool execution queue depth.
##### `gemini_cli.tool.execution.breakdown`
Breaks down tool time by phase.
<details>
<summary>Attributes</summary>
- `function_name` (string)
- `phase` (string: "validation", "preparation", "execution",
"result_processing")
</details>
#### GenAI semantic convention
These metrics follow standard [OpenTelemetry GenAI semantic conventions].
- `gen_ai.client.token.usage`: Counts tokens used per operation.
- `gen_ai.client.operation.duration`: Measures operation duration in seconds.
[OpenTelemetry GenAI semantic conventions]:
https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-metrics.md
### Traces
Traces provide an "under-the-hood" view of agent and backend operations. Use
traces to debug tool interactions and optimize performance.
<!-- prettier-ignore -->
> [!NOTE]
> Detailed trace attributes (like full prompts and tool outputs) are disabled by default
> to minimize overhead. You must explicitly set `telemetry.traces` to `true` (or set
> `GEMINI_TELEMETRY_TRACES_ENABLED=true`) to capture them.
Every trace captures rich metadata via standard span attributes.
<details open>
<summary>Standard span attributes</summary>
- `gen_ai.operation.name`: High-level operation (for example, `tool_call`,
`llm_call`, `user_prompt`, `system_prompt`, `agent_call`, or
`schedule_tool_calls`).
- `gen_ai.agent.name`: Set to `gemini-cli`.
- `gen_ai.agent.description`: The service agent description.
- `gen_ai.input.messages`: Input data or metadata.
- `gen_ai.output.messages`: Output data or results.
- `gen_ai.request.model`: Request model name.
- `gen_ai.response.model`: Response model name.
- `gen_ai.prompt.name`: The prompt name.
- `gen_ai.tool.name`: Executed tool name.
- `gen_ai.tool.call_id`: Unique ID for the tool call.
- `gen_ai.tool.description`: Tool description.
- `gen_ai.tool.definitions`: Tool definitions in JSON format.
- `gen_ai.usage.input_tokens`: Number of input tokens.
- `gen_ai.usage.output_tokens`: Number of output tokens.
- `gen_ai.system_instructions`: System instructions in JSON format.
- `gen_ai.conversation.id`: The CLI session ID.
</details>
For more details on semantic conventions for events, see the
[OpenTelemetry documentation](https://github.com/open-telemetry/semantic-conventions/blob/8b4f210f43136e57c1f6f47292eb6d38e3bf30bb/docs/gen-ai/gen-ai-events.md).
|