Skip to content

Refactor Log SDK to implement OTEP-0150 #3759

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

Merged
anuraaga merged 16 commits into from
Nov 1, 2021
Merged

Refactor Log SDK to implement OTEP-0150 #3759

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
41ee190
Add log processors to the builder so LogSinkSdkProvider is immutable
jack-berg Oct 14, 2021
b4950f6
Add api diff
jack-berg Oct 14, 2021
8f66d07
Rename to SdkLogSinkProvider
jack-berg Oct 15, 2021
baa8013
Rework log sdk
jack-berg Oct 15, 2021
7c60e38
Refactor logging sdk to implement OTEP-0150
jack-berg Oct 18, 2021
66a0f3b
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Oct 18, 2021
d7208c3
Fix typo
jack-berg Oct 18, 2021
95274e7
Add unit tests
jack-berg Oct 19, 2021
56072d2
Reorganize to facilitate potential future API
jack-berg Oct 20, 2021
291254e
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Oct 27, 2021
52aa806
Rename ReadableLog* to SdkLog*, make SdkLog* package private
jack-berg Oct 27, 2021
21a98e3
Add LogEmitterProvider interface, tidy up some javadoc
jack-berg Oct 27, 2021
f9e31ac
Respond to PR feedback
jack-berg Oct 28, 2021
8d4785c
Make SdkLogEmitterBuilder final
jack-berg Oct 28, 2021
ca91bec
Switch to LogEmitter.logBuilder().emit() pattern
jack-berg Oct 29, 2021
a80ddb8
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Oct 29, 2021
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
50 changes: 28 additions & 22 deletions .../src/test/java/io/opentelemetry/exporter/logging/otlp/OtlpJsonLoggingLogExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,30 +31,36 @@ class OtlpJsonLoggingLogExporterTest {
Resource.create(Attributes.builder().put("key", "value").build());

private static final LogData LOG1 =
LogRecord.builder(RESOURCE, InstrumentationLibraryInfo.create("instrumentation", "1"))
.setName("testLog1")
.setBody("body1")
.setFlags(0)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setSpanId("8765432112345876")
.setTraceId("12345678876543211234567887654322")
.setEpochMillis(1631533710L)
.setAttributes(Attributes.of(stringKey("animal"), "cat", longKey("lives"), 9L))
.build();
LogData.create(
RESOURCE,
InstrumentationLibraryInfo.create("instrumentation", "1"),
LogRecord.builder()
.setName("testLog1")
.setBody("body1")
.setFlags(0)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setSpanId("8765432112345876")
.setTraceId("12345678876543211234567887654322")
.setEpochMillis(1631533710L)
.setAttributes(Attributes.of(stringKey("animal"), "cat", longKey("lives"), 9L))
.build());

private static final LogData LOG2 =
LogRecord.builder(RESOURCE, InstrumentationLibraryInfo.create("instrumentation2", "2"))
.setName("testLog2")
.setBody("body2")
.setFlags(0)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setSpanId("8765432112345875")
.setTraceId("12345678876543211234567887654322")
.setEpochMillis(1631533710L)
.setAttributes(Attributes.of(booleanKey("important"), true))
.build();
LogData.create(
RESOURCE,
InstrumentationLibraryInfo.create("instrumentation2", "2"),
LogRecord.builder()
.setName("testLog2")
.setBody("body2")
.setFlags(0)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setSpanId("8765432112345875")
.setTraceId("12345678876543211234567887654322")
.setEpochMillis(1631533710L)
.setAttributes(Attributes.of(booleanKey("important"), true))
.build());

@RegisterExtension
LogCapturer logs = LogCapturer.create().captureForType(OtlpJsonLoggingLogExporter.class);
Expand Down
19 changes: 11 additions & 8 deletions ...ers/logging/src/test/java/io/opentelemetry/exporter/logging/SystemOutLogExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,16 @@ void format() {
}

private static LogData sampleLog(long timestamp) {
return LogRecord.builder(Resource.empty(), InstrumentationLibraryInfo.create("logTest", "1.0"))
.setAttributes(Attributes.of(stringKey("cheese"), "cheddar", longKey("amount"), 1L))
.setBody(Body.stringBody("message"))
.setSeverity(Severity.ERROR3)
.setEpochMillis(timestamp)
.setTraceId(TraceId.fromLongs(1, 2))
.setSpanId(SpanId.fromLong(3))
.build();
return LogData.create(
Resource.empty(),
InstrumentationLibraryInfo.create("logTest", "1.0"),
LogRecord.builder()
.setAttributes(Attributes.of(stringKey("cheese"), "cheddar", longKey("amount"), 1L))
.setBody(Body.stringBody("message"))
.setSeverity(Severity.ERROR3)
.setEpochMillis(timestamp)
.setTraceId(TraceId.fromLongs(1, 2))
.setSpanId(SpanId.fromLong(3))
.build());
}
}
27 changes: 14 additions & 13 deletions .../logs/src/test/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,18 +319,19 @@ private static <T extends Message> HttpResponse buildResponse(HttpStatus httpSta
}

private static LogData generateFakeLog() {
return LogRecord.builder(
Resource.getDefault(),
InstrumentationLibraryInfo.create("testLib", "1.0", "http://url"))
.setName("log-name")
.setBody(Body.stringBody("log body"))
.setAttributes(Attributes.builder().put("key", "value").build())
.setSeverity(Severity.INFO)
.setSeverityText(Severity.INFO.name())
.setTraceId(IdGenerator.random().generateTraceId())
.setSpanId(IdGenerator.random().generateSpanId())
.setEpochNanos(TimeUnit.MILLISECONDS.toNanos(Instant.now().toEpochMilli()))
.setFlags(0)
.build();
return LogData.create(
Resource.getDefault(),
InstrumentationLibraryInfo.create("testLib", "1.0", "http://url"),
LogRecord.builder()
.setName("log-name")
.setBody(Body.stringBody("log body"))
.setAttributes(Attributes.builder().put("key", "value").build())
.setSeverity(Severity.INFO)
.setSeverityText(Severity.INFO.name())
.setTraceId(IdGenerator.random().generateTraceId())
.setSpanId(IdGenerator.random().generateSpanId())
.setEpochNanos(TimeUnit.MILLISECONDS.toNanos(Instant.now().toEpochMilli()))
.setFlags(0)
.build());
}
}
3 changes: 1 addition & 2 deletions ...mmon/src/main/java/io/opentelemetry/exporter/otlp/internal/logs/LogsRequestMarshaler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,12 @@
import io.opentelemetry.exporter.otlp.internal.Serializer;
import io.opentelemetry.proto.collector.logs.v1.internal.ExportLogsServiceRequest;
import io.opentelemetry.sdk.logs.data.LogData;
import io.opentelemetry.sdk.logs.data.LogRecord;
import io.opentelemetry.sdk.trace.data.SpanData;
import java.io.IOException;
import java.util.Collection;

/**
* {@link Marshaler} to convert SDK {@link LogRecord} to OTLP ExportLogsServiceRequest.
* {@link Marshaler} to convert SDK {@link LogData} to OTLP ExportLogsServiceRequest.
*
* <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
Expand Down
68 changes: 36 additions & 32 deletions .../src/test/java/io/opentelemetry/exporter/otlp/internal/logs/LogsRequestMarshalerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import io.opentelemetry.proto.logs.v1.LogRecord;
import io.opentelemetry.proto.logs.v1.ResourceLogs;
import io.opentelemetry.sdk.common.InstrumentationLibraryInfo;
import io.opentelemetry.sdk.logs.data.LogData;
import io.opentelemetry.sdk.logs.data.Severity;
import io.opentelemetry.sdk.resources.Resource;
import java.io.ByteArrayOutputStream;
Expand All @@ -49,18 +50,19 @@ void toProtoResourceLogs() {
ResourceLogsMarshaler[] resourceLogsMarshalers =
ResourceLogsMarshaler.create(
Collections.singleton(
io.opentelemetry.sdk.logs.data.LogRecord.builder(
Resource.builder().put("one", 1).setSchemaUrl("http://url").build(),
InstrumentationLibraryInfo.create("testLib", "1.0", "http://url"))
.setName(NAME)
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setTraceId(TRACE_ID)
.setSpanId(SPAN_ID)
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpochNanos(12345)
.build()));
LogData.create(
Resource.builder().put("one", 1).setSchemaUrl("http://url").build(),
InstrumentationLibraryInfo.create("testLib", "1.0", "http://url"),
io.opentelemetry.sdk.logs.data.LogRecord.builder()
.setName(NAME)
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setTraceId(TRACE_ID)
.setSpanId(SPAN_ID)
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpochNanos(12345)
.build())));

assertThat(resourceLogsMarshalers).hasSize(1);

Expand All @@ -82,18 +84,19 @@ void toProtoLogRecord() {
parse(
LogRecord.getDefaultInstance(),
LogMarshaler.create(
io.opentelemetry.sdk.logs.data.LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setName(NAME)
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setTraceId(TRACE_ID)
.setSpanId(SPAN_ID)
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpochNanos(12345)
.build()));
LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
io.opentelemetry.sdk.logs.data.LogRecord.builder()
.setName(NAME)
.setBody(BODY)
.setSeverity(Severity.INFO)
.setSeverityText("INFO")
.setTraceId(TRACE_ID)
.setSpanId(SPAN_ID)
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpochNanos(12345)
.build())));

assertThat(logRecord.getTraceId().toByteArray()).isEqualTo(TRACE_ID_BYTES);
assertThat(logRecord.getSpanId().toByteArray()).isEqualTo(SPAN_ID_BYTES);
Expand All @@ -115,14 +118,15 @@ void toProtoLogRecord_MinimalFields() {
parse(
LogRecord.getDefaultInstance(),
LogMarshaler.create(
io.opentelemetry.sdk.logs.data.LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setBody(BODY)
.setSeverity(Severity.INFO)
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpochNanos(12345)
.build()));
LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
io.opentelemetry.sdk.logs.data.LogRecord.builder()
.setBody(BODY)
.setSeverity(Severity.INFO)
.setAttributes(Attributes.of(AttributeKey.booleanKey("key"), true))
.setEpochNanos(12345)
.build())));

assertThat(logRecord.getTraceId().toByteArray()).isEmpty();
assertThat(logRecord.getSpanId().toByteArray()).isEmpty();
Expand Down
27 changes: 14 additions & 13 deletions ...otlp/logs/src/test/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogsExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,19 +357,20 @@ void usingGrpc() {
}

private static LogData generateFakeLog() {
return LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build();
return LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
LogRecord.builder()
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build());
}

private static final class FakeCollector extends LogsServiceGrpc.LogsServiceImplBase {
Expand Down
27 changes: 14 additions & 13 deletions ...ters/otlp/logs/src/testGrpcNetty/java/io/opentelemetry/exporter/otlp/logs/ExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@ class ExportTest {

private static final List<LogData> LOGS =
Collections.singletonList(
LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build());
LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
LogRecord.builder()
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build()));

@RegisterExtension
@Order(1)
Expand Down
27 changes: 14 additions & 13 deletions ...tlp/logs/src/testGrpcNettyShaded/java/io/opentelemetry/exporter/otlp/logs/ExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@ class ExportTest {

private static final List<LogData> LOGS =
Collections.singletonList(
LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build());
LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
LogRecord.builder()
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build()));

@RegisterExtension
@Order(1)
Expand Down
27 changes: 14 additions & 13 deletions ...ers/otlp/logs/src/testGrpcOkhttp/java/io/opentelemetry/exporter/otlp/logs/ExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@ class ExportTest {

private static final List<LogData> LOGS =
Collections.singletonList(
LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build());
LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
LogRecord.builder()
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build()));

@RegisterExtension
@Order(1)
Expand Down
27 changes: 14 additions & 13 deletions ...ogs/src/testOkHttpOnly/java/io/opentelemetry/exporter/otlp/logs/OkHttpOnlyExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,20 @@ class OkHttpOnlyExportTest {

private static final List<LogData> LOGS =
Collections.singletonList(
LogRecord.builder(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"))
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build());
LogData.create(
Resource.create(Attributes.builder().put("testKey", "testValue").build()),
InstrumentationLibraryInfo.create("instrumentation", "1"),
LogRecord.builder()
.setEpochMillis(System.currentTimeMillis())
.setTraceId(TraceId.getInvalid())
.setSpanId(SpanId.getInvalid())
.setFlags(TraceFlags.getDefault().asByte())
.setSeverity(Severity.ERROR)
.setSeverityText("really severe")
.setName("log1")
.setBody("message")
.setAttributes(Attributes.builder().put("animal", "cat").build())
.build()));

private static final HeldCertificate HELD_CERTIFICATE;
private static final String canonicalHostName;
Expand Down
Loading
⚡