Skip to content

Commit 117c279

Browse files
nareshznareshz
committed
Rename spanner tracing to end to end tracing
1 parent b3a6d31 commit 117c279

File tree

8 files changed

+60
-60
lines changed

8 files changed

+60
-60
lines changed

‎google-cloud-spanner/clirr-ignored-differences.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -695,11 +695,11 @@
695695
<method>boolean isEnableApiTracing()</method>
696696
</difference>
697697

698-
<!-- Added Spanner tracing option -->
698+
<!-- Added end to end tracing option -->
699699
<difference>
700700
<differenceType>7012</differenceType>
701701
<className>com/google/cloud/spanner/SpannerOptions$SpannerEnvironment</className>
702-
<method>boolean isEnableSpannerTracing()</method>
702+
<method>boolean isEnableEndToEndTracing()</method>
703703
</difference>
704704

705705
<!-- Added Built In Metrics option -->

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

+19-19
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ public class SpannerOptions extends ServiceOptions<Spanner, SpannerOptions> {
163163
private final boolean enableApiTracing;
164164
private final boolean enableBuiltInMetrics;
165165
private final boolean enableExtendedTracing;
166-
private final boolean enableSpannerTracing;
166+
private final boolean enableEndToEndTracing;
167167

168168
enum TracingFramework {
169169
OPEN_CENSUS,
@@ -671,7 +671,7 @@ protected SpannerOptions(Builder builder) {
671671
enableApiTracing = builder.enableApiTracing;
672672
enableExtendedTracing = builder.enableExtendedTracing;
673673
enableBuiltInMetrics = builder.enableBuiltInMetrics;
674-
enableSpannerTracing = builder.enableSpannerTracing;
674+
enableEndToEndTracing = builder.enableEndToEndTracing;
675675
}
676676

677677
/**
@@ -709,7 +709,7 @@ default boolean isEnableBuiltInMetrics() {
709709
return false;
710710
}
711711

712-
default boolean isEnableSpannerTracing() {
712+
default boolean isEnableEndToEndTracing() {
713713
return false;
714714
}
715715
}
@@ -726,8 +726,8 @@ private static class SpannerEnvironmentImpl implements SpannerEnvironment {
726726
private static final String SPANNER_ENABLE_EXTENDED_TRACING = "SPANNER_ENABLE_EXTENDED_TRACING";
727727
private static final String SPANNER_ENABLE_API_TRACING = "SPANNER_ENABLE_API_TRACING";
728728
private static final String SPANNER_ENABLE_BUILTIN_METRICS = "SPANNER_ENABLE_BUILTIN_METRICS";
729-
private static final String SPANNER_ENABLE_SPANNER_TRACING =
730-
"SPANNER_ENABLE_SPANNER_TRACING";
729+
private static final String SPANNER_ENABLE_END_TO_END_TRACING =
730+
"SPANNER_ENABLE_END_TO_END_TRACING";
731731

732732
private SpannerEnvironmentImpl() {}
733733

@@ -762,8 +762,8 @@ public boolean isEnableBuiltInMetrics() {
762762
}
763763

764764
@Override
765-
public boolean isEnableSpannerTracing() {
766-
return Boolean.parseBoolean(System.getenv(SPANNER_ENABLE_SPANNER_TRACING));
765+
public boolean isEnableEndToEndTracing() {
766+
return Boolean.parseBoolean(System.getenv(SPANNER_ENABLE_END_TO_END_TRACING));
767767
}
768768
}
769769

@@ -829,8 +829,8 @@ public static class Builder
829829
private boolean enableApiTracing = SpannerOptions.environment.isEnableApiTracing();
830830
private boolean enableExtendedTracing = SpannerOptions.environment.isEnableExtendedTracing();
831831
private boolean enableBuiltInMetrics = SpannerOptions.environment.isEnableBuiltInMetrics();
832-
private boolean enableSpannerTracing =
833-
SpannerOptions.environment.isEnableSpannerTracing();
832+
private boolean enableEndToEndTracing =
833+
SpannerOptions.environment.isEnableEndToEndTracing();
834834

835835
private static String createCustomClientLibToken(String token) {
836836
return token + " " + ServiceOptions.getGoogApiClientLibName();
@@ -897,7 +897,7 @@ protected Builder() {
897897
this.enableApiTracing = options.enableApiTracing;
898898
this.enableExtendedTracing = options.enableExtendedTracing;
899899
this.enableBuiltInMetrics = options.enableBuiltInMetrics;
900-
this.enableSpannerTracing = options.enableSpannerTracing;
900+
this.enableEndToEndTracing = options.enableEndToEndTracing;
901901
}
902902

903903
@Override
@@ -1432,13 +1432,13 @@ public Builder setEnableExtendedTracing(boolean enableExtendedTracing) {
14321432
}
14331433

14341434
/**
1435-
* Sets whether to enable Spanner tracing. Enabling this option will create the trace
1436-
* spans at the Spanner layer. By default, spanner tracing is disabled. Enabling spanner
1437-
* tracing requires OpenTelemetry to be set up properly. Simply enabling this option
1438-
* won't generate spanner traces.
1435+
* Sets whether to enable end to end tracing. Enabling this option will create the
1436+
* trace spans at the Spanner layer. By default, end to end tracing is disabled.
1437+
* Enabling end to end tracing requires OpenTelemetry to be set up properly. Simply
1438+
* enabling this option won't generate traces at Spanner layer.
14391439
*/
1440-
public Builder setEnableSpannerTracing(boolean enableSpannerTracing) {
1441-
this.enableSpannerTracing = enableSpannerTracing;
1440+
public Builder setEnableEndToEndTracing(boolean enableEndToEndTracing) {
1441+
this.enableEndToEndTracing = enableEndToEndTracing;
14421442
return this;
14431443
}
14441444

@@ -1774,11 +1774,11 @@ public boolean isEnableExtendedTracing() {
17741774
}
17751775

17761776
/**
1777-
* Returns whether Spanner tracing is enabled. If this option is enabled then trace spans
1777+
* Returns whether end to end tracing is enabled. If this option is enabled then trace spans
17781778
* will be created at the Spanner layer.
17791779
*/
1780-
public boolean isSpannerTracingEnabled() {
1781-
return enableSpannerTracing;
1780+
public boolean isEndToEndTracingEnabled() {
1781+
return enableEndToEndTracing;
17821782
}
17831783

17841784
/** Returns the default query options to use for the specific database. */

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ public class GapicSpannerRpc implements SpannerRpc {
272272
private static final ConcurrentMap<String, RateLimiter> ADMINISTRATIVE_REQUESTS_RATE_LIMITERS =
273273
new ConcurrentHashMap<>();
274274
private final boolean leaderAwareRoutingEnabled;
275-
private final boolean spannerTracingEnabled;
275+
private final boolean endToEndTracingEnabled;
276276
private final int numChannels;
277277
private final boolean isGrpcGcpExtensionEnabled;
278278

@@ -326,7 +326,7 @@ public GapicSpannerRpc(final SpannerOptions options) {
326326
this.callCredentialsProvider = options.getCallCredentialsProvider();
327327
this.compressorName = options.getCompressorName();
328328
this.leaderAwareRoutingEnabled = options.isLeaderAwareRoutingEnabled();
329-
this.spannerTracingEnabled = options.isSpannerTracingEnabled();
329+
this.endToEndTracingEnabled = options.isEndToEndTracingEnabled();
330330
this.numChannels = options.getNumChannels();
331331
this.isGrpcGcpExtensionEnabled = options.isGrpcGcpExtensionEnabled();
332332

@@ -353,7 +353,7 @@ public GapicSpannerRpc(final SpannerOptions options) {
353353
options.getInterceptorProvider(),
354354
SpannerInterceptorProvider.createDefault(options.getOpenTelemetry())))
355355
// This sets the trace context headers.
356-
.withTraceContext(spannerTracingEnabled, options.getOpenTelemetry())
356+
.withTraceContext(endToEndTracingEnabled, options.getOpenTelemetry())
357357
// This sets the response compressor (Server -> Client).
358358
.withEncoding(compressorName))
359359
.setHeaderProvider(headerProviderWithUserAgent)
@@ -2011,8 +2011,8 @@ <ReqT, RespT> GrpcCallContext newCallContext(
20112011
if (routeToLeader && leaderAwareRoutingEnabled) {
20122012
context = context.withExtraHeaders(metadataProvider.newRouteToLeaderHeader());
20132013
}
2014-
if (spannerTracingEnabled) {
2015-
context = context.withExtraHeaders(metadataProvider.newSpannerTracingHeader());
2014+
if (endToEndTracingEnabled) {
2015+
context = context.withExtraHeaders(metadataProvider.newEndToEndTracingHeader());
20162016
}
20172017
if (callCredentialsProvider != null) {
20182018
CallCredentials callCredentials = callCredentialsProvider.getCallCredentials();

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerInterceptorProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ SpannerInterceptorProvider withEncoding(String encoding) {
7575
}
7676

7777
SpannerInterceptorProvider withTraceContext(
78-
boolean spannerTracingEnabled, OpenTelemetry openTelemetry) {
79-
if (spannerTracingEnabled) {
78+
boolean endToEndTracingEnabled, OpenTelemetry openTelemetry) {
79+
if (endToEndTracingEnabled) {
8080
return with(new TraceContextInterceptor(openTelemetry));
8181
}
8282
return this;

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerMetadataProvider.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,16 @@ class SpannerMetadataProvider {
3737
private final Map<Metadata.Key<String>, String> headers;
3838
private final String resourceHeaderKey;
3939
private static final String ROUTE_TO_LEADER_HEADER_KEY = "x-goog-spanner-route-to-leader";
40-
private static final String SPANNER_TRACING_HEADER_KEY = "x-goog-spanner-end-to-end-tracing";
40+
private static final String END_TO_END_TRACING_HEADER_KEY = "x-goog-spanner-end-to-end-tracing";
4141
private static final Pattern[] RESOURCE_TOKEN_PATTERNS = {
4242
Pattern.compile("^(?<headerValue>projects/[^/]*/instances/[^/]*/databases/[^/]*)(.*)?"),
4343
Pattern.compile("^(?<headerValue>projects/[^/]*/instances/[^/]*)(.*)?")
4444
};
4545

4646
private static final Map<String, List<String>> ROUTE_TO_LEADER_HEADER_MAP =
4747
ImmutableMap.of(ROUTE_TO_LEADER_HEADER_KEY, Collections.singletonList("true"));
48-
private static final Map<String, List<String>> SPANNER_TRACING_HEADER_MAP =
49-
ImmutableMap.of(SPANNER_TRACING_HEADER_KEY, Collections.singletonList("true"));
48+
private static final Map<String, List<String>> END_TO_END_TRACING_HEADER_MAP =
49+
ImmutableMap.of(END_TO_END_TRACING_HEADER_KEY, Collections.singletonList("true"));
5050

5151
private SpannerMetadataProvider(Map<String, String> headers, String resourceHeaderKey) {
5252
this.resourceHeaderKey = resourceHeaderKey;
@@ -92,8 +92,8 @@ Map<String, List<String>> newRouteToLeaderHeader() {
9292
return ROUTE_TO_LEADER_HEADER_MAP;
9393
}
9494

95-
Map<String, List<String>> newSpannerTracingHeader() {
96-
return SPANNER_TRACING_HEADER_MAP;
95+
Map<String, List<String>> newEndToEndTracingHeader() {
96+
return END_TO_END_TRACING_HEADER_MAP;
9797
}
9898

9999
private Map<Metadata.Key<String>, String> constructHeadersAsMetadata(

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/SpannerOptionsTest.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -737,21 +737,21 @@ public void testLeaderAwareRoutingEnablement() {
737737
}
738738

739739
@Test
740-
public void testSpannerTracingEnablement() {
740+
public void testEndToEndTracingEnablement() {
741741
// Test that end to end tracing is disabled by default.
742-
assertFalse(SpannerOptions.newBuilder().setProjectId("p").build().isSpannerTracingEnabled());
742+
assertFalse(SpannerOptions.newBuilder().setProjectId("p").build().isEndToEndTracingEnabled());
743743
assertTrue(
744744
SpannerOptions.newBuilder()
745745
.setProjectId("p")
746-
.setEnableSpannerTracing(true)
746+
.setEnableEndToEndTracing(true)
747747
.build()
748-
.isSpannerTracingEnabled());
748+
.isEndToEndTracingEnabled());
749749
assertFalse(
750750
SpannerOptions.newBuilder()
751751
.setProjectId("p")
752-
.setEnableSpannerTracing(false)
752+
.setEnableEndToEndTracing(false)
753753
.build()
754-
.isSpannerTracingEnabled());
754+
.isEndToEndTracingEnabled());
755755
}
756756

757757
@Test

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpcTest.java

+20-20
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ public class GapicSpannerRpcTest {
155155
private static String defaultUserAgent;
156156
private static Spanner spanner;
157157
private static boolean isRouteToLeader;
158-
private static boolean isSpannerTracing;
158+
private static boolean isEndToEndTracing;
159159
private static boolean isTraceContextPresent;
160160

161161
@Parameter public Dialect dialect;
@@ -215,16 +215,16 @@ public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
215215
Key.of(
216216
"x-goog-spanner-route-to-leader",
217217
Metadata.ASCII_STRING_MARSHALLER));
218-
String spannerTracingHeader =
218+
String endToEndTracingHeader =
219219
headers.get(
220220
Key.of(
221221
"x-goog-spanner-end-to-end-tracing",
222222
Metadata.ASCII_STRING_MARSHALLER));
223223
isRouteToLeader =
224224
(routeToLeaderHeader != null && routeToLeaderHeader.equals("true"));
225-
isSpannerTracing =
226-
(spannerTracingHeader != null
227-
&& spannerTracingHeader.equals("true"));
225+
isEndToEndTracing =
226+
(endToEndTracingHeader != null
227+
&& endToEndTracingHeader.equals("true"));
228228
}
229229
return Contexts.interceptCall(Context.current(), call, headers, next);
230230
}
@@ -248,7 +248,7 @@ public void reset() throws InterruptedException {
248248
server.awaitTermination();
249249
}
250250
isRouteToLeader = false;
251-
isSpannerTracing = false;
251+
isEndToEndTracing = false;
252252
isTraceContextPresent = false;
253253
}
254254

@@ -491,11 +491,11 @@ public void testNewCallContextWithRouteToLeaderHeaderAndLarDisabled() {
491491
}
492492

493493
@Test
494-
public void testNewCallContextWithSpannerTracingHeader() {
494+
public void testNewCallContextWithEndToEndTracingHeader() {
495495
SpannerOptions options =
496496
SpannerOptions.newBuilder()
497497
.setProjectId("some-project")
498-
.setEnableSpannerTracing(true)
498+
.setEnableEndToEndTracing(true)
499499
.build();
500500
GapicSpannerRpc rpc = new GapicSpannerRpc(options, false);
501501
GrpcCallContext callContext =
@@ -515,11 +515,11 @@ public void testNewCallContextWithSpannerTracingHeader() {
515515
}
516516

517517
@Test
518-
public void testNewCallContextWithoutSpannerTracingHeader() {
518+
public void testNewCallContextWithoutEndToEndTracingHeader() {
519519
SpannerOptions options =
520520
SpannerOptions.newBuilder()
521521
.setProjectId("some-project")
522-
.setEnableSpannerTracing(false)
522+
.setEnableEndToEndTracing(false)
523523
.build();
524524
GapicSpannerRpc rpc = new GapicSpannerRpc(options, false);
525525
GrpcCallContext callContext =
@@ -534,9 +534,9 @@ public void testNewCallContextWithoutSpannerTracingHeader() {
534534
}
535535

536536
@Test
537-
public void testSpannerTracingHeaderWithEnabledTracing() {
537+
public void testEndToEndTracingHeaderWithEnabledTracing() {
538538
final SpannerOptions options =
539-
createSpannerOptions().toBuilder().setEnableSpannerTracing(true).build();
539+
createSpannerOptions().toBuilder().setEnableEndToEndTracing(true).build();
540540
try (Spanner spanner = options.getService()) {
541541
final DatabaseClient databaseClient =
542542
spanner.getDatabaseClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"));
@@ -547,13 +547,13 @@ public void testSpannerTracingHeaderWithEnabledTracing() {
547547
return null;
548548
});
549549
}
550-
assertTrue(isSpannerTracing);
550+
assertTrue(isEndToEndTracing);
551551
}
552552

553553
@Test
554-
public void testSpannerTracingHeaderWithDisabledTracing() {
554+
public void testEndToEndTracingHeaderWithDisabledTracing() {
555555
final SpannerOptions options =
556-
createSpannerOptions().toBuilder().setEnableSpannerTracing(false).build();
556+
createSpannerOptions().toBuilder().setEnableEndToEndTracing(false).build();
557557
try (Spanner spanner = options.getService()) {
558558
final DatabaseClient databaseClient =
559559
spanner.getDatabaseClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"));
@@ -564,7 +564,7 @@ public void testSpannerTracingHeaderWithDisabledTracing() {
564564
return null;
565565
});
566566
}
567-
assertFalse(isSpannerTracing);
567+
assertFalse(isEndToEndTracing);
568568
}
569569

570570
@Test
@@ -639,7 +639,7 @@ public void testCustomUserAgent() {
639639
}
640640

641641
@Test
642-
public void testTraceContextHeaderWithOpenTelemetryAndSpannerTracingEnabled() {
642+
public void testTraceContextHeaderWithOpenTelemetryAndEndToEndTracingEnabled() {
643643
OpenTelemetry openTelemetry =
644644
OpenTelemetrySdk.builder()
645645
.setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))
@@ -650,7 +650,7 @@ public void testTraceContextHeaderWithOpenTelemetryAndSpannerTracingEnabled() {
650650
createSpannerOptions()
651651
.toBuilder()
652652
.setOpenTelemetry(openTelemetry)
653-
.setEnableSpannerTracing(true)
653+
.setEnableEndToEndTracing(true)
654654
.build();
655655
try (Spanner spanner = options.getService()) {
656656
final DatabaseClient databaseClient =
@@ -665,7 +665,7 @@ public void testTraceContextHeaderWithOpenTelemetryAndSpannerTracingEnabled() {
665665
}
666666

667667
@Test
668-
public void testTraceContextHeaderWithOpenTelemetryAndSpannerTracingDisabled() {
668+
public void testTraceContextHeaderWithOpenTelemetryAndEndToEndTracingDisabled() {
669669
OpenTelemetry openTelemetry =
670670
OpenTelemetrySdk.builder()
671671
.setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))
@@ -676,7 +676,7 @@ public void testTraceContextHeaderWithOpenTelemetryAndSpannerTracingDisabled() {
676676
createSpannerOptions()
677677
.toBuilder()
678678
.setOpenTelemetry(openTelemetry)
679-
.setEnableSpannerTracing(false)
679+
.setEnableEndToEndTracing(false)
680680
.build();
681681
try (Spanner spanner = options.getService()) {
682682
final DatabaseClient databaseClient =

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/spi/v1/SpannerMetadataProviderTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public void testNewRouteToLeaderHeader() {
9898
public void testNewEndToEndTracingHeader() {
9999
SpannerMetadataProvider metadataProvider =
100100
SpannerMetadataProvider.create(ImmutableMap.of(), "header1");
101-
Map<String, List<String>> extraHeaders = metadataProvider.newSpannerTracingHeader();
101+
Map<String, List<String>> extraHeaders = metadataProvider.newEndToEndTracingHeader();
102102
Map<String, List<String>> expectedHeaders =
103103
ImmutableMap.<String, List<String>>of(
104104
"x-goog-spanner-end-to-end-tracing", ImmutableList.of("true"));

0 commit comments

Comments
 (0)