Skip to content

Commit e00b884

Browse files
authored
chore: Composite Tracer (#3163)
1 parent 1b74118 commit e00b884

File tree

5 files changed

+508
-5
lines changed

5 files changed

+508
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,20 +50,20 @@ If you are using Maven without the BOM, add this to your dependencies:
5050
If you are using Gradle 5.x or later, add this to your dependencies:
5151

5252
```Groovy
53-
implementation platform('com.google.cloud:libraries-bom:26.40.0')
53+
implementation platform('com.google.cloud:libraries-bom:26.41.0')
5454
5555
implementation 'com.google.cloud:google-cloud-spanner'
5656
```
5757
If you are using Gradle without BOM, add this to your dependencies:
5858

5959
```Groovy
60-
implementation 'com.google.cloud:google-cloud-spanner:6.68.1'
60+
implementation 'com.google.cloud:google-cloud-spanner:6.69.0'
6161
```
6262

6363
If you are using SBT, add this to your dependencies:
6464

6565
```Scala
66-
libraryDependencies += "com.google.cloud" % "google-cloud-spanner" % "6.68.1"
66+
libraryDependencies += "com.google.cloud" % "google-cloud-spanner" % "6.69.0"
6767
```
6868
<!-- {x-version-update-end} -->
6969

@@ -687,7 +687,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
687687
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-spanner/java11.html
688688
[stability-image]: https://img.shields.io/badge/stability-stable-green
689689
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-spanner.svg
690-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-spanner/6.68.1
690+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-spanner/6.69.0
691691
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
692692
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
693693
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.spanner;
18+
19+
import com.google.api.core.InternalApi;
20+
import com.google.api.gax.tracing.ApiTracer;
21+
import com.google.api.gax.tracing.BaseApiTracer;
22+
import com.google.api.gax.tracing.MetricsTracer;
23+
import com.google.common.collect.ImmutableList;
24+
import java.util.ArrayList;
25+
import java.util.List;
26+
import org.threeten.bp.Duration;
27+
28+
@InternalApi
29+
public class CompositeTracer extends BaseApiTracer {
30+
private final List<ApiTracer> children;
31+
32+
public CompositeTracer(List<ApiTracer> children) {
33+
this.children = ImmutableList.copyOf(children);
34+
}
35+
36+
@Override
37+
public Scope inScope() {
38+
final List<Scope> childScopes = new ArrayList<>(children.size());
39+
40+
for (ApiTracer child : children) {
41+
childScopes.add(child.inScope());
42+
}
43+
44+
return new Scope() {
45+
@Override
46+
public void close() {
47+
for (Scope childScope : childScopes) {
48+
childScope.close();
49+
}
50+
}
51+
};
52+
}
53+
54+
@Override
55+
public void operationSucceeded() {
56+
for (ApiTracer child : children) {
57+
child.operationSucceeded();
58+
}
59+
}
60+
61+
@Override
62+
public void operationCancelled() {
63+
for (ApiTracer child : children) {
64+
child.operationCancelled();
65+
}
66+
}
67+
68+
@Override
69+
public void operationFailed(Throwable error) {
70+
for (ApiTracer child : children) {
71+
child.operationFailed(error);
72+
}
73+
}
74+
75+
@Override
76+
public void connectionSelected(String id) {
77+
for (ApiTracer child : children) {
78+
child.connectionSelected(id);
79+
}
80+
}
81+
82+
@Override
83+
public void attemptStarted(int attemptNumber) {
84+
for (ApiTracer child : children) {
85+
child.attemptStarted(null, attemptNumber);
86+
}
87+
}
88+
89+
@Override
90+
public void attemptStarted(Object request, int attemptNumber) {
91+
for (ApiTracer child : children) {
92+
child.attemptStarted(request, attemptNumber);
93+
}
94+
}
95+
96+
@Override
97+
public void attemptSucceeded() {
98+
for (ApiTracer child : children) {
99+
child.attemptSucceeded();
100+
}
101+
}
102+
103+
@Override
104+
public void attemptCancelled() {
105+
for (ApiTracer child : children) {
106+
child.attemptCancelled();
107+
}
108+
}
109+
110+
@Override
111+
public void attemptFailed(Throwable error, Duration delay) {
112+
for (ApiTracer child : children) {
113+
child.attemptFailed(error, delay);
114+
}
115+
}
116+
117+
@Override
118+
public void attemptFailedRetriesExhausted(Throwable error) {
119+
for (ApiTracer child : children) {
120+
child.attemptFailedRetriesExhausted(error);
121+
}
122+
}
123+
124+
@Override
125+
public void attemptPermanentFailure(Throwable error) {
126+
for (ApiTracer child : children) {
127+
child.attemptPermanentFailure(error);
128+
}
129+
}
130+
131+
@Override
132+
public void lroStartFailed(Throwable error) {
133+
for (ApiTracer child : children) {
134+
child.lroStartFailed(error);
135+
}
136+
}
137+
138+
@Override
139+
public void lroStartSucceeded() {
140+
for (ApiTracer child : children) {
141+
child.lroStartSucceeded();
142+
}
143+
}
144+
145+
@Override
146+
public void responseReceived() {
147+
for (ApiTracer child : children) {
148+
child.responseReceived();
149+
}
150+
}
151+
152+
@Override
153+
public void requestSent() {
154+
for (ApiTracer child : children) {
155+
child.requestSent();
156+
}
157+
}
158+
159+
@Override
160+
public void batchRequestSent(long elementCount, long requestSize) {
161+
for (ApiTracer child : children) {
162+
child.batchRequestSent(elementCount, requestSize);
163+
}
164+
}
165+
166+
public void addAttributes(String key, String value) {
167+
for (ApiTracer child : children) {
168+
if (child instanceof MetricsTracer) {
169+
MetricsTracer metricsTracer = (MetricsTracer) child;
170+
metricsTracer.addAttributes(key, value);
171+
}
172+
}
173+
};
174+
}
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.spanner;
18+
19+
import com.google.api.core.InternalApi;
20+
import com.google.api.gax.tracing.ApiTracer;
21+
import com.google.api.gax.tracing.ApiTracerFactory;
22+
import com.google.api.gax.tracing.BaseApiTracerFactory;
23+
import com.google.api.gax.tracing.SpanName;
24+
import com.google.common.collect.ImmutableList;
25+
import java.util.ArrayList;
26+
import java.util.List;
27+
28+
@InternalApi
29+
public class CompositeTracerFactory extends BaseApiTracerFactory {
30+
31+
private final List<ApiTracerFactory> apiTracerFactories;
32+
33+
public CompositeTracerFactory(List<ApiTracerFactory> apiTracerFactories) {
34+
this.apiTracerFactories = ImmutableList.copyOf(apiTracerFactories);
35+
}
36+
37+
@Override
38+
public ApiTracer newTracer(ApiTracer parent, SpanName spanName, OperationType operationType) {
39+
List<ApiTracer> children = new ArrayList<>(apiTracerFactories.size());
40+
41+
for (ApiTracerFactory factory : apiTracerFactories) {
42+
children.add(factory.newTracer(parent, spanName, operationType));
43+
}
44+
return new CompositeTracer(children);
45+
}
46+
}

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@
7272
import java.io.IOException;
7373
import java.net.MalformedURLException;
7474
import java.net.URL;
75+
import java.util.ArrayList;
7576
import java.util.HashMap;
77+
import java.util.List;
7678
import java.util.Map;
7779
import java.util.Map.Entry;
7880
import java.util.Set;
@@ -1621,8 +1623,12 @@ public OpenTelemetry getOpenTelemetry() {
16211623

16221624
@Override
16231625
public ApiTracerFactory getApiTracerFactory() {
1626+
List<ApiTracerFactory> apiTracerFactories = new ArrayList();
16241627
// Prefer any direct ApiTracerFactory that might have been set on the builder.
1625-
return MoreObjects.firstNonNull(super.getApiTracerFactory(), getDefaultApiTracerFactory());
1628+
apiTracerFactories.add(
1629+
MoreObjects.firstNonNull(super.getApiTracerFactory(), getDefaultApiTracerFactory()));
1630+
1631+
return new CompositeTracerFactory(apiTracerFactories);
16261632
}
16271633

16281634
private ApiTracerFactory getDefaultApiTracerFactory() {

0 commit comments

Comments
 (0)