OTLP exporter should tolerate instances of LogRecordData when incubator is present (#7393)

Author: jack-berg

exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/IncubatingUtil.java

@@ -28,11 +28,28 @@
  */
 public class IncubatingUtil {
 
+  private static final boolean INCUBATOR_AVAILABLE;
+
+  static {
+    boolean incubatorAvailable = false;
+    try {
+      Class.forName("io.opentelemetry.api.incubator.common.ExtendedAttributes");
+      incubatorAvailable = true;
+    } catch (ClassNotFoundException e) {
+      // Not available
+    }
+    INCUBATOR_AVAILABLE = incubatorAvailable;
+  }
+
   private static final byte[] EMPTY_BYTES = new byte[0];
   private static final KeyValueMarshaler[] EMPTY_REPEATED = new KeyValueMarshaler[0];
 
   private IncubatingUtil() {}
 
+  public static boolean isExtendedLogRecordData(LogRecordData logRecordData) {
+    return INCUBATOR_AVAILABLE && logRecordData instanceof ExtendedLogRecordData;
+  }
+
   @SuppressWarnings("AvoidObjectArrays")
   public static KeyValueMarshaler[] createdExtendedAttributesMarhsalers(
       LogRecordData logRecordData) {

exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogMarshaler.java

@@ -24,19 +24,6 @@
 import javax.annotation.Nullable;
 
 final class LogMarshaler extends MarshalerWithSize {
-  private static final boolean INCUBATOR_AVAILABLE;
-
-  static {
-    boolean incubatorAvailable = false;
-    try {
-      Class.forName("io.opentelemetry.api.incubator.common.ExtendedAttributes");
-      incubatorAvailable = true;
-    } catch (ClassNotFoundException e) {
-      // Not available
-    }
-    INCUBATOR_AVAILABLE = incubatorAvailable;
-  }
-
   private static final String INVALID_TRACE_ID = TraceId.getInvalid();
   private static final String INVALID_SPAN_ID = SpanId.getInvalid();
 
@@ -54,12 +41,12 @@ final class LogMarshaler extends MarshalerWithSize {
 
   static LogMarshaler create(LogRecordData logRecordData) {
     KeyValueMarshaler[] attributeMarshalers =
-        INCUBATOR_AVAILABLE
+        IncubatingUtil.isExtendedLogRecordData(logRecordData)
             ? IncubatingUtil.createdExtendedAttributesMarhsalers(logRecordData)
             : KeyValueMarshaler.createForAttributes(logRecordData.getAttributes());
 
     int attributeSize =
-        INCUBATOR_AVAILABLE
+        IncubatingUtil.isExtendedLogRecordData(logRecordData)
             ? IncubatingUtil.extendedAttributesSize(logRecordData)
             : logRecordData.getAttributes().size();
 

exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/logs/LogStatelessMarshaler.java

@@ -27,18 +27,6 @@ final class LogStatelessMarshaler implements StatelessMarshaler<LogRecordData> {
 
   private static final String INVALID_TRACE_ID = TraceId.getInvalid();
   private static final String INVALID_SPAN_ID = SpanId.getInvalid();
-  private static final boolean INCUBATOR_AVAILABLE;
-
-  static {
-    boolean incubatorAvailable = false;
-    try {
-      Class.forName("io.opentelemetry.api.incubator.common.ExtendedAttributes");
-      incubatorAvailable = true;
-    } catch (ClassNotFoundException e) {
-      // Not available
-    }
-    INCUBATOR_AVAILABLE = incubatorAvailable;
-  }
 
   static final LogStatelessMarshaler INSTANCE = new LogStatelessMarshaler();
 
@@ -56,7 +44,7 @@ public void writeTo(Serializer output, LogRecordData log, MarshalerContext conte
     }
 
     int droppedAttributesCount;
-    if (INCUBATOR_AVAILABLE) {
+    if (IncubatingUtil.isExtendedLogRecordData(log)) {
       IncubatingUtil.serializeExtendedAttributes(output, log, context);
       droppedAttributesCount =
           log.getTotalAttributeCount() - IncubatingUtil.extendedAttributesSize(log);
@@ -99,7 +87,7 @@ public int getBinarySerializedSize(LogRecordData log, MarshalerContext context)
           StatelessMarshalerUtil.sizeMessageWithContext(
               LogRecord.BODY, log.getBodyValue(), AnyValueStatelessMarshaler.INSTANCE, context);
     }
-    if (INCUBATOR_AVAILABLE) {
+    if (IncubatingUtil.isExtendedLogRecordData(log)) {
       size += IncubatingUtil.sizeExtendedAttributes(log, context);
 
       int droppedAttributesCount =

exporters/otlp/common/src/testIncubating/java/io/opentelemetry/exporter/internal/otlp/logs/LogsRequestMarshalerIncubatingTest.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.exporter.internal.otlp.logs;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatCode;
 
 import com.google.protobuf.ByteString;
 import com.google.protobuf.InvalidProtocolBufferException;
@@ -34,6 +35,7 @@
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
 import io.opentelemetry.sdk.logs.data.LogRecordData;
 import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.testing.logs.TestLogRecordData;
 import io.opentelemetry.sdk.testing.logs.internal.TestExtendedLogRecordData;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -56,6 +58,20 @@ class LogsRequestMarshalerIncubatingTest {
   private static final String EVENT_NAME = "hello";
   private static final String BODY = "Hello world from this log...";
 
+  // Marshalers should not throw if the incubator is on the class path, but are called with
+  // LogRecordData instances which are not ExtendedLogRecordData.
+  // See: https://github.com/open-telemetry/opentelemetry-java/issues/7363
+  @ParameterizedTest
+  @EnumSource(MarshalerSource.class)
+  void toProtoLogRecord_NotExtendedLogRecordData_DoesNotThrow(MarshalerSource marshalerSource) {
+    assertThatCode(
+            () ->
+                parse(
+                    LogRecord.getDefaultInstance(),
+                    marshalerSource.create(TestLogRecordData.builder().build())))
+        .doesNotThrowAnyException();
+  }
+
   @ParameterizedTest
   @EnumSource(MarshalerSource.class)
   void toProtoLogRecord(MarshalerSource marshalerSource) {