Skip to content

Commit 7c39b82

Browse files
nareshznareshz
committed
rename spanner option for end to end tracing
1 parent 4613e29 commit 7c39b82

File tree

6 files changed

+51
-42
lines changed

6 files changed

+51
-42
lines changed

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

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ public class SpannerOptions extends ServiceOptions<Spanner, SpannerOptions> {
158158
private final OpenTelemetry openTelemetry;
159159
private final boolean enableApiTracing;
160160
private final boolean enableExtendedTracing;
161-
private final boolean enableEndToEndTracing;
161+
private final boolean enableServerSideTracing;
162162

163163
enum TracingFramework {
164164
OPEN_CENSUS,
@@ -665,7 +665,7 @@ protected SpannerOptions(Builder builder) {
665665
openTelemetry = builder.openTelemetry;
666666
enableApiTracing = builder.enableApiTracing;
667667
enableExtendedTracing = builder.enableExtendedTracing;
668-
enableEndToEndTracing = builder.enableEndToEndTracing;
668+
enableServerSideTracing = builder.enableServerSideTracing;
669669
}
670670

671671
/**
@@ -801,7 +801,7 @@ public static class Builder
801801
private OpenTelemetry openTelemetry;
802802
private boolean enableApiTracing = SpannerOptions.environment.isEnableApiTracing();
803803
private boolean enableExtendedTracing = SpannerOptions.environment.isEnableExtendedTracing();
804-
private boolean enableEndToEndTracing = false;
804+
private boolean enableServerSideTracing = false;
805805

806806
private static String createCustomClientLibToken(String token) {
807807
return token + " " + ServiceOptions.getGoogApiClientLibName();
@@ -867,7 +867,7 @@ protected Builder() {
867867
this.useVirtualThreads = options.useVirtualThreads;
868868
this.enableApiTracing = options.enableApiTracing;
869869
this.enableExtendedTracing = options.enableExtendedTracing;
870-
this.enableEndToEndTracing = options.enableEndToEndTracing;
870+
this.enableServerSideTracing = options.enableServerSideTracing;
871871
}
872872

873873
@Override
@@ -1396,11 +1396,20 @@ public Builder setEnableExtendedTracing(boolean enableExtendedTracing) {
13961396
}
13971397

13981398
/**
1399-
* Sets whether to enable end to end tracing. Enabling this option will create the
1400-
* trace spans at the Spanner layer.
1399+
* Enable spanner server side tracing. Enabling this option will create the trace
1400+
* spans at the Spanner layer. By default, server side tracing is disabled.
14011401
*/
1402-
public Builder setEnableEndToEndTracing(boolean enableEndToEndTracing) {
1403-
this.enableEndToEndTracing = enableEndToEndTracing;
1402+
public Builder enableServerSideTracing() {
1403+
this.enableServerSideTracing = true;
1404+
return this;
1405+
}
1406+
1407+
/**
1408+
* Disable spanner server side tracing. If server side is disabled, trace
1409+
* spans won't be created at the Spanner layer.
1410+
*/
1411+
public Builder disableServerSideTracing() {
1412+
this.enableServerSideTracing = false;
14041413
return this;
14051414
}
14061415

@@ -1695,11 +1704,11 @@ public boolean isEnableExtendedTracing() {
16951704
}
16961705

16971706
/**
1698-
* Returns whether end to end tracing is enabled. If this option is enabled then trace spans
1707+
* Returns whether Spanner server side tracing is enabled. If this option is enabled then trace spans
16991708
* will be created at the Spanner layer.
17001709
*/
1701-
public boolean isEndToEndTracingEnabled() {
1702-
return enableEndToEndTracing;
1710+
public boolean isServerSideTracingEnabled() {
1711+
return enableServerSideTracing;
17031712
}
17041713

17051714
/** 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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ public class GapicSpannerRpc implements SpannerRpc {
266266
private static final ConcurrentMap<String, RateLimiter> ADMINISTRATIVE_REQUESTS_RATE_LIMITERS =
267267
new ConcurrentHashMap<>();
268268
private final boolean leaderAwareRoutingEnabled;
269-
private final boolean endToEndTracingEnabled;
269+
private final boolean serverSideTracingEnabled;
270270

271271
public static GapicSpannerRpc create(SpannerOptions options) {
272272
return new GapicSpannerRpc(options);
@@ -318,7 +318,7 @@ public GapicSpannerRpc(final SpannerOptions options) {
318318
this.callCredentialsProvider = options.getCallCredentialsProvider();
319319
this.compressorName = options.getCompressorName();
320320
this.leaderAwareRoutingEnabled = options.isLeaderAwareRoutingEnabled();
321-
this.endToEndTracingEnabled = options.isEndToEndTracingEnabled();
321+
this.serverSideTracingEnabled = options.isServerSideTracingEnabled();
322322

323323
if (initializeStubs) {
324324
// First check if SpannerOptions provides a TransportChannelProvider. Create one
@@ -1962,8 +1962,8 @@ <ReqT, RespT> GrpcCallContext newCallContext(
19621962
if (routeToLeader && leaderAwareRoutingEnabled) {
19631963
context = context.withExtraHeaders(metadataProvider.newRouteToLeaderHeader());
19641964
}
1965-
if (endToEndTracingEnabled) {
1966-
context = context.withExtraHeaders(metadataProvider.newEndToEndTracingHeader());
1965+
if (serverSideTracingEnabled) {
1966+
context = context.withExtraHeaders(metadataProvider.newServerSideTracingHeader());
19671967
}
19681968
if (callCredentialsProvider != null) {
19691969
CallCredentials callCredentials = callCredentialsProvider.getCallCredentials();

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

Lines changed: 5 additions & 5 deletions
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 END_TO_END_TRACING_HEADER_KEY = "x-goog-spanner-end-to-end-tracing";
40+
private static final String SERVER_SIDE_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>> END_TO_END_TRACING_HEADER_MAP =
49-
ImmutableMap.of(END_TO_END_TRACING_HEADER_KEY, Collections.singletonList("true"));
48+
private static final Map<String, List<String>> SERVER_SIDE_TRACING_HEADER_MAP =
49+
ImmutableMap.of(SERVER_SIDE_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>> newEndToEndTracingHeader() {
96-
return END_TO_END_TRACING_HEADER_MAP;
95+
Map<String, List<String>> newServerSideTracingHeader() {
96+
return SERVER_SIDE_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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -732,21 +732,21 @@ public void testLeaderAwareRoutingEnablement() {
732732
}
733733

734734
@Test
735-
public void testEndToEndTracingEnablement() {
735+
public void testServerSideTracingEnablement() {
736736
// Test that end to end tracing is disabled by default.
737-
assertFalse(SpannerOptions.newBuilder().setProjectId("p").build().isEndToEndTracingEnabled());
737+
assertFalse(SpannerOptions.newBuilder().setProjectId("p").build().isServerSideTracingEnabled());
738738
assertTrue(
739739
SpannerOptions.newBuilder()
740740
.setProjectId("p")
741-
.setEnableEndToEndTracing(true)
741+
.enableServerSideTracing()
742742
.build()
743-
.isEndToEndTracingEnabled());
743+
.isServerSideTracingEnabled());
744744
assertFalse(
745745
SpannerOptions.newBuilder()
746746
.setProjectId("p")
747-
.setEnableEndToEndTracing(false)
747+
.disableServerSideTracing()
748748
.build()
749-
.isEndToEndTracingEnabled());
749+
.isServerSideTracingEnabled());
750750
}
751751

752752
@Test

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ public class GapicSpannerRpcTest {
148148
private static String defaultUserAgent;
149149
private static Spanner spanner;
150150
private static boolean isRouteToLeader;
151-
private static boolean isEndToEndTracing;
151+
private static boolean isServerSideTracing;
152152

153153
@Parameter public Dialect dialect;
154154

@@ -200,15 +200,15 @@ public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
200200
Key.of(
201201
"x-goog-spanner-route-to-leader",
202202
Metadata.ASCII_STRING_MARSHALLER));
203-
String endToEndTracingHeader =
203+
String serverSideTracingHeader =
204204
headers.get(
205205
Key.of(
206206
"x-goog-spanner-end-to-end-tracing",
207207
Metadata.ASCII_STRING_MARSHALLER));
208208
isRouteToLeader =
209209
(routeToLeaderHeader != null && routeToLeaderHeader.equals("true"));
210-
isEndToEndTracing =
211-
(endToEndTracingHeader != null && endToEndTracingHeader.equals("true"));
210+
isServerSideTracing =
211+
(serverSideTracingHeader != null && serverSideTracingHeader.equals("true"));
212212
}
213213
return Contexts.interceptCall(Context.current(), call, headers, next);
214214
}
@@ -232,7 +232,7 @@ public void reset() throws InterruptedException {
232232
server.awaitTermination();
233233
}
234234
isRouteToLeader = false;
235-
isEndToEndTracing = false;
235+
isServerSideTracing = false;
236236
}
237237

238238
@Test
@@ -474,9 +474,9 @@ public void testNewCallContextWithRouteToLeaderHeaderAndLarDisabled() {
474474
}
475475

476476
@Test
477-
public void testNewCallContextWithEndToEndTracingHeader() {
477+
public void testNewCallContextWithServerSideTracingHeader() {
478478
SpannerOptions options =
479-
SpannerOptions.newBuilder().setProjectId("some-project").setEnableEndToEndTracing(true).build();
479+
SpannerOptions.newBuilder().setProjectId("some-project").enableServerSideTracing().build();
480480
GapicSpannerRpc rpc = new GapicSpannerRpc(options, false);
481481
GrpcCallContext callContext =
482482
rpc.newCallContext(
@@ -495,9 +495,9 @@ public void testNewCallContextWithEndToEndTracingHeader() {
495495
}
496496

497497
@Test
498-
public void testNewCallContextWithoutEndToEndTracingHeader() {
498+
public void testNewCallContextWithoutServerSideTracingHeader() {
499499
SpannerOptions options =
500-
SpannerOptions.newBuilder().setProjectId("some-project").setEnableEndToEndTracing(false).build();
500+
SpannerOptions.newBuilder().setProjectId("some-project").disableServerSideTracing().build();
501501
GapicSpannerRpc rpc = new GapicSpannerRpc(options, false);
502502
GrpcCallContext callContext =
503503
rpc.newCallContext(
@@ -511,9 +511,9 @@ public void testNewCallContextWithoutEndToEndTracingHeader() {
511511
}
512512

513513
@Test
514-
public void testEndToEndTracingHeaderWithEnabledTracing() {
514+
public void testServerSideTracingHeaderWithEnabledTracing() {
515515
final SpannerOptions options =
516-
createSpannerOptions().toBuilder().setEnableEndToEndTracing(true).build();
516+
createSpannerOptions().toBuilder().enableServerSideTracing().build();
517517
try (Spanner spanner = options.getService()) {
518518
final DatabaseClient databaseClient =
519519
spanner.getDatabaseClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"));
@@ -524,13 +524,13 @@ public void testEndToEndTracingHeaderWithEnabledTracing() {
524524
return null;
525525
});
526526
}
527-
assertTrue(isEndToEndTracing);
527+
assertTrue(isServerSideTracing);
528528
}
529529

530530
@Test
531-
public void testEndToEndTracingHeaderWithDisabledTracing() {
531+
public void testServerSideTracingHeaderWithDisabledTracing() {
532532
final SpannerOptions options =
533-
createSpannerOptions().toBuilder().setEnableEndToEndTracing(false).build();
533+
createSpannerOptions().toBuilder().disableServerSideTracing().build();
534534
try (Spanner spanner = options.getService()) {
535535
final DatabaseClient databaseClient =
536536
spanner.getDatabaseClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"));
@@ -541,7 +541,7 @@ public void testEndToEndTracingHeaderWithDisabledTracing() {
541541
return null;
542542
});
543543
}
544-
assertFalse(isEndToEndTracing);
544+
assertFalse(isServerSideTracing);
545545
}
546546

547547
@Test

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

Lines changed: 1 addition & 1 deletion
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.newEndToEndTracingHeader();
101+
Map<String, List<String>> extraHeaders = metadataProvider.newServerSideTracingHeader();
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)