Skip to content
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.

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

feat: Add FirestoreOpenTelemetryOptions to FirestoreOptions. #1531

Merged
merged 2 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion google-cloud-firestore/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,13 @@
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java-util</artifactId>
</dependency>

<!-- OpenTelemetry -->
ehsannas marked this conversation as resolved.
Show resolved Hide resolved
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-api</artifactId>
<version>1.29.0</version>
</dependency>
<!-- END OpenTelemetry -->

<!-- Test dependencies -->
<dependency>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.google.cloud.firestore;

import io.opentelemetry.api.OpenTelemetry;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class FirestoreOpenTelemetryOptions {
private final boolean enabled;

private final @Nullable OpenTelemetry openTelemetry;

FirestoreOpenTelemetryOptions(Builder builder) {
this.enabled = builder.enabled;
this.openTelemetry = builder.openTelemetry;
}

public boolean getEnabled() {
return enabled;
}

public OpenTelemetry getOpenTelemetry() {
return openTelemetry;
}

@Nonnull
public FirestoreOpenTelemetryOptions.Builder toBuilder() {
return new FirestoreOpenTelemetryOptions.Builder(this);
}

@Nonnull
public static FirestoreOpenTelemetryOptions.Builder newBuilder() {
return new FirestoreOpenTelemetryOptions.Builder();
}

public static class Builder {

private boolean enabled;

@Nullable private OpenTelemetry openTelemetry;

private Builder() {
enabled = false;
kolea2 marked this conversation as resolved.
Show resolved Hide resolved
openTelemetry = null;
}

private Builder(FirestoreOpenTelemetryOptions options) {
this.enabled = options.enabled;
this.openTelemetry = options.openTelemetry;
}

@Nonnull
public FirestoreOpenTelemetryOptions build() {
return new FirestoreOpenTelemetryOptions(this);
}

/**
* Sets whether tracing should be enabled.
*
* @param enable Whether tracing should be enabled.
*/
@Nonnull
public FirestoreOpenTelemetryOptions.Builder setTracingEnabled(boolean enable) {
this.enabled = enable;
return this;
}

/**
* Sets the {@link OpenTelemetry} to use with this Firestore instance. If telemetry collection
* is enabled, but an `OpenTelemetry` is not provided, the Firestore SDK will attempt to use the
* `GlobalOpenTelemetry`.
*
* @param openTelemetry The OpenTelemetry that should be used by this Firestore instance.
*/
@Nonnull
public FirestoreOpenTelemetryOptions.Builder setOpenTelemetry(
@Nonnull OpenTelemetry openTelemetry) {
this.openTelemetry = openTelemetry;
return this;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package com.google.cloud.firestore;

import com.google.api.core.BetaApi;
import com.google.api.core.InternalApi;
import com.google.api.gax.core.CredentialsProvider;
import com.google.api.gax.core.FixedCredentialsProvider;
Expand Down Expand Up @@ -60,6 +61,7 @@ public final class FirestoreOptions extends ServiceOptions<Firestore, FirestoreO
private final TransportChannelProvider channelProvider;
private final CredentialsProvider credentialsProvider;
private final String emulatorHost;
private final @Nonnull FirestoreOpenTelemetryOptions openTelemetryOptions;

public static class DefaultFirestoreFactory implements FirestoreFactory {

Expand Down Expand Up @@ -118,12 +120,19 @@ public String getEmulatorHost() {
return emulatorHost;
}

@BetaApi
@Nonnull
public FirestoreOpenTelemetryOptions getOpenTelemetryOptions() {
return openTelemetryOptions;
}

public static class Builder extends ServiceOptions.Builder<Firestore, FirestoreOptions, Builder> {

@Nullable private String databaseId = null;
@Nullable private TransportChannelProvider channelProvider = null;
@Nullable private CredentialsProvider credentialsProvider = null;
@Nullable private String emulatorHost = null;
@Nullable private FirestoreOpenTelemetryOptions openTelemetryOptions = null;

private Builder() {}

Expand All @@ -133,6 +142,7 @@ private Builder(FirestoreOptions options) {
this.channelProvider = options.channelProvider;
this.credentialsProvider = options.credentialsProvider;
this.emulatorHost = options.emulatorHost;
this.openTelemetryOptions = options.openTelemetryOptions;
}

/**
Expand Down Expand Up @@ -201,6 +211,19 @@ public Builder setDatabaseId(@Nonnull String databaseId) {
return this;
}

/**
* Sets the {@link FirestoreOpenTelemetryOptions} to be used for this Firestore instance.
*
* @param openTelemetryOptions The `FirestoreOpenTelemetryOptions` to use.
*/
@BetaApi
@Nonnull
public Builder setOpenTelemetryOptions(
@Nonnull FirestoreOpenTelemetryOptions openTelemetryOptions) {
this.openTelemetryOptions = openTelemetryOptions;
return this;
}

@Override
@Nonnull
public FirestoreOptions build() {
Expand Down Expand Up @@ -278,6 +301,13 @@ public void refresh() {}
protected FirestoreOptions(Builder builder) {
super(FirestoreFactory.class, FirestoreRpcFactory.class, builder, new FirestoreDefaults());

// FirestoreOptions must contain non-null open-telemetry options.
// If the builder doesn't have any open-telemetry options, use a default (disabled) one.
this.openTelemetryOptions =
builder.openTelemetryOptions != null
? builder.openTelemetryOptions
: FirestoreOpenTelemetryOptions.newBuilder().build();

this.databaseId =
builder.databaseId != null
? builder.databaseId
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.google.cloud.firestore;

import static com.google.common.truth.Truth.assertThat;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.OpenTelemetry;
import javax.annotation.Nullable;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

public class OpenTelemetryOptionsTest {
@Nullable private Firestore firestore;

@Before
public void setUp() {
GlobalOpenTelemetry.resetForTest();
}

@After
public void tearDown() {
if (firestore != null) {
firestore.shutdown();
firestore = null;
}
}

FirestoreOptions.Builder getBaseOptions() {
return FirestoreOptions.newBuilder().setProjectId("test-project").setDatabaseId("(default)");
}

@Test
public void defaultOptionsDisablesTelemetryCollection() {
FirestoreOptions firestoreOptions = getBaseOptions().build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry()).isNull();
}

@Test
public void canEnableTelemetryCollectionWithoutOpenTelemetryInstance() {
FirestoreOptions firestoreOptions =
getBaseOptions()
.setOpenTelemetryOptions(
FirestoreOpenTelemetryOptions.newBuilder().setTracingEnabled(true).build())
.build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isTrue();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry()).isNull();
ehsannas marked this conversation as resolved.
Show resolved Hide resolved
}

@Test
public void canEnableTelemetryCollectionWithOpenTelemetryInstance() {
OpenTelemetry openTelemetry = GlobalOpenTelemetry.get();
FirestoreOptions firestoreOptions =
getBaseOptions()
.setOpenTelemetryOptions(
FirestoreOpenTelemetryOptions.newBuilder()
.setTracingEnabled(true)
.setOpenTelemetry(openTelemetry)
.build())
.build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isTrue();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry())
.isEqualTo(openTelemetry);
}

@Test
public void canDisableTelemetryCollectionWhileOpenTelemetryInstanceIsNotNull() {
OpenTelemetry openTelemetry = GlobalOpenTelemetry.get();
FirestoreOptions firestoreOptions =
getBaseOptions()
.setOpenTelemetryOptions(
FirestoreOpenTelemetryOptions.newBuilder()
.setTracingEnabled(false)
.setOpenTelemetry(openTelemetry)
.build())
.build();
firestore = firestoreOptions.getService();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getEnabled()).isFalse();
assertThat(firestore.getOptions().getOpenTelemetryOptions().getOpenTelemetry())
.isEqualTo(openTelemetry);
}
}
Loading