Skip to content

Commit 6dcef87

Browse files
authored
chore: Rename otel classes (#12699)
Rename Otel classes so they are easier to understand by customers. Notable changes of the public classes: - SpanTracerFactory -> OpenTelemetryTracingFactory - GoldenMetricsTracerFactory -> OpenTelemetryMetricsFactory
1 parent dc70f8e commit 6dcef87

File tree

12 files changed

+193
-185
lines changed

12 files changed

+193
-185
lines changed

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerFactory.java renamed to sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryMetricsFactory.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@
3434
import io.opentelemetry.api.OpenTelemetry;
3535

3636
/**
37-
* A {@link ApiTracerFactory} to build instances of {@link GoldenSignalsMetricsTracer}.
37+
* A {@link ApiTracerFactory} to build instances of {@link OpenTelemetryMetricsTracer}.
3838
*
3939
* <p>This class is expected to be initialized once during client initialization.
4040
*/
4141
@BetaApi
4242
@InternalApi
43-
public class GoldenSignalsMetricsTracerFactory implements ApiTracerFactory {
43+
public class OpenTelemetryMetricsFactory implements ApiTracerFactory {
4444

4545
private ApiTracerContext clientLevelTracerContext;
4646
private final OpenTelemetry openTelemetry;
4747
private GoldenSignalsMetricsRecorder metricsRecorder;
4848

49-
public GoldenSignalsMetricsTracerFactory(OpenTelemetry openTelemetry) {
49+
public OpenTelemetryMetricsFactory(OpenTelemetry openTelemetry) {
5050
this.openTelemetry = openTelemetry;
5151
this.clientLevelTracerContext = ApiTracerContext.empty();
5252
}
@@ -58,7 +58,7 @@ public ApiTracer newTracer(ApiTracer parent, SpanName spanName, OperationType op
5858
// regular requests.
5959
return new BaseApiTracer();
6060
}
61-
return new GoldenSignalsMetricsTracer(metricsRecorder, clientLevelTracerContext);
61+
return new OpenTelemetryMetricsTracer(metricsRecorder, clientLevelTracerContext);
6262
}
6363

6464
@Override
@@ -69,7 +69,7 @@ public ApiTracer newTracer(ApiTracer parent, ApiTracerContext methodLevelTracerC
6969
return new BaseApiTracer();
7070
}
7171
ApiTracerContext mergedTracerContext = clientLevelTracerContext.merge(methodLevelTracerContext);
72-
return new GoldenSignalsMetricsTracer(metricsRecorder, mergedTracerContext);
72+
return new OpenTelemetryMetricsTracer(metricsRecorder, mergedTracerContext);
7373
}
7474

7575
@Override

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracer.java renamed to sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryMetricsTracer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@
4343
* GoldenSignalsMetricsRecorder}, hence this class should not have any knowledge about the
4444
* observability framework (e.g. OpenTelemetry).
4545
*/
46-
class GoldenSignalsMetricsTracer implements ApiTracer {
46+
class OpenTelemetryMetricsTracer implements ApiTracer {
4747
private final Stopwatch clientRequestTimer;
4848
private final GoldenSignalsMetricsRecorder metricsRecorder;
4949
private final Map<String, Object> attributes;
5050
private final ApiTracerContext.Transport transport;
5151

52-
GoldenSignalsMetricsTracer(
52+
OpenTelemetryMetricsTracer(
5353
GoldenSignalsMetricsRecorder metricsRecorder, ApiTracerContext apiTracerContext) {
5454
this.clientRequestTimer = Stopwatch.createStarted();
5555
this.metricsRecorder = metricsRecorder;
@@ -58,7 +58,7 @@ class GoldenSignalsMetricsTracer implements ApiTracer {
5858
}
5959

6060
@VisibleForTesting
61-
GoldenSignalsMetricsTracer(
61+
OpenTelemetryMetricsTracer(
6262
GoldenSignalsMetricsRecorder metricsRecorder,
6363
ApiTracerContext apiTracerContext,
6464
Ticker ticker) {

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java renamed to sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTracingFactory.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,32 +39,32 @@
3939
import io.opentelemetry.api.trace.Tracer;
4040

4141
/**
42-
* A {@link ApiTracerFactory} to build instances of {@link SpanTracer}.
42+
* A {@link ApiTracerFactory} to build instances of {@link OpenTelemetryTracingTracer}.
4343
*
44-
* <p>This class wraps the {@link Tracer} and pass it to {@link SpanTracer}. It will be used to
45-
* record traces in {@link SpanTracer}.
44+
* <p>This class wraps the {@link Tracer} and pass it to {@link OpenTelemetryTracingTracer}. It will
45+
* be used to record traces in {@link OpenTelemetryTracingTracer}.
4646
*
4747
* <p>This class is expected to be initialized once during client initialization.
4848
*/
4949
@BetaApi
5050
@InternalApi
51-
public class SpanTracerFactory implements ApiTracerFactory {
51+
public class OpenTelemetryTracingFactory implements ApiTracerFactory {
5252
private final Tracer tracer;
5353
private final OpenTelemetry openTelemetry;
5454
private final ApiTracerContext apiTracerContext;
5555

56-
/** Creates a SpanTracerFactory */
57-
public SpanTracerFactory(OpenTelemetry openTelemetry) {
56+
public OpenTelemetryTracingFactory(OpenTelemetry openTelemetry) {
5857
this(openTelemetry, null, ApiTracerContext.empty());
5958
}
6059

6160
/**
62-
* Pass in a Map of client level attributes which will be added to every single SpanTracer created
63-
* from the ApiTracerFactory. This is package private since span attributes are determined
64-
* internally.
61+
* Pass in a Map of client level attributes which will be added to every single
62+
* OpenTelemetryTracingTracer created from the ApiTracerFactory. This is package private since
63+
* span attributes are determined internally.
6564
*/
6665
@VisibleForTesting
67-
SpanTracerFactory(OpenTelemetry openTelemetry, Tracer tracer, ApiTracerContext apiTracerContext) {
66+
OpenTelemetryTracingFactory(
67+
OpenTelemetry openTelemetry, Tracer tracer, ApiTracerContext apiTracerContext) {
6868
this.openTelemetry = openTelemetry;
6969
this.tracer = tracer;
7070
this.apiTracerContext = apiTracerContext;
@@ -80,7 +80,7 @@ public ApiTracer newTracer(ApiTracer parent, SpanName spanName, OperationType op
8080
// feature is developed.
8181
String attemptSpanName = spanName.getClientName() + "/" + spanName.getMethodName() + "/attempt";
8282

83-
return new SpanTracer(tracer, this.apiTracerContext, attemptSpanName);
83+
return new OpenTelemetryTracingTracer(tracer, this.apiTracerContext, attemptSpanName);
8484
}
8585

8686
@Override
@@ -90,7 +90,7 @@ public ApiTracer newTracer(ApiTracer parent, ApiTracerContext apiTracerContext)
9090
return new BaseApiTracer();
9191
}
9292
ApiTracerContext mergedContext = this.apiTracerContext.merge(apiTracerContext);
93-
return new SpanTracer(tracer, mergedContext);
93+
return new OpenTelemetryTracingTracer(tracer, mergedContext);
9494
}
9595

9696
@Override
@@ -99,8 +99,8 @@ public boolean needsContext() {
9999
}
100100

101101
/**
102-
* Returns a new SpanTracerFactory with the provided context. The Tracer is re-initialized using
103-
* the artifact name and version from the library metadata.
102+
* Returns a new OpenTelemetryTracingFactory with the provided context. The Tracer is
103+
* re-initialized using the artifact name and version from the library metadata.
104104
*/
105105
@Override
106106
public ApiTracerFactory withContext(ApiTracerContext context) {
@@ -113,6 +113,6 @@ public ApiTracerFactory withContext(ApiTracerContext context) {
113113
}
114114
Tracer newTracer = openTelemetry.getTracer(metadata.artifactName(), metadata.version());
115115
ApiTracerContext mergedContext = this.apiTracerContext.merge(context);
116-
return new SpanTracerFactory(openTelemetry, newTracer, mergedContext);
116+
return new OpenTelemetryTracingFactory(openTelemetry, newTracer, mergedContext);
117117
}
118118
}

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java renamed to sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTracingTracer.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
/** An implementation of {@link ApiTracer} that uses OpenTelemetry to record traces. */
4545
@BetaApi
4646
@InternalApi
47-
public class SpanTracer implements ApiTracer {
47+
class OpenTelemetryTracingTracer implements ApiTracer {
4848

4949
static final String CONTENT_LENGTH_KEY = "Content-Length";
5050

@@ -72,12 +72,12 @@ public void injectTraceContext(java.util.Map<String, String> carrier) {
7272
}
7373

7474
/**
75-
* Creates a new instance of {@code SpanTracer}.
75+
* Creates a new instance of {@code OpenTelemetryTracingTracer}.
7676
*
7777
* @param tracer the {@link Tracer} to use for recording spans
7878
* @param apiTracerContext the {@link ApiTracerContext} to use for recording spans
7979
*/
80-
public SpanTracer(Tracer tracer, ApiTracerContext apiTracerContext) {
80+
OpenTelemetryTracingTracer(Tracer tracer, ApiTracerContext apiTracerContext) {
8181
this.tracer = tracer;
8282
this.apiTracerContext = apiTracerContext;
8383
this.attemptSpanName = resolveAttemptSpanName(apiTracerContext);
@@ -86,14 +86,16 @@ public SpanTracer(Tracer tracer, ApiTracerContext apiTracerContext) {
8686
}
8787

8888
/**
89-
* Creates a new instance of {@code SpanTracer} with an explicitly provided span name.
89+
* Creates a new instance of {@code OpenTelemetryTracingTracer} with an explicitly provided span
90+
* name.
9091
*
9192
* @param tracer the {@link Tracer} to use for recording spans
9293
* @param apiTracerContext the {@link ApiTracerContext} to use for recording spans
9394
* @param attemptSpanName the name of the individual attempt spans
9495
*/
9596
@InternalApi
96-
SpanTracer(Tracer tracer, ApiTracerContext apiTracerContext, String attemptSpanName) {
97+
OpenTelemetryTracingTracer(
98+
Tracer tracer, ApiTracerContext apiTracerContext, String attemptSpanName) {
9799
this.tracer = tracer;
98100
this.attemptSpanName = attemptSpanName;
99101
this.apiTracerContext = apiTracerContext;

sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerFactoryTest.java renamed to sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/OpenTelemetryMetricsFactoryTest.java

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@
3838
import org.junit.jupiter.api.BeforeEach;
3939
import org.junit.jupiter.api.Test;
4040

41-
class GoldenSignalsMetricsTracerFactoryTest {
41+
class OpenTelemetryMetricsFactoryTest {
4242

43-
private GoldenSignalsMetricsTracerFactory tracerFactory;
43+
private OpenTelemetryMetricsFactory tracerFactory;
4444

4545
@BeforeEach
4646
void setUp() {
47-
tracerFactory = new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
47+
tracerFactory = new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
4848
}
4949

5050
@Test
@@ -56,7 +56,7 @@ void newTracerWithSpanName_shouldCreateTracer_ifMetricsRecorderIsNotNull() {
5656
ApiTracer actual =
5757
tracerFactory.newTracer(
5858
mock(ApiTracer.class), mock(SpanName.class), ApiTracerFactory.OperationType.Unary);
59-
assertThat(actual).isInstanceOf(GoldenSignalsMetricsTracer.class);
59+
assertThat(actual).isInstanceOf(OpenTelemetryMetricsTracer.class);
6060
}
6161

6262
@Test
@@ -80,29 +80,26 @@ void newTracerWithApiTracerContext_shouldMergeApiTracerContext() {
8080
ApiTracer actual = tracerFactory.newTracer(mock(ApiTracer.class), methodLevelTracerContext);
8181

8282
verify(clientLevelTracerContext).merge(methodLevelTracerContext);
83-
assertThat(actual).isInstanceOf(GoldenSignalsMetricsTracer.class);
83+
assertThat(actual).isInstanceOf(OpenTelemetryMetricsTracer.class);
8484
}
8585

8686
@Test
8787
void testWithContext_nullContext_returnsBaseApiTracerFactory() {
88-
GoldenSignalsMetricsTracerFactory factory =
89-
new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
88+
OpenTelemetryMetricsFactory factory = new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
9089
ApiTracerFactory factoryWithContext = factory.withContext(null);
9190
assertThat(factoryWithContext).isInstanceOf(BaseApiTracerFactory.class);
9291
}
9392

9493
@Test
9594
void testWithContext_nullMetadata_returnsBaseApiTracerFactory() {
96-
GoldenSignalsMetricsTracerFactory factory =
97-
new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
95+
OpenTelemetryMetricsFactory factory = new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
9896
ApiTracerFactory factoryWithContext = factory.withContext(ApiTracerContext.empty());
9997
assertThat(factoryWithContext).isInstanceOf(BaseApiTracerFactory.class);
10098
}
10199

102100
@Test
103101
void testWithContext_emptyArtifactName_returnsBaseApiTracerFactory() {
104-
GoldenSignalsMetricsTracerFactory factory =
105-
new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
102+
OpenTelemetryMetricsFactory factory = new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
106103
LibraryMetadata metadata =
107104
LibraryMetadata.newBuilder().setArtifactName("").setVersion("1.0").build();
108105
ApiTracerContext context = ApiTracerContext.newBuilder().setLibraryMetadata(metadata).build();
@@ -113,8 +110,7 @@ void testWithContext_emptyArtifactName_returnsBaseApiTracerFactory() {
113110

114111
@Test
115112
void testWithContext_nullArtifactName_returnsBaseApiTracerFactory() {
116-
GoldenSignalsMetricsTracerFactory factory =
117-
new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
113+
OpenTelemetryMetricsFactory factory = new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
118114
LibraryMetadata metadata = LibraryMetadata.newBuilder().setVersion("1.0").build();
119115
ApiTracerContext context = ApiTracerContext.newBuilder().setLibraryMetadata(metadata).build();
120116

@@ -124,17 +120,16 @@ void testWithContext_nullArtifactName_returnsBaseApiTracerFactory() {
124120

125121
@Test
126122
void newTracerWithApiTracerContext_shouldCreateBaseTracer_ifMetricsRecorderIsNull() {
127-
GoldenSignalsMetricsTracerFactory factory =
128-
new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
123+
OpenTelemetryMetricsFactory factory = new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
129124
ApiTracer actual = factory.newTracer(mock(ApiTracer.class), mock(ApiTracerContext.class));
130125

131126
assertThat(actual).isInstanceOf(BaseApiTracer.class);
132127
}
133128

134129
@Test
135130
void testNeedsContext_returnsTrueWhenContextIsEmpty() {
136-
GoldenSignalsMetricsTracerFactory factoryWithoutContext =
137-
new GoldenSignalsMetricsTracerFactory(OpenTelemetry.noop());
131+
OpenTelemetryMetricsFactory factoryWithoutContext =
132+
new OpenTelemetryMetricsFactory(OpenTelemetry.noop());
138133

139134
assertThat(factoryWithoutContext.needsContext()).isTrue();
140135
}

sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/GoldenSignalsMetricsTracerTest.java renamed to sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/OpenTelemetryMetricsTracerTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@
4848
import org.junit.jupiter.api.BeforeEach;
4949
import org.junit.jupiter.api.Test;
5050

51-
class GoldenSignalsMetricsTracerTest {
51+
class OpenTelemetryMetricsTracerTest {
5252
private static final String ARTIFACT_NAME = "test-library";
5353
public static final int TEST_REQUEST_DURATION_NANO = 2345698;
5454
public static final double EXPECTED_REQUEST_DURATION_SECOND = 2345698 / 1_000_000_000.0;
5555

5656
private InMemoryMetricReader metricReader;
5757

58-
private GoldenSignalsMetricsTracer tracer;
58+
private OpenTelemetryMetricsTracer tracer;
5959

6060
private FakeTicker ticker;
6161

@@ -68,7 +68,7 @@ void setUp() {
6868
OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build();
6969
ticker = new FakeTicker();
7070
tracer =
71-
new GoldenSignalsMetricsTracer(
71+
new OpenTelemetryMetricsTracer(
7272
GoldenSignalsMetricsRecorder.create(
7373
openTelemetry,
7474
LibraryMetadata.newBuilder()

0 commit comments

Comments
 (0)