Interface GcpTelemetryConfigOptions

Configuration options for the Google Cloud plugin.

interface GcpTelemetryConfigOptions {
    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;
}

Properties

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

Properties

OptionalautoInstrumentation

autoInstrumentation?: boolean

Include OpenTelemetry autoInstrumentation. Defaults to true.

OptionalautoInstrumentationConfig

autoInstrumentationConfig?: InstrumentationConfigMap

Optionalcredentials

credentials?: JWTInput

Credentials must be provided to export telemetry, if not available through the environment.

OptionaldisableLoggingInputAndOutput

disableLoggingInputAndOutput?: boolean

When true, inputs and outputs are not logged to GCP

OptionaldisableMetrics

disableMetrics?: boolean

When true, metrics are not exported.

OptionaldisableTraces

disableTraces?: boolean

When true, traces are not exported.

OptionalforceDevExport

forceDevExport?: boolean

When true, telemetry data will be exported, even for local runs. Defaults to not exporting development traces.

Optionalinstrumentations

instrumentations?: Instrumentation<InstrumentationConfig>[]

OptionalmetricExportIntervalMillis

metricExportIntervalMillis?: number

Metric export intervals, minimum is 5000ms.

OptionalmetricExportTimeoutMillis

metricExportTimeoutMillis?: number

OptionalprojectId

projectId?: string

Cloud projectId is required, either passed here, through GCLOUD_PROJECT or application default credentials.

Optionalsampler

sampler?: Sampler

Trace sampler, defaults to always on which exports all traces.

Settings

Member Visibility

On This Page

Properties