Class DatastoreOpenTelemetryOptions.Builder (3.1.0)

public static class DatastoreOpenTelemetryOptions.Builder

Inheritance

java.lang.Object > DatastoreOpenTelemetryOptions.Builder

Methods

build()

public DatastoreOpenTelemetryOptions build()

Builds a new DatastoreOpenTelemetryOptions instance from this builder.

Returns
Type Description
DatastoreOpenTelemetryOptions

a new DatastoreOpenTelemetryOptions.

setExportBuiltinMetricsToGoogleCloudMonitoring(boolean exportBuiltinMetrics)

public DatastoreOpenTelemetryOptions.Builder setExportBuiltinMetricsToGoogleCloudMonitoring(boolean exportBuiltinMetrics)

Sets whether built-in metrics should be exported to Google Cloud Monitoring.

When enabled, client-side metrics are automatically exported to Google Cloud Monitoring using the Cloud Monitoring API. This can be disabled to prevent metrics from being sent to Cloud Monitoring while still allowing metrics to flow to a custom OpenTelemetry backend.

Parameter
Name Description
exportBuiltinMetrics boolean

Whether built-in metrics should be exported to Cloud Monitoring.

Returns
Type Description
DatastoreOpenTelemetryOptions.Builder

this builder instance.

setMetricsEnabled(boolean enabled)

public DatastoreOpenTelemetryOptions.Builder setMetricsEnabled(boolean enabled)

Sets whether metrics should be enabled for the custom (user-provided) OpenTelemetry backend.

Parameter
Name Description
enabled boolean

Whether metrics should be enabled.

Returns
Type Description
DatastoreOpenTelemetryOptions.Builder

this builder instance.

setOpenTelemetry(OpenTelemetry openTelemetry)

public DatastoreOpenTelemetryOptions.Builder setOpenTelemetry(OpenTelemetry openTelemetry)

Sets the OpenTelemetry to use with this Datastore instance. If telemetry collection is enabled, but an OpenTelemetry is not provided, the Datastore SDK will attempt to use the GlobalOpenTelemetry.

Parameter
Name Description
openTelemetry io.opentelemetry.api.OpenTelemetry

The OpenTelemetry that should be used by this Datastore instance.

Returns
Type Description
DatastoreOpenTelemetryOptions.Builder

this builder instance.

setTracingEnabled(boolean enabled)

public DatastoreOpenTelemetryOptions.Builder setTracingEnabled(boolean enabled)

Sets whether tracing should be enabled.

Parameter
Name Description
enabled boolean

Whether tracing should be enabled.

Returns
Type Description
DatastoreOpenTelemetryOptions.Builder

this builder instance.