Decouple telemetry project ID configuration (#1077)

#750 

Renames project ID for telemetry from `GOOGLE_CLOUD_PROJECT` to `OTLP_GOOGLE_CLOUD_PROJECT`.

This change allows for a separate Google Cloud Project to be used for telemetry data, distinct from the project used for other services like Vertex AI or Code Assist. This enhances clarity and flexibility in project configuration.
This commit is contained in:
Jerop Kipruto 2025-06-15 21:12:57 -04:00 committed by GitHub
parent 5c8e49a0e3
commit e772dc2b85
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 6 deletions

View File

@ -216,9 +216,12 @@ The CLI automatically loads environment variables from an `.env` file. The loadi
- Example: `export GOOGLE_API_KEY="YOUR_GOOGLE_API_ KEY"`.
- **`GOOGLE_CLOUD_PROJECT`**:
- Your Google Cloud Project ID.
- Required for using Code Assist, Telemetry or Vertex AI.
- Required for using Code Assist or Vertex AI.
- If using Vertex AI, ensure you have the necessary permissions and set the `GOOGLE_GENAI_USE_VERTEXAI=true` environment variable.
- Example: `export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"`.
- **`OTLP_GOOGLE_CLOUD_PROJECT`**:
- Your Google Cloud Project ID for Telemetry in Google Cloud
- Example: `export OTLP_GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"`.
- **`GOOGLE_CLOUD_LOCATION`**:
- Your Google Cloud Project Location (e.g., us-central1).
- Required for using Vertex AI in non express mode.

View File

@ -136,7 +136,7 @@ Use the `npm run telemetry -- --target=gcp` command which automates setting up a
- Ensure you have a Google Cloud Project ID.
- Export the `GOOGLE_CLOUD_PROJECT` environment variable to make it available to the OTEL collector.
```bash
export GOOGLE_CLOUD_PROJECT="your-project-id"
export OTLP_GOOGLE_CLOUD_PROJECT="your-project-id"
```
- Authenticate with Google Cloud (e.g., run `gcloud auth application-default login` or ensure `GOOGLE_APPLICATION_CREDENTIALS` is set).
- Ensure your account/service account has the necessary roles: "Cloud Trace Agent", "Monitoring Metric Writer", and "Logs Writer".

View File

@ -78,18 +78,18 @@ async function main() {
originalSandboxSetting,
);
const projectId = process.env.GOOGLE_CLOUD_PROJECT;
const projectId = process.env.OTLP_GOOGLE_CLOUD_PROJECT;
if (!projectId) {
console.error(
'🛑 Error: GOOGLE_CLOUD_PROJECT environment variable is not exported.',
'🛑 Error: OTLP_GOOGLE_CLOUD_PROJECT environment variable is not exported.',
);
console.log(
' Please set it to your Google Cloud Project ID and try again.',
);
console.log(' `export GOOGLE_CLOUD_PROJECT=your-project-id`');
console.log(' `export OTLP_GOOGLE_CLOUD_PROJECT=your-project-id`');
process.exit(1);
}
console.log(`✅ Using Google Cloud Project ID: ${projectId}`);
console.log(`✅ Using OTLP Google Cloud Project ID: ${projectId}`);
console.log('\n🔑 Please ensure you are authenticated with Google Cloud:');
console.log(