Skip to content

Commit cf50cf8

Browse files
authored
interop: enable OpenTelemetry tracing support in Java (grpc#12910)
1 parent ba0aab4 commit cf50cf8

5 files changed

Lines changed: 111 additions & 4 deletions

File tree

‎gradle/libs.versions.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ opencensus-impl = { module = "io.opencensus:opencensus-impl", version.ref = "ope
122122
opentelemetry-api = "io.opentelemetry:opentelemetry-api:1.64.0"
123123
opentelemetry-exporter-prometheus = "io.opentelemetry:opentelemetry-exporter-prometheus:1.64.0-alpha"
124124
opentelemetry-gcp-resources = "io.opentelemetry.contrib:opentelemetry-gcp-resources:1.59.0-alpha"
125+
opentelemetry-exporter-otlp = "io.opentelemetry:opentelemetry-exporter-otlp:1.64.0"
125126
opentelemetry-sdk-extension-autoconfigure = "io.opentelemetry:opentelemetry-sdk-extension-autoconfigure:1.64.0"
126127
opentelemetry-sdk-testing = "io.opentelemetry:opentelemetry-sdk-testing:1.64.0"
127128
perfmark-api = "io.perfmark:perfmark-api:0.27.0"

‎interop-testing/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ dependencies {
2626
libraries.opencensus.contrib.grpc.metrics,
2727
libraries.google.auth.oauth2Http,
2828
libraries.opentelemetry.sdk.extension.autoconfigure,
29+
libraries.opentelemetry.exporter.otlp,
2930
libraries.guava.jre // Fix checkUpperBoundDeps using -android
3031
api project(':grpc-api'),
3132
project(':grpc-stub'),
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2026 The gRPC Authors
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 io.grpc.testing.integration;
18+
19+
import io.grpc.opentelemetry.GrpcOpenTelemetry;
20+
import io.grpc.opentelemetry.InternalGrpcOpenTelemetry;
21+
import io.opentelemetry.sdk.OpenTelemetrySdk;
22+
import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
23+
import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdkBuilder;
24+
import java.util.HashMap;
25+
import java.util.Map;
26+
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
27+
28+
/**
29+
* Utility methods for OpenTelemetry configuration in integration testing.
30+
*/
31+
public final class OpenTelemetryUtil {
32+
33+
private OpenTelemetryUtil() {}
34+
35+
/**
36+
* Initializes and registers OpenTelemetry tracing for interop client and server.
37+
*
38+
* @param otelCollectorAddress optional collector address (e.g. "localhost:4317")
39+
* @return the configured {@link OpenTelemetrySdk}
40+
*/
41+
@IgnoreJRERequirement // OpenTelemetry uses Java 8+ APIs
42+
public static OpenTelemetrySdk setupOpenTelemetry(String otelCollectorAddress) {
43+
AutoConfiguredOpenTelemetrySdkBuilder sdkBuilder =
44+
AutoConfiguredOpenTelemetrySdk.builder();
45+
Map<String, String> properties = new HashMap<>();
46+
properties.put("otel.traces.exporter", "otlp");
47+
properties.put("otel.exporter.otlp.protocol", "grpc");
48+
// Reduce BatchSpanProcessor export delay from default 5000ms to 100ms for fast test runs.
49+
properties.put("otel.bsp.schedule.delay", "100");
50+
if (otelCollectorAddress != null && !otelCollectorAddress.isEmpty()) {
51+
String endpoint = otelCollectorAddress;
52+
if (endpoint.startsWith("https://")) {
53+
endpoint = "http://" + endpoint.substring(8);
54+
} else if (!endpoint.startsWith("http://")) {
55+
endpoint = "http://" + endpoint;
56+
}
57+
properties.put("otel.exporter.otlp.endpoint", endpoint);
58+
}
59+
sdkBuilder.addPropertiesSupplier(() -> properties);
60+
AutoConfiguredOpenTelemetrySdk autoSdk = sdkBuilder.build();
61+
OpenTelemetrySdk openTelemetrySdk = autoSdk.getOpenTelemetrySdk();
62+
GrpcOpenTelemetry.Builder grpcOpentelemetryBuilder = GrpcOpenTelemetry.newBuilder()
63+
.sdk(openTelemetrySdk);
64+
InternalGrpcOpenTelemetry.enableTracing(grpcOpentelemetryBuilder, true);
65+
GrpcOpenTelemetry grpcOpenTelemetry = grpcOpentelemetryBuilder.build();
66+
grpcOpenTelemetry.registerGlobal();
67+
return openTelemetrySdk;
68+
}
69+
}

‎interop-testing/src/main/java/io/grpc/testing/integration/TestServiceClient.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@
6868
import io.grpc.testing.integration.Messages.StreamingOutputCallRequest;
6969
import io.grpc.testing.integration.Messages.StreamingOutputCallResponse;
7070
import io.grpc.testing.integration.Messages.TestOrcaReport;
71+
import io.opentelemetry.sdk.OpenTelemetrySdk;
7172
import java.io.File;
7273
import java.io.FileInputStream;
7374
import java.io.InputStream;
@@ -79,6 +80,7 @@
7980
import java.util.concurrent.TimeUnit;
8081
import java.util.concurrent.atomic.AtomicReference;
8182
import javax.annotation.Nullable;
83+
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
8284

8385
/**
8486
* Application that starts a client for the {@link TestServiceGrpc.TestServiceImplBase} and runs
@@ -135,6 +137,9 @@ public static void main(String[] args) throws Exception {
135137
private int soakRequestSize = 271828;
136138
private int soakResponseSize = 314159;
137139
private int numThreads = 1;
140+
private boolean enableOpentelemetry;
141+
private String otelCollectorAddress;
142+
private OpenTelemetrySdk openTelemetrySdk;
138143
private String additionalMetadata = "";
139144
private static LoadBalancerProvider customBackendMetricsLoadBalancerProvider;
140145

@@ -219,6 +224,10 @@ void parseArgs(String[] args) throws Exception {
219224
numThreads = Integer.parseInt(value);
220225
} else if ("additional_metadata".equals(key)) {
221226
additionalMetadata = value;
227+
} else if ("enable_opentelemetry".equals(key)) {
228+
enableOpentelemetry = Boolean.parseBoolean(value);
229+
} else if ("otel_collector_address".equals(key)) {
230+
otelCollectorAddress = value;
222231
} else {
223232
System.err.println("Unknown argument: " + key);
224233
usage = true;
@@ -306,7 +315,11 @@ void parseArgs(String[] args) throws Exception {
306315
}
307316

308317
@VisibleForTesting
318+
@IgnoreJRERequirement // OpenTelemetry uses Java 8+ APIs
309319
void setUp() {
320+
if (enableOpentelemetry) {
321+
this.openTelemetrySdk = OpenTelemetryUtil.setupOpenTelemetry(otelCollectorAddress);
322+
}
310323
tester.setUp();
311324
}
312325

@@ -321,6 +334,10 @@ private synchronized void tearDown() {
321334
throw ex;
322335
} catch (Exception ex) {
323336
throw new RuntimeException(ex);
337+
} finally {
338+
if (openTelemetrySdk != null) {
339+
openTelemetrySdk.close();
340+
}
324341
}
325342
}
326343

‎interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,15 @@
3232
import io.grpc.testing.TlsTesting;
3333
import io.grpc.xds.orca.OrcaMetricReportingServerInterceptor;
3434
import io.grpc.xds.orca.OrcaServiceImpl;
35+
import io.opentelemetry.sdk.OpenTelemetrySdk;
3536
import java.net.InetSocketAddress;
3637
import java.net.SocketAddress;
3738
import java.util.List;
3839
import java.util.Locale;
3940
import java.util.concurrent.Executors;
4041
import java.util.concurrent.ScheduledExecutorService;
4142
import java.util.concurrent.TimeUnit;
43+
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
4244

4345
/** Server that manages startup/shutdown of a single {@code TestService}. */
4446
public class TestServiceServer {
@@ -76,6 +78,9 @@ public void run() {
7678
private boolean useTls = true;
7779
private boolean useAlts = false;
7880
private int mcsLimit = -1;
81+
private boolean enableOpentelemetry = false;
82+
private String otelCollectorAddress;
83+
private OpenTelemetrySdk openTelemetrySdk;
7984

8085
private ScheduledExecutorService executor;
8186
private Server server;
@@ -123,6 +128,10 @@ void parseArgs(String[] args) {
123128
mcsLimit = Integer.parseInt(value);
124129
// TODO: Make Netty server builder usable for IPV6 as well (not limited to MCS handling)
125130
addressType = Util.AddressType.IPV4; // To use NettyServerBuilder
131+
} else if ("enable_opentelemetry".equals(key)) {
132+
enableOpentelemetry = Boolean.parseBoolean(value);
133+
} else if ("otel_collector_address".equals(key)) {
134+
otelCollectorAddress = value;
126135
} else {
127136
System.err.println("Unknown argument: " + key);
128137
usage = true;
@@ -155,7 +164,11 @@ void parseArgs(String[] args) {
155164

156165
@SuppressWarnings("AddressSelection")
157166
@VisibleForTesting
167+
@IgnoreJRERequirement // OpenTelemetry uses Java 8+ APIs
158168
void start() throws Exception {
169+
if (enableOpentelemetry) {
170+
this.openTelemetrySdk = OpenTelemetryUtil.setupOpenTelemetry(otelCollectorAddress);
171+
}
159172
executor = Executors.newSingleThreadScheduledExecutor();
160173
ServerCredentials serverCreds;
161174
if (useAlts) {
@@ -224,11 +237,17 @@ void start() throws Exception {
224237

225238
@VisibleForTesting
226239
void stop() throws Exception {
227-
server.shutdownNow();
228-
if (!server.awaitTermination(5, TimeUnit.SECONDS)) {
229-
System.err.println("Timed out waiting for server shutdown");
240+
try {
241+
server.shutdownNow();
242+
if (!server.awaitTermination(5, TimeUnit.SECONDS)) {
243+
System.err.println("Timed out waiting for server shutdown");
244+
}
245+
MoreExecutors.shutdownAndAwaitTermination(executor, 5, TimeUnit.SECONDS);
246+
} finally {
247+
if (openTelemetrySdk != null) {
248+
openTelemetrySdk.close();
249+
}
230250
}
231-
MoreExecutors.shutdownAndAwaitTermination(executor, 5, TimeUnit.SECONDS);
232251
}
233252

234253
@VisibleForTesting

0 commit comments

Comments
 (0)