Skip to content

feat(datastore): Enable Otel metrics for custom Otel #12969

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
lqiu96 merged 10 commits into from
Apr 30, 2026
Merged

feat(datastore): Enable Otel metrics for custom Otel #12969

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cc35a55
fix(datastore): restore fallback to GlobalOpenTelemetry in DatastoreO…
lqiu96 Apr 30, 2026
342315c
chore(datastore): address remaining PR feedback on open-datastore-met…
lqiu96 Apr 30, 2026
172f1d6
chore: Address PR feedback
lqiu96 Apr 30, 2026
e538446
test(datastore): add tests for new updates in DatastoreOpenTelemetryO…
lqiu96 Apr 30, 2026
c530724
test(datastore): add tests for mixed enabled telemetry signals
lqiu96 Apr 30, 2026
51c1a3f
test(datastore): add test for mixed metrics and cloud monitoring in D…
lqiu96 Apr 30, 2026
853913a
chore: Improve the javadoc for getOtel()
lqiu96 Apr 30, 2026
38396bb
fix(datastore): move fallback logic to getOpenTelemetry to avoid earl…
lqiu96 Apr 30, 2026
353f41e
fix(datastore): check for NoOp instance in TraceUtil and MetricsRecorder
lqiu96 Apr 30, 2026
c80d88b
fix(datastore): finalize fallback to GlobalOpenTelemetry when NoOp is…
lqiu96 Apr 30, 2026
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
19 changes: 11 additions & 8 deletions ...oud-datastore/src/main/java/com/google/cloud/datastore/DatastoreOpenTelemetryOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
package com.google.cloud.datastore;

import com.google.api.core.BetaApi;
import com.google.common.base.Preconditions;
import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.OpenTelemetry;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* Represents the options that are used to configure the use of OpenTelemetry for telemetry
Expand All @@ -29,7 +30,7 @@ public class DatastoreOpenTelemetryOptions {
private final boolean tracingEnabled;
private final boolean metricsEnabled;
private final boolean exportBuiltinMetricsToGoogleCloudMonitoring;
private final @Nullable OpenTelemetry openTelemetry;
private final OpenTelemetry openTelemetry;

DatastoreOpenTelemetryOptions(Builder builder) {
this.tracingEnabled = builder.tracingEnabled;
Expand Down Expand Up @@ -92,7 +93,7 @@ public boolean isExportBuiltinMetricsToGoogleCloudMonitoring() {
*
* @return the custom {@link OpenTelemetry} instance, or {@code null} if none was provided.
*/
@Nullable
@Nonnull
Comment thread
lqiu96 marked this conversation as resolved.
public OpenTelemetry getOpenTelemetry() {
return openTelemetry;
}
Expand Down Expand Up @@ -123,7 +124,7 @@ public static class Builder {
private boolean metricsEnabled;
private boolean exportBuiltinMetricsToGoogleCloudMonitoring;

@Nullable private OpenTelemetry openTelemetry;
private OpenTelemetry openTelemetry;

private Builder() {
tracingEnabled = false;
Expand Down Expand Up @@ -159,8 +160,8 @@ public DatastoreOpenTelemetryOptions.Builder setTracingEnabled(boolean enabled)
* @param enabled Whether metrics should be enabled.
* @return this builder instance.
*/
@Nonnull
DatastoreOpenTelemetryOptions.Builder setMetricsEnabled(boolean enabled) {
@BetaApi
public DatastoreOpenTelemetryOptions.Builder setMetricsEnabled(boolean enabled) {
this.metricsEnabled = enabled;
return this;
}
Expand Down Expand Up @@ -191,8 +192,8 @@ public DatastoreOpenTelemetryOptions.Builder setExportBuiltinMetricsToGoogleClou
* @return this builder instance.
*/
@Nonnull
public DatastoreOpenTelemetryOptions.Builder setOpenTelemetry(
@Nonnull OpenTelemetry openTelemetry) {
public DatastoreOpenTelemetryOptions.Builder setOpenTelemetry(OpenTelemetry openTelemetry) {
Preconditions.checkNotNull(openTelemetry, "Custom Otel Instance cannot be null");
Comment thread
lqiu96 marked this conversation as resolved.
Outdated
this.openTelemetry = openTelemetry;
return this;
}
Expand All @@ -204,6 +205,8 @@ public DatastoreOpenTelemetryOptions.Builder setOpenTelemetry(
*/
@Nonnull
public DatastoreOpenTelemetryOptions build() {
// If no custom Otel was provided, fall back to using GlobalOpenTelemetry.
this.openTelemetry = openTelemetry == null ? GlobalOpenTelemetry.get() : openTelemetry;
Comment thread
lqiu96 marked this conversation as resolved.
Outdated
return new DatastoreOpenTelemetryOptions(this);
}
}
Expand Down
3 changes: 0 additions & 3 deletions ...atastore/src/main/java/com/google/cloud/datastore/telemetry/DatastoreMetricsRecorder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,6 @@ static DatastoreMetricsRecorder getInstance(
// Note: Metrics will not be sent if an emulator is enabled.
if (otelOptions.isMetricsEnabled()) {
OpenTelemetry customOtel = otelOptions.getOpenTelemetry();
if (customOtel == null) {
customOtel = GlobalOpenTelemetry.get();
}
recorders.add(
new OpenTelemetryDatastoreMetricsRecorder(customOtel, TelemetryConstants.METRIC_PREFIX));
}
Expand Down
11 changes: 1 addition & 10 deletions ...-cloud-datastore/src/main/java/com/google/cloud/datastore/telemetry/EnabledTraceUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
import com.google.cloud.datastore.telemetry.TraceUtil.Span;
import com.google.common.base.Throwables;
import io.grpc.ManagedChannelBuilder;
import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
Expand All @@ -51,16 +50,8 @@ public class EnabledTraceUtil implements TraceUtil {
private final DatastoreOptions datastoreOptions;

EnabledTraceUtil(DatastoreOptions datastoreOptions) {
OpenTelemetry openTelemetry = datastoreOptions.getOpenTelemetryOptions().getOpenTelemetry();

// If tracing is enabled, but an OpenTelemetry instance is not provided, fall back
// to using GlobalOpenTelemetry.
if (openTelemetry == null) {
openTelemetry = GlobalOpenTelemetry.get();
}

this.datastoreOptions = datastoreOptions;
this.openTelemetry = openTelemetry;
this.openTelemetry = datastoreOptions.getOpenTelemetryOptions().getOpenTelemetry();
this.tracer = openTelemetry.getTracer(LIBRARY_NAME);
}

Expand Down
34 changes: 0 additions & 34 deletions ...ore/src/test/java/com/google/cloud/datastore/DatastoreOpenTelemetryOptionsTestHelper.java
View file
Open in desktop

This file was deleted.

13 changes: 9 additions & 4 deletions ...e/ITDatastoreBuiltInAndCustomMetrics.java → ...tore/it/ITDatastoreClientSideMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,18 @@
* limitations under the License.
*/

package com.google.cloud.datastore;
package com.google.cloud.datastore.it;

import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
import static org.junit.Assume.assumeNotNull;

import com.google.cloud.TransportOptions;
import com.google.cloud.datastore.Datastore;
import com.google.cloud.datastore.DatastoreOpenTelemetryOptions;
import com.google.cloud.datastore.DatastoreOptions;
import com.google.cloud.datastore.Entity;
import com.google.cloud.datastore.Key;
import com.google.cloud.datastore.telemetry.TelemetryConstants;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.http.HttpTransportOptions;
Expand Down Expand Up @@ -59,16 +64,15 @@
*/
@RunWith(Parameterized.class)
@SuppressWarnings("checkstyle:abbreviationaswordinname")
public class ITDatastoreBuiltInAndCustomMetrics {
public class ITDatastoreClientSideMetrics {

private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
private static final String DATABASE_ID =
System.getenv().getOrDefault("DATASTORE_DATABASE_ID", "");
private boolean isDatastoreClosed = false;

private final TransportOptions transportOptions;

public ITDatastoreBuiltInAndCustomMetrics(TransportOptions transportOptions) {
public ITDatastoreClientSideMetrics(TransportOptions transportOptions) {
this.transportOptions = transportOptions;
}

Expand Down Expand Up @@ -134,6 +138,7 @@ public void setUp() {

@After
public void tearDown() throws Exception {
boolean isDatastoreClosed = false;
Comment thread
lqiu96 marked this conversation as resolved.
Outdated
if (datastore != null && !isDatastoreClosed) {
Key key = datastore.newKeyFactory().setKind(kind).newKey("metrics-it-entity");
try {
Expand Down
Loading