Genkit JS API reference
    Preparing search index...

    Interface FirebaseTelemetryOptions

    interface FirebaseTelemetryOptions {
        autoInstrumentation?: boolean;
        autoInstrumentationConfig?: InstrumentationConfigMap;
        credentials?: JWTInput;
        disableLoggingInputAndOutput?: boolean;
        disableMetrics?: boolean;
        disableTraces?: boolean;
        forceDevExport?: boolean;
        instrumentations?: Instrumentation<InstrumentationConfig>[];
        metricExportIntervalMillis?: number;
        metricExportTimeoutMillis?: number;
        projectId?: string;
        sampler?: Sampler;
    }

    Hierarchy

    • GcpTelemetryConfigOptions
      • FirebaseTelemetryOptions
    Index

    Properties

    autoInstrumentation? autoInstrumentationConfig? credentials? disableLoggingInputAndOutput? disableMetrics? disableTraces? forceDevExport? instrumentations? metricExportIntervalMillis? metricExportTimeoutMillis? projectId? sampler?

    Properties

    autoInstrumentation?: boolean

    Enabled by default, OpenTelemetry will automatically collect telemetry for popular libraries via auto instrumentations without any additional code or configuration. All available instrumentations will be collected, unless otherwise specified via autoInstrumentationConfig.

    https://opentelemetry.io/docs/zero-code/js/

    autoInstrumentationConfig?: InstrumentationConfigMap

    Map of auto instrumentations and their configuration options. Available options will vary by instrumentation.

    https://opentelemetry.io/docs/zero-code/js/

    credentials?: JWTInput

    Credentials for authenticating with Google Cloud. Primarily intended for use in environments outside of GCP. On GCP credentials will typically be inferred from the environment via Application Default Credentials (ADC).

    disableLoggingInputAndOutput?: boolean

    If set to true, input and output logs will not be collected.

    disableMetrics?: boolean

    If set to true, metrics will not be exported to Google Cloud. Traces and logs may still be exported.

    disableTraces?: boolean

    If set to true, traces will not be exported to Google Cloud. Metrics and logs may still be exported.

    forceDevExport?: boolean

    If set to true, telemetry data will be exported in the Genkit dev environment. Useful for local testing and troubleshooting; default is false.

    instrumentations?: Instrumentation<InstrumentationConfig>[]

    Additional OpenTelemetry instrumentations to include, beyond those provided by auto instrumentations.

    metricExportIntervalMillis?: number

    Metrics export interval in milliseconds; Google Cloud requires a minimum value of 5000ms.

    metricExportTimeoutMillis?: number

    Timeout for the metrics export in milliseconds.

    projectId?: string

    Google Cloud Project ID. If provided, will take precedence over the projectId inferred from the application credential and/or environment. Required when providing an external credential (e.g. Workload Identity Federation.)

    sampler?: Sampler

    OpenTelemetry sampler; controls the number of traces collected and exported to Google Cloud. Defaults to AlwaysOnSampler, which will collect and export all traces.

    There are four built-in samplers to choose from:

    Settings

    Member Visibility

    On This Page

    Properties