Stabilize log any value

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValue.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValue.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import java.nio.ByteBuffer;
 import java.util.List;
@@ -28,6 +28,9 @@
  *   <li>Raw bytes via {@link #of(byte[])}
  * </ul>
  *
+ * <p>Currently, AnyValue is only used as an argument for {@link
+ * io.opentelemetry.api.logs.LogRecordBuilder#setBody(AnyValue)}.
+ *
  * @param <T> the type. See {@link #getValue()} for description of types.
  */
 public interface AnyValue<T> {
@@ -105,6 +108,9 @@ static AnyValue<List<KeyAnyValue>> of(Map<String, AnyValue<?>> value) {
    * Return a string encoding of this {@link AnyValue}. This is intended to be a fallback serialized
    * representation in case there is no suitable encoding that can utilize {@link #getType()} /
    * {@link #getValue()} to serialize specific types.
+   *
+   * <p>WARNING: No guarantees are made about the encoding of this string response. It MAY change in
+   * a future minor release. If you need a reliable string encoding, write your own serializer.
    */
   // TODO(jack-berg): Should this be a JSON encoding?
   String asString();

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueArray.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueArray.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import static java.util.stream.Collectors.joining;
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueBoolean.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueBoolean.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import java.util.Objects;
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueBytes.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueBytes.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import java.nio.ByteBuffer;
 import java.util.Arrays;

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueDouble.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueDouble.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import java.util.Objects;
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueLong.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueLong.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import java.util.Objects;
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueString.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueString.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import java.util.Objects;
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/AnyValueType.java → api/all/src/main/java/io/opentelemetry/api/common/AnyValueType.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 /**
  * AnyValue type options, mirroring <a

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/KeyAnyValue.java → api/all/src/main/java/io/opentelemetry/api/common/KeyAnyValue.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 /**
  * Key-value pair of {@link String} key and {@link AnyValue} value.

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/KeyAnyValueImpl.java → api/all/src/main/java/io/opentelemetry/api/common/KeyAnyValueImpl.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import com.google.auto.value.AutoValue;
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/KeyAnyValueList.java → api/all/src/main/java/io/opentelemetry/api/common/KeyAnyValueList.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.logs;
+package io.opentelemetry.api.common;
 
 import static java.util.stream.Collectors.joining;
 

api/all/src/main/java/io/opentelemetry/api/logs/DefaultLogger.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.api.logs;
 
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.context.Context;
 import java.time.Instant;
@@ -70,6 +71,11 @@ public LogRecordBuilder setBody(String body) {
       return this;
     }
 
+    @Override
+    public LogRecordBuilder setBody(AnyValue<?> body) {
+      return this;
+    }
+
     @Override
     public <T> LogRecordBuilder setAttribute(AttributeKey<T> key, T value) {
       return this;

api/all/src/main/java/io/opentelemetry/api/logs/LogRecordBuilder.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.api.logs;
 
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.context.Context;
@@ -66,9 +67,19 @@
   /** Set the severity text. */
   LogRecordBuilder setSeverityText(String severityText);
 
-  /** Set the body string. */
+  /**
+   * Set the body string.
+   *
+   * <p>Shorthand for calling {@link #setBody(AnyValue)} with {@link AnyValue#of(String)}.
+   */
   LogRecordBuilder setBody(String body);
 
+  /** Set the body {@link AnyValue}. */
+  default LogRecordBuilder setBody(AnyValue<?> body) {
+    setBody(body.asString());
+    return this;
+  }
+
   /**
    * Sets attributes. If the {@link LogRecordBuilder} previously contained a mapping for any of the
    * keys, the old values are replaced by the specified values.

api/all/src/test/java/io/opentelemetry/api/logs/DefaultLoggerTest.java

@@ -7,6 +7,7 @@
 
 import static org.assertj.core.api.Assertions.assertThatCode;
 
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.context.Context;
@@ -30,6 +31,7 @@ void buildAndEmit() {
                     .setSeverity(Severity.DEBUG)
                     .setSeverityText("debug")
                     .setBody("body")
+                    .setBody(AnyValue.of("body"))
                     .setAttribute(AttributeKey.stringKey("key1"), "value1")
                     .setAllAttributes(Attributes.builder().put("key2", "value2").build())
                     .emit())

api/incubator/README.md

@@ -14,8 +14,7 @@ See [EventApiUsageTest](./src/test/java/io/opentelemetry/api/incubator/events/Ev
 
 Features:
 
-* Check if logger is enabled before emitting logs to avoid uneccessary computation
-* Set AnyValue log record body with arbitrarily complex data
+* Check if logger is enabled before emitting logs to avoid unnecessary computation
 
 See [ExtendedLogsBridgeApiUsageTest](./src/test/java/io/opentelemetry/api/incubator/logs/ExtendedLogsBridgeApiUsageTest.java).
 
@@ -31,7 +30,7 @@ See [ExtendedMetricsApiUsageTest](./src/test/java/io/opentelemetry/api/incubator
 
 Features:
 
-* Check if instrument is enabled before recording measurements to avoid uneccessary computation
+* Check if instrument is enabled before recording measurements to avoid unnecessary computation
 * Simplified injection / extraction of context
 
 See [ExtendedContextPropagatorsUsageTest](./src/test/java/io/opentelemetry/api/incubator/propagation/ExtendedContextPropagatorsUsageTest.java).
@@ -40,7 +39,7 @@ See [ExtendedContextPropagatorsUsageTest](./src/test/java/io/opentelemetry/api/i
 
 Features:
 
-* Check if tracer is enabled before starting spans to avoid uneccessary computation
+* Check if tracer is enabled before starting spans to avoid unnecessary computation
 * Utility methods to reduce boilerplace using span API, including extracting context, and wrapping runnables / callables with spans
 
 See [ExtendedTraceApiUsageTest](./src/test/java/io/opentelemetry/api/incubator/trace/ExtendedTraceApiUsageTest.java).

api/incubator/src/main/java/io/opentelemetry/api/incubator/events/DefaultEventLogger.java

@@ -5,8 +5,8 @@
 
 package io.opentelemetry.api.incubator.events;
 
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.incubator.logs.AnyValue;
 import io.opentelemetry.api.logs.Severity;
 import io.opentelemetry.context.Context;
 import java.time.Instant;

api/incubator/src/main/java/io/opentelemetry/api/incubator/events/EventBuilder.java

@@ -7,9 +7,9 @@
 
 import static java.util.stream.Collectors.toList;
 
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.incubator.logs.AnyValue;
 import io.opentelemetry.api.logs.Severity;
 import io.opentelemetry.context.Context;
 import java.time.Instant;

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/ExtendedLogRecordBuilder.java

@@ -10,6 +10,6 @@
 /** Extended {@link LogRecordBuilder} with experimental APIs. */
 public interface ExtendedLogRecordBuilder extends LogRecordBuilder {
 
-  /** Set the body {@link AnyValue}. */
-  LogRecordBuilder setBody(AnyValue<?> body);
+  // Nothing at the moment, but experimental methods may be added in the future.
+
 }

api/incubator/src/test/java/io/opentelemetry/api/incubator/events/DefaultEventLoggerTest.java

@@ -7,9 +7,9 @@
 
 import static org.assertj.core.api.Assertions.assertThatCode;
 
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.incubator.logs.AnyValue;
 import io.opentelemetry.api.logs.Severity;
 import io.opentelemetry.context.Context;
 import java.time.Instant;

api/incubator/src/test/java/io/opentelemetry/api/incubator/events/EventApiUsageTest.java

@@ -8,11 +8,10 @@
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
 
 import com.google.common.collect.ImmutableMap;
+import io.opentelemetry.api.common.AnyValue;
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.incubator.logs.AnyValue;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.export.SimpleLogRecordProcessor;
-import io.opentelemetry.sdk.logs.internal.AnyValueBody;
 import io.opentelemetry.sdk.logs.internal.SdkEventLoggerProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.testing.exporter.InMemoryLogRecordExporter;
@@ -64,7 +63,8 @@ void eventApiUsage() {
               assertThat(logData)
                   .hasAttributes(
                       Attributes.builder().put("event.name", "org.foo.my-event").build());
-              assertThat(((AnyValueBody) logData.getBody()).asAnyValue())
+              assertThat(logData.getAnyValueBody())
+                  .isNotNull()
                   .isEqualTo(
                       AnyValue.of(
                           ImmutableMap.of(

api/incubator/src/test/java/io/opentelemetry/api/incubator/logs/AnyValueTest.java

@@ -9,6 +9,9 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 
+import io.opentelemetry.api.common.AnyValue;
+import io.opentelemetry.api.common.AnyValueType;
+import io.opentelemetry.api.common.KeyAnyValue;
 import java.nio.ByteBuffer;
 import java.nio.ReadOnlyBufferException;
 import java.nio.charset.StandardCharsets;

api/incubator/src/test/java/io/opentelemetry/api/incubator/logs/ExtendedLogsBridgeApiUsageTest.java

@@ -9,18 +9,14 @@
 import static io.opentelemetry.sdk.logs.internal.LoggerConfig.disabled;
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
 
-import com.google.common.collect.ImmutableMap;
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.logs.Logger;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
 import io.opentelemetry.sdk.logs.export.SimpleLogRecordProcessor;
-import io.opentelemetry.sdk.logs.internal.AnyValueBody;
 import io.opentelemetry.sdk.logs.internal.SdkLoggerProviderUtil;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.testing.exporter.InMemoryLogRecordExporter;
 import java.util.Random;
-import java.util.concurrent.TimeUnit;
 import org.junit.jupiter.api.Test;
 
 /** Demonstrating usage of extended Logs Bridge API. */
@@ -80,56 +76,4 @@ void loggerEnabled() {
   private static String flipCoin() {
     return random.nextBoolean() ? "heads" : "tails";
   }
-
-  @Test
-  void extendedLogRecordBuilderUsage() {
-    // Setup SdkLoggerProvider
-    InMemoryLogRecordExporter exporter = InMemoryLogRecordExporter.create();
-    SdkLoggerProvider loggerProvider =
-        SdkLoggerProvider.builder()
-            // Default resource used for demonstration purposes
-            .setResource(Resource.getDefault())
-            // Simple processor w/ in-memory exporter used for demonstration purposes
-            .addLogRecordProcessor(SimpleLogRecordProcessor.create(exporter))
-            .build();
-
-    // Get a Logger for a scope
-    Logger logger = loggerProvider.get("org.foo.my-scope");
-
-    // Cast to ExtendedLogRecordBuilder, and emit a log
-    ((ExtendedLogRecordBuilder) logger.logRecordBuilder())
-        // ...can set AnyValue log record body, allowing for arbitrarily complex data
-        .setBody(
-            AnyValue.of(
-                ImmutableMap.of(
-                    "key1",
-                    AnyValue.of("value1"),
-                    "key2",
-                    AnyValue.of(
-                        ImmutableMap.of(
-                            "childKey1",
-                            AnyValue.of("value2"),
-                            "childKey2",
-                            AnyValue.of("value3"))))))
-        .emit();
-
-    // SDK can access AnyValue body by casting to AnyValueBody
-    loggerProvider.forceFlush().join(10, TimeUnit.SECONDS);
-    assertThat(exporter.getFinishedLogRecordItems())
-        .satisfiesExactly(
-            logData ->
-                assertThat(((AnyValueBody) logData.getBody()).asAnyValue())
-                    .isEqualTo(
-                        AnyValue.of(
-                            ImmutableMap.of(
-                                "key1",
-                                AnyValue.of("value1"),
-                                "key2",
-                                AnyValue.of(
-                                    ImmutableMap.of(
-                                        "childKey1",
-                                        AnyValue.of("value2"),
-                                        "childKey2",
-                                        AnyValue.of("value3")))))));
-  }
 }

buildSrc/src/main/kotlin/otel.japicmp-conventions.gradle.kts

@@ -29,18 +29,21 @@ class AllowNewAbstractMethodOnAutovalueClasses : AbstractRecordingSeenMembers()
   override fun maybeAddViolation(member: JApiCompatibility): Violation? {
     val allowableAutovalueChanges = setOf(JApiCompatibilityChange.METHOD_ABSTRACT_ADDED_TO_CLASS, JApiCompatibilityChange.METHOD_ADDED_TO_PUBLIC_CLASS)
     if (member.compatibilityChanges.filter { !allowableAutovalueChanges.contains(it) }.isEmpty() &&
-      member is JApiMethod &&
-      member.getjApiClass().newClass.get().getAnnotation(AutoValue::class.java) != null
-    ) {
+      member is JApiMethod && isAutoValueClass(member.getjApiClass()))
+    {
       return Violation.accept(member, "Autovalue will automatically add implementation")
     }
     if (member.compatibilityChanges.isEmpty() &&
-      member is JApiClass &&
-      member.newClass.get().getAnnotation(AutoValue::class.java) != null) {
+      member is JApiClass && isAutoValueClass(member)) {
       return Violation.accept(member, "Autovalue class modification is allowed")
     }
     return null
   }
+
+  fun isAutoValueClass(japiClass: JApiClass): Boolean {
+    return japiClass.newClass.get().getAnnotation(AutoValue::class.java) != null ||
+        japiClass.newClass.get().getAnnotation(AutoValue.Builder::class.java) != null
+  }
 }
 
 class SourceIncompatibleRule : AbstractRecordingSeenMembers() {