Skip to content

Commit

Permalink
Add logging to OTEL code
Browse files Browse the repository at this point in the history
  • Loading branch information
@adinauer
adinauer committed Dec 13, 2022
1 parent baf8bd5 commit 49efc4c
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 13 deletions.
29 changes: 28 additions & 1 deletion ...etry-core/src/main/java/io/sentry/opentelemetry/OpenTelemetryLinkErrorEventProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import io.sentry.ISpan;
import io.sentry.Instrumenter;
import io.sentry.SentryEvent;
import io.sentry.SentryLevel;
import io.sentry.SentrySpanStorage;
import io.sentry.SpanContext;
import io.sentry.protocol.SentryId;
Expand All @@ -33,7 +34,8 @@ public OpenTelemetryLinkErrorEventProcessor() {

@Override
public @Nullable SentryEvent process(final @NotNull SentryEvent event, final @NotNull Hint hint) {
if (Instrumenter.OTEL.equals(hub.getOptions().getInstrumenter())) {
final @NotNull Instrumenter instrumenter = hub.getOptions().getInstrumenter();
if (Instrumenter.OTEL.equals(instrumenter)) {
@NotNull final Span otelSpan = Span.current();
@NotNull final String traceId = otelSpan.getSpanContext().getTraceId();
@NotNull final String spanId = otelSpan.getSpanContext().getSpanId();
Expand All @@ -53,8 +55,33 @@ public OpenTelemetryLinkErrorEventProcessor() {
null);

event.getContexts().setTrace(spanContext);
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Linking Sentry event to span %s created via OpenTelemetry.",
spanId);
} else {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not linking Sentry event to any transaction created via OpenTelemetry as none has been found.");
}
} else {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not linking Sentry event to any transaction created via OpenTelemetry as traceId or spanId are invalid.");
}
} else {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not linking Sentry event to any transaction created via OpenTelemetry as instrumenter is set to %s.",
instrumenter);
}

return event;
Expand Down
32 changes: 32 additions & 0 deletions ...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentryPropagator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@
import io.opentelemetry.context.propagation.TextMapSetter;
import io.sentry.Baggage;
import io.sentry.BaggageHeader;
import io.sentry.HubAdapter;
import io.sentry.IHub;
import io.sentry.ISpan;
import io.sentry.SentryLevel;
import io.sentry.SentrySpanStorage;
import io.sentry.SentryTraceHeader;
import io.sentry.exception.InvalidSentryTraceHeaderException;
Expand All @@ -26,6 +29,15 @@ public final class SentryPropagator implements TextMapPropagator {
private static final @NotNull List<String> FIELDS =
Arrays.asList(SentryTraceHeader.SENTRY_TRACE_HEADER, BaggageHeader.BAGGAGE_HEADER);
private final @NotNull SentrySpanStorage spanStorage = SentrySpanStorage.getInstance();
private final @NotNull IHub hub;

public SentryPropagator() {
this(HubAdapter.getInstance());
}

SentryPropagator(final @NotNull IHub hub) {
this.hub = hub;
}

@Override
public Collection<String> fields() {
Expand All @@ -37,10 +49,20 @@ public <C> void inject(final Context context, final C carrier, final TextMapSett
final @NotNull Span otelSpan = Span.fromContext(context);
final @NotNull SpanContext otelSpanContext = otelSpan.getSpanContext();
if (!otelSpanContext.isValid()) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not injecting Sentry tracing information for invalid OpenTelemetry span.");
return;
}
final @Nullable ISpan sentrySpan = spanStorage.get(otelSpanContext.getSpanId());
if (sentrySpan == null || sentrySpan.isNoOp()) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not injecting Sentry tracing information as no Sentry span has been found or it is a NoOp.");
return;
}

Expand Down Expand Up @@ -82,8 +104,18 @@ public <C> Context extract(
Span wrappedSpan = Span.wrap(otelSpanContext);
modifiedContext = modifiedContext.with(wrappedSpan);

hub.getOptions()
.getLogger()
.log(SentryLevel.DEBUG, "Continuing Sentry trace %s", sentryTraceHeader.getTraceId());

return modifiedContext;
} catch (InvalidSentryTraceHeaderException e) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.ERROR,
"Unable to extract Sentry tracing information from invalid header.",
e);
return context;
}
}
Expand Down
63 changes: 61 additions & 2 deletions .../sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import io.sentry.ISpan;
import io.sentry.ITransaction;
import io.sentry.Instrumenter;
import io.sentry.SentryLevel;
import io.sentry.SentrySpanStorage;
import io.sentry.SentryTraceHeader;
import io.sentry.SpanId;
Expand Down Expand Up @@ -48,7 +49,7 @@ public SentrySpanProcessor() {
this(HubAdapter.getInstance());
}

SentrySpanProcessor(@NotNull IHub hub) {
SentrySpanProcessor(final @NotNull IHub hub) {
this.hub = hub;
}

Expand All @@ -59,6 +60,11 @@ public void onStart(final @NotNull Context parentContext, final @NotNull ReadWri
}

if (isSentryRequest(otelSpan)) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not forwarding OpenTelemetry Span to Sentry as this looks like a span for a request to Sentry.");
return;
}

Expand All @@ -67,13 +73,26 @@ public void onStart(final @NotNull Context parentContext, final @NotNull ReadWri
traceData.getParentSpanId() == null ? null : spanStorage.get(traceData.getParentSpanId());

if (sentryParentSpan != null) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Creating Sentry child span %s for OpenTelemetry span. Parent span is %s.",
traceData.getSpanId(),
traceData.getParentSpanId());
final @NotNull Date startDate =
DateUtils.nanosToDate(otelSpan.toSpanData().getStartEpochNanos());
final @NotNull ISpan sentryChildSpan =
sentryParentSpan.startChild(
otelSpan.getName(), otelSpan.getName(), startDate, Instrumenter.OTEL);
spanStorage.store(traceData.getSpanId(), sentryChildSpan);
} else {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Creating Sentry transaction %s for OpenTelemetry span.",
traceData.getSpanId());
final @NotNull String transactionName = otelSpan.getName();
final @NotNull TransactionNameSource transactionNameSource = TransactionNameSource.CUSTOM;
final @Nullable String op = otelSpan.getName();
Expand Down Expand Up @@ -124,18 +143,41 @@ public void onEnd(final @NotNull ReadableSpan otelSpan) {
final @Nullable ISpan sentrySpan = spanStorage.removeAndGet(traceData.getSpanId());

if (sentrySpan == null) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Unable to find Sentry span for OpenTelemetry span %s.",
traceData.getSpanId());
return;
}

if (isSentryRequest(otelSpan)) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not forwarding OpenTelemetry Span to Sentry as this looks like a span for a request to Sentry.");
return;
}

if (sentrySpan instanceof ITransaction) {
ITransaction sentryTransaction = (ITransaction) sentrySpan;
updateTransactionWithOtelData(sentryTransaction, otelSpan);
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Finishing Sentry transaction for OpenTelemetry span %s.",
traceData.getSpanId());
} else {
updateSpanWithOtelData(sentrySpan, otelSpan);
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Finishing Sentry span for OpenTelemetry span %s.",
traceData.getSpanId());
}

final @NotNull SpanStatus sentryStatus = mapOtelStatus(otelSpan);
Expand All @@ -151,15 +193,32 @@ public boolean isEndRequired() {

private boolean ensurePrerequisites(final @NotNull ReadableSpan otelSpan) {
if (!hasSentryBeenInitialized()) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not forwarding OpenTelemetry Span to Sentry as Sentry has not yet been initialized.");
return false;
}

if (!Instrumenter.OTEL.equals(hub.getOptions().getInstrumenter())) {
final @NotNull Instrumenter instrumenter = hub.getOptions().getInstrumenter();
if (!Instrumenter.OTEL.equals(instrumenter)) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not forwarding OpenTelemetry Span to Sentry as instrumenter has been set to %s.",
instrumenter);
return false;
}

final @NotNull SpanContext otelSpanContext = otelSpan.getSpanContext();
if (!otelSpanContext.isValid()) {
hub.getOptions()
.getLogger()
.log(
SentryLevel.DEBUG,
"Not forwarding OpenTelemetry Span to Sentry as the span is invalid.");
return false;
}

Expand Down
22 changes: 12 additions & 10 deletions sentry-opentelemetry/sentry-opentelemetry-core/src/test/kotlin/SentrySpanProcessorTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,30 +142,32 @@ class SentrySpanProcessorTest {

@Test
fun `does nothing on start if Sentry has not been initialized`() {
val hub = mock<IHub>()
fixture.setup()
val context = mock<Context>()
val span = mock<ReadWriteSpan>()

whenever(hub.isEnabled).thenReturn(false)
whenever(fixture.hub.isEnabled).thenReturn(false)

SentrySpanProcessor(hub).onStart(context, span)
SentrySpanProcessor(fixture.hub).onStart(context, span)

verify(hub).isEnabled
verifyNoMoreInteractions(hub)
verify(fixture.hub).isEnabled
verify(fixture.hub).options
verifyNoMoreInteractions(fixture.hub)
verifyNoInteractions(context, span)
}

@Test
fun `does nothing on end if Sentry has not been initialized`() {
val hub = mock<IHub>()
fixture.setup()
val span = mock<ReadableSpan>()

whenever(hub.isEnabled).thenReturn(false)
whenever(fixture.hub.isEnabled).thenReturn(false)

SentrySpanProcessor(hub).onEnd(span)
SentrySpanProcessor(fixture.hub).onEnd(span)

verify(hub).isEnabled
verifyNoMoreInteractions(hub)
verify(fixture.hub).isEnabled
verify(fixture.hub).options
verifyNoMoreInteractions(fixture.hub)
verifyNoInteractions(span)
}

Expand Down

0 comments on commit 49efc4c

Please sign in to comment.