Update javadoc to allow null/empty attr values (#5616)

open-telemetry · Jul 11, 2023 · 16e7113 · 16e7113
1 parent a781ba8
commit 16e7113
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/api/all/src/main/java/io/opentelemetry/api/trace/Span.java b/api/all/src/main/java/io/opentelemetry/api/trace/Span.java
@@ -91,8 +91,7 @@ static Span wrap(SpanContext spanContext) {
    * Sets an attribute to the {@code Span}. If the {@code Span} previously contained a mapping for
    * the key, the old value is replaced by the specified value.
    *
-   * <p>If a null or empty String {@code value} is passed in, the behavior is undefined, and hence
-   * strongly discouraged.
+   * <p>Empty String "" and null are valid attribute {@code value}, but not valid keys.
    *
    * <p>Note: It is strongly recommended to use {@link #setAttribute(AttributeKey, Object)}, and
    * pre-allocate your keys, if possible.

diff --git a/api/all/src/test/java/io/opentelemetry/api/common/AttributesTest.java b/api/all/src/test/java/io/opentelemetry/api/common/AttributesTest.java
@@ -578,4 +578,11 @@ public AttributesBuilder putAll(Attributes attributes) {
     assertThatCode(() -> myAttributesBuilder.remove(stringKey("foo"))).doesNotThrowAnyException();
     assertThatCode(() -> myAttributesBuilder.removeIf(unused -> false)).doesNotThrowAnyException();
   }
+
+  @Test
+  void emptyValueIsValid() {
+    AttributeKey<String> key = stringKey("anything");
+    Attributes attributes = Attributes.of(key, "");
+    assertThat(attributes.get(key)).isEqualTo("");
+  }
 }