Skip to content

Commit

Permalink
Let LogDataBuilder take a SpanContext directly. (#3942)
Browse files Browse the repository at this point in the history 
* Let LogDataBuilder take a SpanContext directly.

* rename to setContext() based on PR review, and simplify test code.

* Update sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataBuilder.java

Co-authored-by: Anuraag Agrawal <[email protected]>
  • Loading branch information
@breedx-splk @anuraaga
breedx-splk and anuraaga authored Dec 4, 2021
1 parent 74fb36b commit 0423949
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 65 deletions.
32 changes: 12 additions & 20 deletions .../src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@

import io.github.netmikey.logunit.api.LogCapturer;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.api.trace.TraceFlags;
import io.opentelemetry.api.trace.TraceState;
import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.common.InstrumentationLibraryInfo;
import io.opentelemetry.sdk.logs.data.LogData;
import io.opentelemetry.sdk.logs.data.LogDataBuilder;
Expand Down Expand Up @@ -44,15 +42,12 @@ class OtlpJsonLoggingLogExporterTest {
.setSeverityText("INFO")
.setEpoch(1631533710L, TimeUnit.MILLISECONDS)
.setAttributes(Attributes.of(stringKey("animal"), "cat", longKey("lives"), 9L))
.setContext(
Context.root()
.with(
Span.wrap(
SpanContext.create(
"12345678876543211234567887654322",
"8765432112345876",
TraceFlags.getDefault(),
TraceState.getDefault()))))
.setSpanContext(
SpanContext.create(
"12345678876543211234567887654322",
"8765432112345876",
TraceFlags.getDefault(),
TraceState.getDefault()))
.build();

private static final LogData LOG2 =
Expand All @@ -63,15 +58,12 @@ class OtlpJsonLoggingLogExporterTest {
.setSeverityText("INFO")
.setEpoch(1631533710L, TimeUnit.MILLISECONDS)
.setAttributes(Attributes.of(booleanKey("important"), true))
.setContext(
Context.root()
.with(
Span.wrap(
SpanContext.create(
"12345678876543211234567887654322",
"8765432112345875",
TraceFlags.getDefault(),
TraceState.getDefault()))))
.setSpanContext(
SpanContext.create(
"12345678876543211234567887654322",
"8765432112345875",
TraceFlags.getDefault(),
TraceState.getDefault()))
.build();

@RegisterExtension
Expand Down
17 changes: 6 additions & 11 deletions ...ers/logging/src/test/java/io/opentelemetry/exporter/logging/SystemOutLogExporterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@
import static org.assertj.core.api.Assertions.assertThat;

import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.api.trace.TraceFlags;
import io.opentelemetry.api.trace.TraceState;
import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.common.InstrumentationLibraryInfo;
import io.opentelemetry.sdk.logs.data.LogData;
Expand Down Expand Up @@ -59,15 +57,12 @@ private static LogData sampleLog(long timestamp) {
.setBody("message")
.setSeverity(Severity.ERROR3)
.setEpoch(timestamp, TimeUnit.MILLISECONDS)
.setContext(
Context.root()
.with(
Span.wrap(
SpanContext.create(
"00000000000000010000000000000002",
"0000000000000003",
TraceFlags.getDefault(),
TraceState.getDefault()))))
.setSpanContext(
SpanContext.create(
"00000000000000010000000000000002",
"0000000000000003",
TraceFlags.getDefault(),
TraceState.getDefault()))
.build();
}
}
26 changes: 6 additions & 20 deletions .../src/test/java/io/opentelemetry/exporter/otlp/internal/logs/LogsRequestMarshalerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.internal.OtelEncodingUtils;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.api.trace.SpanId;
import io.opentelemetry.api.trace.TraceFlags;
import io.opentelemetry.api.trace.TraceId;
import io.opentelemetry.api.trace.TraceState;
import io.opentelemetry.context.Context;
import io.opentelemetry.exporter.otlp.internal.Marshaler;
import io.opentelemetry.proto.common.v1.AnyValue;
import io.opentelemetry.proto.common.v1.InstrumentationLibrary;
Expand Down Expand Up @@ -63,15 +61,9 @@ void toProtoResourceLogs() {
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setContext(
Context.root()
.with(
Span.wrap(
SpanContext.create(
TRACE_ID,
SPAN_ID,
TraceFlags.getDefault(),
TraceState.getDefault()))))
.setSpanContext(
SpanContext.create(
TRACE_ID, SPAN_ID, TraceFlags.getDefault(), TraceState.getDefault()))
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpoch(12345, TimeUnit.NANOSECONDS)
.build()));
Expand Down Expand Up @@ -103,15 +95,9 @@ void toProtoLogRecord() {
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setContext(
Context.root()
.with(
Span.wrap(
SpanContext.create(
TRACE_ID,
SPAN_ID,
TraceFlags.getDefault(),
TraceState.getDefault()))))
.setSpanContext(
SpanContext.create(
TRACE_ID, SPAN_ID, TraceFlags.getDefault(), TraceState.getDefault()))
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpoch(12345, TimeUnit.NANOSECONDS)
.build()));
Expand Down
16 changes: 6 additions & 10 deletions ...src/testOtlpCommon/java/io/opentelemetry/integrationtest/OtlpExporterIntegrationTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
import io.opentelemetry.api.trace.TraceFlags;
import io.opentelemetry.api.trace.TraceId;
import io.opentelemetry.api.trace.TraceState;
import io.opentelemetry.context.Context;
import io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogExporter;
import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;
Expand Down Expand Up @@ -386,15 +385,12 @@ private static void testLogExporter(LogExporter logExporter) {
.setSeverity(Severity.DEBUG)
.setSeverityText("DEBUG")
.setEpoch(Instant.now())
.setContext(
Context.root()
.with(
Span.wrap(
SpanContext.create(
IdGenerator.random().generateTraceId(),
IdGenerator.random().generateSpanId(),
TraceFlags.getDefault(),
TraceState.getDefault()))))
.setSpanContext(
SpanContext.create(
IdGenerator.random().generateTraceId(),
IdGenerator.random().generateSpanId(),
TraceFlags.getDefault(),
TraceState.getDefault()))
.build();

logExporter.export(Collections.singletonList(logData));
Expand Down
9 changes: 7 additions & 2 deletions sdk/logs/src/main/java/io/opentelemetry/sdk/logs/data/LogDataBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,14 @@ public LogDataBuilder setEpoch(Instant instant) {
return this;
}

/** Set the context. */
/** Sets the context. */
public LogDataBuilder setContext(Context context) {
this.spanContext = Span.fromContext(context).getSpanContext();
return setSpanContext(Span.fromContext(context).getSpanContext());
}

/** Sets the span context. */
public LogDataBuilder setSpanContext(SpanContext spanContext) {
this.spanContext = spanContext == null ? SpanContext.getInvalid() : spanContext;
return this;
}

Expand Down
44 changes: 42 additions & 2 deletions sdk/logs/src/test/java/io/opentelemetry/sdk/logs/data/LogDataBuilderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,65 @@
package io.opentelemetry.sdk.logs.data;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.api.trace.TraceFlags;
import io.opentelemetry.api.trace.TraceState;
import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.common.Clock;
import io.opentelemetry.sdk.common.InstrumentationLibraryInfo;
import io.opentelemetry.sdk.resources.Resource;
import org.junit.jupiter.api.Test;

class LogDataBuilderTest {

private final Resource resource = Resource.getDefault();
private final InstrumentationLibraryInfo libraryInfo = InstrumentationLibraryInfo.empty();

@Test
void canSetClock() {
Resource resource = Resource.getDefault();
InstrumentationLibraryInfo libraryInfo = InstrumentationLibraryInfo.empty();
Clock clock = mock(Clock.class);
when(clock.now()).thenReturn(12L);
LogDataBuilder builder = LogDataBuilder.create(resource, libraryInfo, clock);

LogData result = builder.build();
assertEquals(12L, result.getEpochNanos());
}

@Test
void canSetSpanContext() {
LogDataBuilder builder = LogDataBuilder.create(resource, libraryInfo);
SpanContext spanContext = mock(SpanContext.class);
LogData result = builder.setSpanContext(spanContext).build();
assertSame(spanContext, result.getSpanContext());
}

@Test
void setSpanContext_nullSafe() {
LogDataBuilder builder = LogDataBuilder.create(resource, libraryInfo);
LogData result = builder.setSpanContext(null).build();
assertSame(SpanContext.getInvalid(), result.getSpanContext());
}

@Test
void canSetSpanContextFromContext() {
String traceId = "33333333333333333333333333333333";
String spanId = "7777777777777777";
SpanContext spanContext =
SpanContext.create(traceId, spanId, TraceFlags.getSampled(), TraceState.getDefault());
Span span = Span.wrap(spanContext);

Context context = mock(Context.class);
when(context.get(any())).thenReturn(span);

LogDataBuilder builder = LogDataBuilder.create(resource, libraryInfo);

LogData result = builder.setContext(context).build();
assertSame(spanContext, result.getSpanContext());
}
}

0 comments on commit 0423949

Please sign in to comment.