Skip to content

Commit

Permalink
supress zipkin exporters instrumentations (#6552)
Browse files Browse the repository at this point in the history
  • Loading branch information
chungngoops committed Aug 19, 2024
1 parent 32c8d66 commit 581690e
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

package io.opentelemetry.exporter.zipkin;

import io.opentelemetry.api.internal.InstrumentationUtil;
import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.exporter.internal.ExporterMetrics;
import io.opentelemetry.sdk.common.CompletableResultCode;
Expand Down Expand Up @@ -75,15 +76,20 @@ public CompletableResultCode export(Collection<SpanData> spanDataList) {
encodedSpans.add(encoder.encode(zipkinSpan));
}

try {
sender.send(encodedSpans);
exporterMetrics.addSuccess(numItems);
return CompletableResultCode.ofSuccess();
} catch (IOException | RuntimeException t) {
exporterMetrics.addFailed(numItems);
logger.log(Level.WARNING, "Failed to export spans", t);
return CompletableResultCode.ofFailure();
}
CompletableResultCode resultCode = new CompletableResultCode();
InstrumentationUtil.suppressInstrumentation(
() -> {
try {
sender.send(encodedSpans);
exporterMetrics.addSuccess(numItems);
resultCode.succeed();
} catch (IOException | RuntimeException e) {
exporterMetrics.addFailed(numItems);
logger.log(Level.WARNING, "Failed to export spans", e);
resultCode.fail();
}
});
return resultCode;
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,25 @@
import static io.opentelemetry.exporter.zipkin.ZipkinTestUtil.zipkinSpanBuilder;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import io.github.netmikey.logunit.api.LogCapturer;
import io.opentelemetry.api.internal.InstrumentationUtil;
import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.context.Context;
import io.opentelemetry.internal.testing.slf4j.SuppressLogger;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.testing.trace.TestSpanData;
import java.io.IOException;
import java.net.InetAddress;
import java.time.Duration;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.extension.RegisterExtension;
Expand Down Expand Up @@ -244,4 +249,57 @@ void stringRepresentation() {
"ZipkinSpanExporter{endpoint=http://zipkin:9411/api/v2/spans, compressionEnabled=false, readTimeoutMillis=15000}");
}
}

@Test
void suppressInstrumentation() {
TestSpanData testSpanData = spanBuilder().build();

SuppressCatchingSender suppressCatchingSender = new SuppressCatchingSender(Encoding.JSON);
ZipkinSpanExporter zipkinSpanExporter =
new ZipkinSpanExporter(
new ZipkinSpanExporterBuilder(),
mockEncoder,
suppressCatchingSender,
MeterProvider::noop,
mockTransformer);

byte[] someBytes = new byte[0];
Span zipkinSpan =
zipkinSpanBuilder(Span.Kind.SERVER, localIp)
.putTag(OtelToZipkinSpanTransformer.OTEL_STATUS_CODE, "OK")
.build();
when(mockTransformer.generateSpan(testSpanData)).thenReturn(zipkinSpan);
when(mockEncoder.encode(zipkinSpan)).thenReturn(someBytes);

zipkinSpanExporter.export(Collections.singleton(testSpanData));

// Instrumentation should be suppressed on send, to avoid incidental spans related to span
// export.
assertTrue(suppressCatchingSender.sent.get());
assertTrue(suppressCatchingSender.suppressed.get());
}

static class SuppressCatchingSender extends BytesMessageSender.Base {

final AtomicBoolean sent = new AtomicBoolean();
final AtomicBoolean suppressed = new AtomicBoolean();

protected SuppressCatchingSender(Encoding encoding) {
super(encoding);
}

@Override
public int messageMaxBytes() {
return 1024;
}

@Override
public void send(List<byte[]> list) throws IOException {
sent.set(true);
suppressed.set(InstrumentationUtil.shouldSuppressInstrumentation(Context.current()));
}

@Override
public void close() throws IOException {}
}
}

0 comments on commit 581690e

Please sign in to comment.