feat(Datastore): Introduce Client Side Metrics by lqiu96 · Pull Request #12718 · googleapis/google-cloud-java (original) (raw)

added 22 commits

March 31, 2026 23:41

Update DatastoreAdminStubSettings and DatastoreStubSettings to include the library version via Version.VERSION. Add the two new Version.java files that hold the library version constant. Update native image reflect-config.json for both the admin and core stub packages.

…gRPC transport coverage

Replace the old MetricsRecorder / OpenTelemetryMetricsRecorder / NoOpMetricsRecorder types with the new DatastoreMetricsRecorder family, which extends GAX's MetricsRecorder interface for a unified recording contract.

Key changes:

• Delete MetricsRecorder.java, OpenTelemetryMetricsRecorder.java, NoOpMetricsRecorder.java and their tests
• Add DatastoreMetricsRecorder interface (with simple getInstance() that returns an OTel recorder when metrics are enabled, NoOp otherwise)
• Add NoOpDatastoreMetricsRecorder, OpenTelemetryDatastoreMetricsRecorder, and DatastoreMetricsRecorderTest
• Remove the !GRPC transport guard from TelemetryUtils.recordOperationMetrics() and attemptMetricsCallable() so all transports record metrics uniformly
• Remove the isHttpTransport field from RetryAndTraceDatastoreRpcDecorator and DatastoreImpl; remove buildMetricsTracerFactory() from GrpcDatastoreRpc
• Update TelemetryConstants with the new METRIC_PREFIX, DATASTORE_METER_NAME, and typed AttributeKey constants needed by the new recorder classes
• Update DatastoreOptions to pass the full DatastoreOptions to getInstance() so the recorder factory can inspect credentials and project at creation time

Add a default-on, private OpenTelemetry SDK pipeline that automatically exports Datastore client-side metrics to Google Cloud Monitoring without requiring any user configuration.

Key additions:

• DatastoreBuiltInMetricsView: registers OTel views for metric renaming (GAX prefix → custom.googleapis.com/internal/client), custom histogram bucket boundaries, and an attribute allowlist that prevents unexpected labels from reaching Cloud Monitoring
• DatastoreCloudMonitoringExporter: MetricExporter impl that batches TimeSeries and calls MetricServiceClient.createTimeSeries(); graceful degradation (logs warnings, never crashes); best-effort flush()
• DatastoreCloudMonitoringExporterUtils: converts OTel MetricData to Cloud Monitoring TimeSeries protos
• BuiltInDatastoreMetricsProvider: creates a private OpenTelemetrySdk per Datastore client; computes stable client_uid and client_name attributes; registers a shutdown hook as a last-resort safety net
• CompositeDatastoreMetricsRecorder: fans out all record*() calls to both the built-in and any user-provided backends simultaneously
• DatastoreMetricsRecorder.getInstance(): updated to composite factory that wires up the built-in path (unless emulator or env-var disabled) alongside any custom OTel backend; adds default close() for lifecycle
• OpenTelemetryDatastoreMetricsRecorder: add ownsOpenTelemetry flag and close() so the built-in SDK is flushed when DatastoreImpl.close() runs
• DatastoreOpenTelemetryOptions: add exportBuiltinMetricsToGoogleCloudMonitoring flag (default true) with @BetaApi getter and setter; clarify isEnabled() Javadoc to note it does not cover the built-in path
• DatastoreImpl.close(): call getMetricsRecorder().close() after RPC channel teardown so the built-in SDK flushes buffered metrics
• pom.xml: promote opentelemetry-sdk, opentelemetry-sdk-common, and opentelemetry-sdk-metrics from test→compile scope; add google-cloud-monitoring and proto-google-cloud-monitoring-v3 compile deps
• New tests: DatastoreCloudMonitoringExporterTest, BuiltInDatastoreMetricsProviderTest, DatastoreMetricsRecorderTest (updated), DatastoreBuiltInAndCustomMetricsIT

…ne after impl-1 refactor

Add DatastoreMetricsSample demonstrating default built-in metrics with no configuration required. The sample runs a transaction flow (put, read-modify-write, delete) that exercises transaction_latency and transaction_attempt_count metrics, then prints instructions for verifying the data in Cloud Monitoring Metrics Explorer.

Includes DatastoreMetricsSampleIT which runs against a real GCP project (GOOGLE_CLOUD_PROJECT env var required) and asserts the expected console output from the sample.

Add DatastoreMetricsSample demonstrating default built-in metrics with no configuration required. The sample runs a transaction flow (put, read-modify-write, delete) that exercises transaction_latency and transaction_attempt_count metrics, then prints instructions for verifying the data in Cloud Monitoring Metrics Explorer.

Includes DatastoreMetricsSampleIT which runs against a real GCP project (GOOGLE_CLOUD_PROJECT env var required) and asserts the expected console output from the sample.

[](/apps/gemini-code-assist)

lqiu96 marked this pull request as ready for review

April 10, 2026 22:01

… signature, and format changes

lqiu96 changed the titlechore: Implement Default Client Side Metrics Otel feat(Datastore): Introduce Client Side Metrics

Apr 29, 2026

lqiu96 deleted the datastore-csm-impl-2 branch

April 29, 2026 22:56

This was referenced

Apr 30, 2026

jinseopkim0 added a commit that referenced this pull request

May 5, 2026

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})