Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OpenTracing Shim: Log invalid arguments instead of throwing exceptions. #5012

Merged
merged 1 commit into from
Dec 3, 2022
Merged

OpenTracing Shim: Log invalid arguments instead of throwing exceptions. #5012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions opentracing-shim/src/main/java/io/opentelemetry/opentracingshim/ScopeManagerShim.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,10 @@ public Span activeSpan() {
@Override
@SuppressWarnings("MustBeClosedChecker")
public Scope activate(@Nullable Span span) {
if (span == null) {
SpanShim spanShim = ShimUtil.getSpanShim(span);
if (spanShim == null) {
return new ScopeShim(Context.current().with(NOOP_SPANSHIM).makeCurrent());
}
return new ScopeShim(Context.current().with(ShimUtil.getSpanShim(span)).makeCurrent());
return new ScopeShim(Context.current().with(spanShim).makeCurrent());
}
}
33 changes: 26 additions & 7 deletions opentracing-shim/src/main/java/io/opentelemetry/opentracingshim/ShimUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,40 @@

import io.opentracing.Span;
import io.opentracing.SpanContext;
import io.opentracing.noop.NoopSpan;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;

class ShimUtil {
private static final Logger logger = Logger.getLogger(ShimUtil.class.getName());

private ShimUtil() {}

static SpanContextShim getContextShim(SpanContext context) {
@Nullable
static SpanContextShim getContextShim(@Nullable SpanContext context) {
if (context == null) {
return null;
}

if (!(context instanceof SpanContextShim)) {
throw new IllegalArgumentException(
"context is not a valid SpanContextShim object: " + className(context));
logger.log(
Level.INFO,
"Expected to have an OpenTelemetry SpanContext but got {0}",
className(context));
return null;
}

return (SpanContextShim) context;
}

static SpanShim getSpanShim(Span span) {
@Nullable
static SpanShim getSpanShim(@Nullable Span span) {
if (span == null || span instanceof NoopSpan) {
return null;
}

if (!(span instanceof SpanShim)) {
if (span instanceof Supplier<?>) {
// allow libraries to implement a delegate span,
Expand All @@ -32,11 +49,13 @@ static SpanShim getSpanShim(Span span) {
if (wrapped instanceof Span) {
return getSpanShim((Span) wrapped);
} else {
throw new IllegalArgumentException(
"span wrapper didn't return a span: " + className(wrapped));
logger.log(Level.INFO, "Span wrapper didn't return a span: {0}", className(wrapped));
return null;
}
}
throw new IllegalArgumentException("span is not a valid SpanShim object: " + className(span));

logger.log(Level.INFO, "Expected to have an OpenTelemetry Span but got {0}", className(span));
return null;
}

return (SpanShim) span;
Expand Down
15 changes: 7 additions & 8 deletions opentracing-shim/src/main/java/io/opentelemetry/opentracingshim/SpanBuilderShim.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import io.opentracing.Span;
import io.opentracing.SpanContext;
import io.opentracing.Tracer.SpanBuilder;
import io.opentracing.noop.NoopSpan;
import io.opentracing.tag.Tag;
import io.opentracing.tag.Tags;
import java.util.ArrayList;
Expand Down Expand Up @@ -64,11 +63,12 @@ public SpanBuilderShim(TelemetryInfo telemetryInfo, String spanName) {

@Override
public SpanBuilder asChildOf(Span parent) {
if (parent == null || parent instanceof NoopSpan) {
return this;
}
SpanShim spanShim = ShimUtil.getSpanShim(parent);
return addReference(References.CHILD_OF, spanShim.context());
if (spanShim != null) {
addReference(References.CHILD_OF, spanShim.context());
}

return this;
}

@Override
Expand All @@ -78,7 +78,8 @@ public SpanBuilder asChildOf(SpanContext parent) {

@Override
public SpanBuilder addReference(@Nullable String referenceType, SpanContext referencedContext) {
if (referencedContext == null) {
SpanContextShim contextShim = ShimUtil.getContextShim(referencedContext);
if (contextShim == null) {
return this;
}

Expand All @@ -92,8 +93,6 @@ public SpanBuilder addReference(@Nullable String referenceType, SpanContext refe
return this;
}

SpanContextShim contextShim = ShimUtil.getContextShim(referencedContext);

// Optimization for 99% situations, when there is only one parent.
if (allParents.size() == 0) {
allParents =
Expand Down
13 changes: 4 additions & 9 deletions opentracing-shim/src/main/java/io/opentelemetry/opentracingshim/TracerShim.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ public <C> void inject(SpanContext context, Format<C> format, C carrier) {
return;
}

SpanContextShim contextShim = getContextShim(context);
SpanContextShim contextShim = ShimUtil.getContextShim(context);
if (contextShim == null) {
return;
}

if (format == Format.Builtin.TEXT_MAP
|| format == Format.Builtin.TEXT_MAP_INJECT
Expand Down Expand Up @@ -94,12 +97,4 @@ public <C> SpanContext extract(Format<C> format, C carrier) {
public void close() {
isClosed = true;
}

static SpanContextShim getContextShim(SpanContext context) {
if (!(context instanceof SpanContextShim)) {
throw new IllegalArgumentException("context is not a valid SpanContextShim object");
}

return (SpanContextShim) context;
}
}
13 changes: 3 additions & 10 deletions opentracing-shim/src/test/java/io/opentelemetry/opentracingshim/ShimUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package io.opentelemetry.opentracingshim;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.Tracer;
Expand Down Expand Up @@ -40,20 +39,14 @@ void spanWrapper() {
SpanShim shim = new SpanShim(telemetryInfo, span);
assertThat(ShimUtil.getSpanShim(shim)).isEqualTo(shim);
assertThat(ShimUtil.getSpanShim(new SpanWrapper(shim))).isEqualTo(shim);
assertThatThrownBy(() -> ShimUtil.getSpanShim(new SpanWrapper("not a span")))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("span wrapper didn't return a span: java.lang.String");
assertThatThrownBy(() -> ShimUtil.getSpanShim(null))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("span is not a valid SpanShim object: null");
assertThat(ShimUtil.getSpanShim(new SpanWrapper("not a span"))).isNull();
assertThat(ShimUtil.getSpanShim(null)).isNull();
}

@Test
void getContextShim() {
SpanContextShim contextShim = new SpanContextShim(new SpanShim(telemetryInfo, span));
assertThat(ShimUtil.getContextShim(contextShim)).isEqualTo(contextShim);
assertThatThrownBy(() -> ShimUtil.getContextShim(null))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("context is not a valid SpanContextShim object: null");
assertThat(ShimUtil.getContextShim(null)).isNull();
}
}
8 changes: 8 additions & 0 deletions opentracing-shim/src/test/java/io/opentelemetry/opentracingshim/TracerShimTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package io.opentelemetry.opentracingshim;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

import io.opentelemetry.api.baggage.propagation.W3CBaggagePropagator;
import io.opentelemetry.api.trace.Tracer;
Expand Down Expand Up @@ -262,6 +263,13 @@ void inject_nullContext() {
assertThat(map).isEmpty();
}

@Test
void inject_invalid() {
Map<String, String> map = new HashMap<>();
tracerShim.inject(mock(SpanContext.class), Format.Builtin.TEXT_MAP, new TextMapAdapter(map));
assertThat(map).isEmpty();
}

@Test
void inject_textMap() {
Map<String, String> map = new HashMap<>();
Expand Down