Optionally enable telemetry collection during Genkit init (#8530)

Author: andrewbrook

src/init/features/genkit/index.ts

@@ -382,7 +382,23 @@ export async function genkitSetup(
       default: true,
     }))
   ) {
-    generateSampleFile(modelOptions[model].plugin, plugins, projectDir, genkitInfo.templateVersion);
+    logger.info(
+      "Telemetry data can be used to monitor and gain insights into your AI features. There may be a cost associated with using this feature. See https://firebase.google.com/docs/genkit/observability/telemetry-collection.",
+    );
+    const enableTelemetry =
+      options.nonInteractive ||
+      (await confirm({
+        message: "Would like you to enable telemetry collection?",
+        default: true,
+      }));
+
+    generateSampleFile(
+      modelOptions[model].plugin,
+      plugins,
+      projectDir,
+      genkitInfo.templateVersion,
+      enableTelemetry,
+    );
   }
 }
 
@@ -507,6 +523,7 @@ function generateSampleFile(
   configPlugins: string[],
   projectDir: string,
   templateVersion: string,
+  enableTelemetry: boolean,
 ): void {
   let modelImport = "";
   if (modelPlugin && pluginToInfo[modelPlugin].model) {
@@ -534,6 +551,7 @@ function generateSampleFile(
           ? pluginToInfo[modelPlugin].model || pluginToInfo[modelPlugin].modelStr || ""
           : "'' /* TODO: Set a model. */",
       ),
+    enableTelemetry,
   );
   logLabeledBullet("genkit", "Generating sample file");
   try {
@@ -622,7 +640,7 @@ async function updatePackageJson(nonInteractive: boolean, projectDir: string): P
   }
 }
 
-function renderConfig(pluginNames: string[], template: string): string {
+function renderConfig(pluginNames: string[], template: string, enableTelemetry: boolean): string {
   const imports = pluginNames
     .map((pluginName) => generateImportStatement(pluginToInfo[pluginName].imports, pluginName))
     .join("\n");
@@ -631,7 +649,8 @@ function renderConfig(pluginNames: string[], template: string): string {
     "    /* Add your plugins here. */";
   return template
     .replace("$GENKIT_CONFIG_IMPORTS", imports)
-    .replace("$GENKIT_CONFIG_PLUGINS", plugins);
+    .replace("$GENKIT_CONFIG_PLUGINS", plugins)
+    .replaceAll("$TELEMETRY_COMMENT", enableTelemetry ? "" : "// ");
 }
 
 function generateImportStatement(imports: string, name: string): string {

templates/genkit/firebase.1.0.0.template

@@ -15,6 +15,11 @@ import { onCallGenkit, hasClaim } from "firebase-functions/https";
 import { defineSecret } from "firebase-functions/params";
 const apiKey = defineSecret("GOOGLE_GENAI_API_KEY");
 
+// The Firebase telemetry plugin exports a combination of metrics, traces, and logs to Google Cloud
+// Observability. See https://firebase.google.com/docs/genkit/observability/telemetry-collection.
+$TELEMETRY_COMMENTimport {enableFirebaseTelemetry} from "@genkit-ai/firebase";
+$TELEMETRY_COMMENTenableFirebaseTelemetry();
+
 const ai = genkit({
   plugins: [
 $GENKIT_CONFIG_PLUGINS