Added a a script to setup and run genkit telemetry and dev ui (#12120)

.gitignore

@@ -54,3 +54,5 @@ gha-creds-*.json
 
 # Log files
 patch_output.log
+
+.genkit

docs/local-development.md

@@ -17,6 +17,42 @@ when running Gemini CLI.
 
 ### Viewing Dev Traces
 
+You can view dev traces using either Jaeger or the Genkit Developer UI.
+
+#### Using Genkit
+
+Genkit provides a web-based UI for viewing traces and other telemetry data.
+
+1.  **Start the Genkit Telemetry Server:**
+
+    Run the following command to start the Genkit server:
+
+    ```bash
+    npm run telemetry -- --target=genkit
+    ```
+
+    The script will output the URL for the Genkit Developer UI, for example:
+
+    ```
+    Genkit Developer UI: http://localhost:4000
+    ```
+
+2.  **Run Gemini CLI with Dev Tracing:**
+
+    In a separate terminal, run your Gemini CLI command with the
+    `GEMINI_DEV_TRACING` environment variable:
+
+    ```bash
+    GEMINI_DEV_TRACING=true gemini
+    ```
+
+3.  **View the Traces:**
+
+    Open the Genkit Developer UI URL in your browser and navigate to the
+    **Traces** tab to view the traces.
+
+#### Using Jaeger
+
 You can view dev traces in the Jaeger UI. To get started, follow these steps:
 
 1.  **Start the telemetry collector:**
@@ -37,7 +73,7 @@ You can view dev traces in the Jaeger UI. To get started, follow these steps:
     `GEMINI_DEV_TRACING` environment variable:
 
     ```bash
-    GEMINI_DEV_TRACING=true gemini [your-command]
+    GEMINI_DEV_TRACING=true gemini
     ```
 
 3.  **View the traces:**

scripts/telemetry.js

@@ -45,7 +45,7 @@ if (!settingsTarget) {
 }
 
 let target = settingsTarget || 'local';
-const allowedTargets = ['local', 'gcp'];
+const allowedTargets = ['local', 'gcp', 'genkit'];
 
 const targetArg = process.argv.find((arg) => arg.startsWith('--target='));
 if (targetArg) {
@@ -65,11 +65,13 @@ if (targetArg) {
   );
 }
 
-const scriptPath = join(
-  projectRoot,
-  'scripts',
-  target === 'gcp' ? 'telemetry_gcp.js' : 'local_telemetry.js',
-);
+const targetScripts = {
+  gcp: 'telemetry_gcp.js',
+  local: 'local_telemetry.js',
+  genkit: 'telemetry_genkit.js',
+};
+
+const scriptPath = join(projectRoot, 'scripts', targetScripts[target]);
 
 try {
   console.log(`🚀 Running telemetry script for target: ${target}.`);

scripts/telemetry_genkit.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { createInterface } from 'node:readline';
+import { spawn } from 'node:child_process';
+import { manageTelemetrySettings, registerCleanup } from './telemetry_utils.js';
+
+const GENKIT_START_COMMAND = 'npx';
+const GENKIT_START_ARGS = ['-y', 'genkit-cli', 'start', '--non-interactive'];
+
+async function main() {
+  let genkitProcess;
+
+  const originalSandboxSetting = manageTelemetrySettings(
+    true,
+    '', // Endpoint will be set dynamically
+    'local',
+    undefined,
+    'http',
+  );
+
+  registerCleanup(
+    () => [genkitProcess],
+    () => [],
+    originalSandboxSetting,
+  );
+
+  console.log('🚀 Starting Genkit telemetry server...');
+  genkitProcess = spawn(GENKIT_START_COMMAND, GENKIT_START_ARGS, {
+    stdio: ['ignore', 'pipe', 'pipe'],
+  });
+
+  const rl = createInterface({ input: genkitProcess.stdout });
+
+  rl.on('line', (line) => {
+    console.log(`[Genkit] ${line}`);
+    const match = line.match(/Telemetry API running on (http:\/\/[^\s]+)/);
+    if (match) {
+      const telemetryApiUrl = match[1];
+      const otlpEndpoint = `${telemetryApiUrl}/api/otlp`;
+      console.log(`✅ Genkit telemetry running on: ${otlpEndpoint}`);
+      manageTelemetrySettings(true, otlpEndpoint, 'local', undefined, 'http');
+    }
+  });
+
+  genkitProcess.stderr.on('data', (data) => {
+    console.error(`[Genkit Error] ${data.toString()}`);
+  });
+
+  genkitProcess.on('close', (code) => {
+    console.log(`Genkit process exited with code ${code}`);
+  });
+
+  genkitProcess.on('error', (err) => {
+    console.error('Failed to start Genkit process:', err);
+    process.exit(1);
+  });
+
+  console.log(`
+✨ Genkit telemetry environment is running.
+`);
+  console.log(`Press Ctrl+C to exit.`);
+}
+
+main();

scripts/telemetry_utils.js

@@ -314,6 +314,7 @@ export function manageTelemetrySettings(
   oTelEndpoint = 'http://localhost:4317',
   target = 'local',
   originalSandboxSettingToRestore,
+  otlpProtocol = 'grpc',
 ) {
   const workspaceSettings = readJsonFile(WORKSPACE_SETTINGS_FILE);
   const currentSandboxSetting = workspaceSettings.sandbox;
@@ -344,6 +345,11 @@ export function manageTelemetrySettings(
       settingsModified = true;
       console.log(`🎯 Set telemetry target to ${target}.`);
     }
+    if (workspaceSettings.telemetry.otlpProtocol !== otlpProtocol) {
+      workspaceSettings.telemetry.otlpProtocol = otlpProtocol;
+      settingsModified = true;
+      console.log(`🔧 Set telemetry OTLP protocol to ${otlpProtocol}.`);
+    }
   } else {
     if (workspaceSettings.telemetry.enabled === true) {
       delete workspaceSettings.telemetry.enabled;
@@ -360,6 +366,11 @@ export function manageTelemetrySettings(
       settingsModified = true;
       console.log('🎯 Cleared telemetry target.');
     }
+    if (workspaceSettings.telemetry.otlpProtocol) {
+      delete workspaceSettings.telemetry.otlpProtocol;
+      settingsModified = true;
+      console.log('🔧 Cleared telemetry OTLP protocol.');
+    }
     if (Object.keys(workspaceSettings.telemetry).length === 0) {
       delete workspaceSettings.telemetry;
     }
@@ -399,7 +410,7 @@ export function registerCleanup(
 
     console.log('\n👋 Shutting down...');
 
-    manageTelemetrySettings(false, null, originalSandboxSetting);
+    manageTelemetrySettings(false, null, null, originalSandboxSetting);
 
     const processes = getProcesses ? getProcesses() : [];
     processes.forEach((proc) => {