Skip to content

Commit 5abbffa

Browse files
authored
feat: add instructions for disabling telemetry (#92)
Adds a new section to the observability documentation that explains how to explicitly disable OpenTelemetry by setting `enabled: false` in the action's settings. This change also clarifies that telemetry is disabled by default if the `settings` input is omitted entirely.
1 parent 377e936 commit 5abbffa

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/observability.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The action uses its own built-in telemetry system that ensures consistent and re
1212
- [Viewing Telemetry Data](#viewing-telemetry-data)
1313
- [Collector Configuration](#collector-configuration)
1414
- [Example](#example)
15+
- [Disabling](#disabling)
1516
- [Troubleshooting](#troubleshooting)
1617

1718
## Overview
@@ -102,6 +103,41 @@ jobs:
102103
prompt: "Review this pull request"
103104
```
104105
106+
## Disabling
107+
108+
If you prefer to disable OpenTelemetry, you can explicitly opt out by setting `enabled: false` in your settings:
109+
110+
```yaml
111+
- uses: google-github-actions/run-gemini-cli@main
112+
with:
113+
gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}'
114+
gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}'
115+
gemini_api_key: '${{ secrets.GEMINI_API_KEY }}'
116+
# Disable telemetry in settings
117+
settings: |-
118+
{
119+
"telemetry": {
120+
"enabled": false,
121+
"target": "gcp"
122+
}
123+
}
124+
# ... other inputs ...
125+
```
126+
127+
Alternatively, you can omit the `telemetry` settings entirely, as telemetry is disabled by default:
128+
129+
```yaml
130+
- uses: google-github-actions/run-gemini-cli@main
131+
with:
132+
gcp_workload_identity_provider: '${{ vars.GCP_WIF_PROVIDER }}'
133+
gcp_project_id: '${{ vars.GOOGLE_CLOUD_PROJECT }}'
134+
gemini_api_key: '${{ secrets.GEMINI_API_KEY }}'
135+
settings: |-
136+
{
137+
# ... other settings ...
138+
}
139+
```
140+
105141
## Troubleshooting
106142

107143
**Telemetry not appearing in Google Cloud Console:**

0 commit comments

Comments
 (0)