Skip to content

feat(js): Enable Firebase Genkit Monitoring via an environment variable #3043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2025
Merged

feat(js): Enable Firebase Genkit Monitoring via an environment variable #3043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a24889d
feat(js): Allow enabling Firebase Genkit Monitoring via an environmen…
schnecle Jun 4, 2025
835c449
fix(js): Remove superfluous local development flags
schnecle Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions js/core/src/tracing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,41 @@ const instrumentationKey = '__GENKIT_TELEMETRY_INSTRUMENTED';
* @hidden
*/
export async function ensureBasicTelemetryInstrumentation() {
await checkFirebaseMonitoringAutoInit();

if (global[instrumentationKey]) {
return await global[instrumentationKey];
}

await enableTelemetry({});
}

/**
* Checks to see if the customer is using Firebase Genkit Monitoring
* auto initialization via environment variable by attempting to resolve
* the firebase plugin.
*
* Enables Firebase Genkit Monitoring if the plugin is installed and warns
* if it hasn't been installed.
*/
async function checkFirebaseMonitoringAutoInit() {
if (
!global[instrumentationKey] &&
process.env.ENABLE_FIREBASE_MONITORING === 'true'
) {
try {
const firebaseModule = await require('@genkit-ai/firebase');
firebaseModule.enableFirebaseTelemetry();
} catch (e) {
logger.warn(
"It looks like you're trying to enable firebase monitoring, but " +
"haven't installed the firebase plugin. Please run " +
'`npm i --save @genkit-ai/firebase` and redeploy.'
);
}
}
}

/**
* Enables tracing and metrics open telemetry configuration.
*/
Expand Down
2 changes: 2 additions & 0 deletions js/plugins/firebase/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
enableGoogleCloudTelemetry,
type GcpTelemetryConfigOptions,
} from '@genkit-ai/google-cloud';
import { logger } from 'genkit/logging';
export { defineFirestoreRetriever } from './firestore-retriever.js';

export interface FirebaseTelemetryOptions extends GcpTelemetryConfigOptions {
Expand All @@ -39,5 +40,6 @@ export interface FirebaseTelemetryOptions extends GcpTelemetryConfigOptions {
export async function enableFirebaseTelemetry(
options?: FirebaseTelemetryOptions | GcpTelemetryConfigOptions
) {
logger.debug('Initializing Firebase Genkit Monitoring.');
await enableGoogleCloudTelemetry(options);
}