Ensure OTEL from examples aligns with SDK and ITs

Signed-off-by: Artur Ciocanu <ciocanu@adobe.com>
This commit is contained in:
Artur Ciocanu 2025-06-05 09:15:37 -07:00
parent 7e2f81d0e3
commit c8a93bec04
6 changed files with 38 additions and 22 deletions

View File

@ -22,7 +22,7 @@
<maven.compiler.source>${java.version}</maven.compiler.source> <maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target> <maven.compiler.target>${java.version}</maven.compiler.target>
<spotbugs.fail>false</spotbugs.fail> <spotbugs.fail>false</spotbugs.fail>
<opentelemetry.version>0.14.0</opentelemetry.version> <opentelemetry.version>1.14.0</opentelemetry.version>
<opentelemetry-sdk-metrics.version>1.41.0</opentelemetry-sdk-metrics.version> <opentelemetry-sdk-metrics.version>1.41.0</opentelemetry-sdk-metrics.version>
<zipkin.version>2.16.3</zipkin.version> <zipkin.version>2.16.3</zipkin.version>
</properties> </properties>

View File

@ -20,9 +20,10 @@ import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator; import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
import io.opentelemetry.context.Context; import io.opentelemetry.context.Context;
import io.opentelemetry.context.propagation.ContextPropagators; import io.opentelemetry.context.propagation.ContextPropagators;
import io.opentelemetry.context.propagation.TextMapPropagator; import io.opentelemetry.context.propagation.TextMapSetter;
import io.opentelemetry.exporter.zipkin.ZipkinSpanExporter; import io.opentelemetry.exporter.zipkin.ZipkinSpanExporter;
import io.opentelemetry.sdk.OpenTelemetrySdk; import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.trace.SdkTracerProvider; import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor; import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
@ -59,18 +60,23 @@ public class OpenTelemetryConfig {
* Creates an opentelemetry instance. * Creates an opentelemetry instance.
* @return OpenTelemetry. * @return OpenTelemetry.
*/ */
public static OpenTelemetry createOpenTelemetry() { public static OpenTelemetrySdk createOpenTelemetry() {
// Only exports to Zipkin if it is up. Otherwise, ignore it. // Only exports to Zipkin if it is up. Otherwise, ignore it.
// This is helpful to avoid exceptions for examples that do not require Zipkin. // This is helpful to avoid exceptions for examples that do not require Zipkin.
if (isZipkinUp()) { if (isZipkinUp()) {
Resource serviceResource = Resource.getDefault()
.toBuilder()
.put("service.name", InvokeClient.class.getName()) // Use ResourceAttributes constant
.build();
String httpUrl = String.format("http://localhost:%d", ZIPKIN_PORT); String httpUrl = String.format("http://localhost:%d", ZIPKIN_PORT);
ZipkinSpanExporter zipkinExporter = ZipkinSpanExporter zipkinExporter =
ZipkinSpanExporter.builder() ZipkinSpanExporter.builder()
.setEndpoint(httpUrl + ENDPOINT_V2_SPANS) .setEndpoint(httpUrl + ENDPOINT_V2_SPANS)
.setServiceName(InvokeClient.class.getName())
.build(); .build();
SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder() SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
.setResource(serviceResource)
.addSpanProcessor(SimpleSpanProcessor.create(zipkinExporter)) .addSpanProcessor(SimpleSpanProcessor.create(zipkinExporter))
.build(); .build();
@ -100,7 +106,7 @@ public class OpenTelemetryConfig {
*/ */
public static reactor.util.context.Context getReactorContext(Context context) { public static reactor.util.context.Context getReactorContext(Context context) {
Map<String, String> map = new HashMap<>(); Map<String, String> map = new HashMap<>();
TextMapPropagator.Setter<Map<String, String>> setter = TextMapSetter<Map<String, String>> setter =
(carrier, key, value) -> map.put(key, value); (carrier, key, value) -> map.put(key, value);
GlobalOpenTelemetry.getPropagators().getTextMapPropagator().inject(context, map, setter); GlobalOpenTelemetry.getPropagators().getTextMapPropagator().inject(context, map, setter);

View File

@ -15,6 +15,7 @@ package io.dapr.examples;
import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.context.Context; import io.opentelemetry.context.Context;
import io.opentelemetry.context.propagation.TextMapGetter;
import io.opentelemetry.context.propagation.TextMapPropagator; import io.opentelemetry.context.propagation.TextMapPropagator;
import jakarta.servlet.DispatcherType; import jakarta.servlet.DispatcherType;
import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequest;
@ -34,8 +35,8 @@ public class OpenTelemetryInterceptor implements HandlerInterceptor {
@Autowired @Autowired
private OpenTelemetry openTelemetry; private OpenTelemetry openTelemetry;
private static final TextMapPropagator.Getter<HttpServletRequest> HTTP_SERVLET_REQUEST_GETTER = private static final TextMapGetter<HttpServletRequest> HTTP_SERVLET_REQUEST_GETTER =
new TextMapPropagator.Getter<>() { new TextMapGetter<>() {
@Override @Override
public Iterable<String> keys(HttpServletRequest carrier) { public Iterable<String> keys(HttpServletRequest carrier) {
return Collections.list(carrier.getHeaderNames()); return Collections.list(carrier.getHeaderNames());

View File

@ -21,6 +21,7 @@ import io.dapr.client.domain.BulkPublishResponseFailedEntry;
import io.dapr.examples.OpenTelemetryConfig; import io.dapr.examples.OpenTelemetryConfig;
import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span; import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.api.trace.Tracer; import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Scope; import io.opentelemetry.context.Scope;
import io.opentelemetry.sdk.OpenTelemetrySdk; import io.opentelemetry.sdk.OpenTelemetrySdk;
@ -55,28 +56,34 @@ public class BulkPublisher {
* @throws Exception any exception * @throws Exception any exception
*/ */
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
OpenTelemetry openTelemetry = OpenTelemetryConfig.createOpenTelemetry(); OpenTelemetrySdk openTelemetrySdk = OpenTelemetryConfig.createOpenTelemetry();
Tracer tracer = openTelemetry.getTracer(BulkPublisher.class.getCanonicalName()); Tracer tracer = openTelemetrySdk.getTracer(BulkPublisher.class.getCanonicalName());
Span span = tracer.spanBuilder("Bulk Publisher's Main").setSpanKind(Span.Kind.CLIENT).startSpan(); Span span = tracer.spanBuilder("Bulk Publisher's Main").setSpanKind(SpanKind.CLIENT).startSpan();
try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient()) { try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient()) {
DaprClient c = (DaprClient) client; DaprClient c = (DaprClient) client;
c.waitForSidecar(10000); c.waitForSidecar(10000);
try (Scope scope = span.makeCurrent()) { try (Scope scope = span.makeCurrent()) {
System.out.println("Using preview client..."); System.out.println("Using preview client...");
List<String> messages = new ArrayList<>(); List<String> messages = new ArrayList<>();
System.out.println("Constructing the list of messages to publish"); System.out.println("Constructing the list of messages to publish");
for (int i = 0; i < NUM_MESSAGES; i++) { for (int i = 0; i < NUM_MESSAGES; i++) {
String message = String.format("This is message #%d", i); String message = String.format("This is message #%d", i);
messages.add(message); messages.add(message);
System.out.println("Going to publish message : " + message); System.out.println("Going to publish message : " + message);
} }
BulkPublishResponse<?> res = client.publishEvents(PUBSUB_NAME, TOPIC_NAME, "text/plain", messages) BulkPublishResponse<?> res = client.publishEvents(PUBSUB_NAME, TOPIC_NAME, "text/plain", messages)
.contextWrite(getReactorContext()).block(); .contextWrite(getReactorContext()).block();
System.out.println("Published the set of messages in a single call to Dapr"); System.out.println("Published the set of messages in a single call to Dapr");
if (res != null) { if (res != null) {
if (res.getFailedEntries().size() > 0) { if (res.getFailedEntries().size() > 0) {
// Ideally this condition will not happen in examples // Ideally this condition will not happen in examples
System.out.println("Some events failed to be published"); System.out.println("Some events failed to be published");
for (BulkPublishResponseFailedEntry<?> entry : res.getFailedEntries()) { for (BulkPublishResponseFailedEntry<?> entry : res.getFailedEntries()) {
System.out.println("EntryId : " + entry.getEntry().getEntryId() System.out.println("EntryId : " + entry.getEntry().getEntryId()
+ " Error message : " + entry.getErrorMessage()); + " Error message : " + entry.getErrorMessage());
@ -92,10 +99,9 @@ public class BulkPublisher {
// Allow plenty of time for Dapr to export all relevant spans to the tracing infra. // Allow plenty of time for Dapr to export all relevant spans to the tracing infra.
Thread.sleep(10000); Thread.sleep(10000);
// Shutdown the OpenTelemetry tracer. // Shutdown the OpenTelemetry tracer.
OpenTelemetrySdk.getGlobalTracerManagement().shutdown(); openTelemetrySdk.getSdkTracerProvider().shutdown();
System.out.println("Done"); System.out.println("Done");
} }
} }
} }

View File

@ -18,6 +18,7 @@ import io.dapr.client.DaprClientBuilder;
import io.dapr.examples.OpenTelemetryConfig; import io.dapr.examples.OpenTelemetryConfig;
import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span; import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.api.trace.Tracer; import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Scope; import io.opentelemetry.context.Scope;
import io.opentelemetry.sdk.OpenTelemetrySdk; import io.opentelemetry.sdk.OpenTelemetrySdk;
@ -51,9 +52,9 @@ public class PublisherWithTracing {
* @throws Exception A startup Exception. * @throws Exception A startup Exception.
*/ */
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
OpenTelemetry openTelemetry = OpenTelemetryConfig.createOpenTelemetry(); OpenTelemetrySdk openTelemetrySdk = OpenTelemetryConfig.createOpenTelemetry();
Tracer tracer = openTelemetry.getTracer(PublisherWithTracing.class.getCanonicalName()); Tracer tracer = openTelemetrySdk.getTracer(PublisherWithTracing.class.getCanonicalName());
Span span = tracer.spanBuilder("Publisher's Main").setSpanKind(Span.Kind.CLIENT).startSpan(); Span span = tracer.spanBuilder("Publisher's Main").setSpanKind(SpanKind.CLIENT).startSpan();
try (DaprClient client = new DaprClientBuilder().build()) { try (DaprClient client = new DaprClientBuilder().build()) {
try (Scope scope = span.makeCurrent()) { try (Scope scope = span.makeCurrent()) {
@ -80,7 +81,7 @@ public class PublisherWithTracing {
span.end(); span.end();
// Shutdown the OpenTelemetry tracer. // Shutdown the OpenTelemetry tracer.
OpenTelemetrySdk.getGlobalTracerManagement().shutdown(); openTelemetrySdk.getSdkTracerProvider().shutdown();
// This is an example, so for simplicity we are just exiting here. // This is an example, so for simplicity we are just exiting here.
// Normally a dapr app would be a web service and not exit main. // Normally a dapr app would be a web service and not exit main.

View File

@ -21,6 +21,7 @@ import io.dapr.examples.OpenTelemetryConfig;
import io.dapr.utils.TypeRef; import io.dapr.utils.TypeRef;
import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span; import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.api.trace.Tracer; import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Scope; import io.opentelemetry.context.Scope;
import io.opentelemetry.sdk.OpenTelemetrySdk; import io.opentelemetry.sdk.OpenTelemetrySdk;
@ -48,10 +49,10 @@ public class InvokeClient {
* @param args Messages to be sent as request for the invoke API. * @param args Messages to be sent as request for the invoke API.
*/ */
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
final OpenTelemetry openTelemetry = OpenTelemetryConfig.createOpenTelemetry(); final OpenTelemetrySdk openTelemetrySdk = OpenTelemetryConfig.createOpenTelemetry();
final Tracer tracer = openTelemetry.getTracer(InvokeClient.class.getCanonicalName()); final Tracer tracer = openTelemetrySdk.getTracer(InvokeClient.class.getCanonicalName());
Span span = tracer.spanBuilder("Example's Main").setSpanKind(Span.Kind.CLIENT).startSpan(); Span span = tracer.spanBuilder("Example's Main").setSpanKind(SpanKind.CLIENT).startSpan();
try (DaprClient client = (new DaprClientBuilder()).build()) { try (DaprClient client = (new DaprClientBuilder()).build()) {
for (String message : args) { for (String message : args) {
try (Scope scope = span.makeCurrent()) { try (Scope scope = span.makeCurrent()) {
@ -72,12 +73,13 @@ public class InvokeClient {
} }
} }
span.end(); span.end();
shutdown(); shutdown(openTelemetrySdk);
System.out.println("Done"); System.out.println("Done");
} }
private static void shutdown() throws Exception { private static void shutdown(OpenTelemetrySdk openTelemetrySdk) throws Exception {
OpenTelemetrySdk.getGlobalTracerManagement().shutdown(); openTelemetrySdk.getSdkTracerProvider().shutdown();
Validation.validate(); Validation.validate();
} }