From e772dc2b854dff3e9949ce4a16918e97d656d6a2 Mon Sep 17 00:00:00 2001
From: Jerop Kipruto <jerop@google.com>
Date: Sun, 15 Jun 2025 21:12:57 -0400
Subject: [PATCH] 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.
---
 docs/cli/configuration.md | 5 ++++-
 docs/core/telemetry.md    | 2 +-
 scripts/telemetry_gcp.js  | 8 ++++----
 3 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
index 587ad071..c532b0b6 100644
--- a/docs/cli/configuration.md
+++ b/docs/cli/configuration.md
@@ -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.
diff --git a/docs/core/telemetry.md b/docs/core/telemetry.md
index 42719db5..9dc222f5 100644
--- a/docs/core/telemetry.md
+++ b/docs/core/telemetry.md
@@ -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".
diff --git a/scripts/telemetry_gcp.js b/scripts/telemetry_gcp.js
index c88a9dbc..710fbe17 100755
--- a/scripts/telemetry_gcp.js
+++ b/scripts/telemetry_gcp.js
@@ -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(