Package io.opentelemetry.api.incubator.common

Interface ExtendedAttributesBuilder

public interface ExtendedAttributesBuilder

A builder of ExtendedAttributes supporting an arbitrary number of key-value pairs.

Method Summary

Modifier and Type	Method	Description
ExtendedAttributes	build()	Create the ExtendedAttributes from this.
default <T> ExtendedAttributesBuilder	put(io.opentelemetry.api.common.AttributeKey<List<T>> key, T... value)	Puts a List attribute into this.
default <T> ExtendedAttributesBuilder	put(io.opentelemetry.api.common.AttributeKey<T> key, T value)	Puts a AttributeKey with associated value into this.
<T> ExtendedAttributesBuilder	put(ExtendedAttributeKey<T> key, T value)	Puts an ExtendedAttributeKey with an associated value into this if the value is non-null.
default ExtendedAttributesBuilder	put(String key, boolean value)	Puts a boolean attribute into this.
default ExtendedAttributesBuilder	put(String key, boolean... value)	Puts a Boolean array attribute into this.
default ExtendedAttributesBuilder	put(String key, double value)	Puts a double attribute into this.
default ExtendedAttributesBuilder	put(String key, double... value)	Puts a Double array attribute into this.
default ExtendedAttributesBuilder	put(String key, long value)	Puts a long attribute into this.
default ExtendedAttributesBuilder	put(String key, long... value)	Puts a Long array attribute into this.
default <T> ExtendedAttributesBuilder	put(String key, ExtendedAttributes value)	Deprecated. Use put(ExtendedAttributeKey, Object) with Value.of(java.util.Map) instead.
default ExtendedAttributesBuilder	put(String key, String value)	Puts a String attribute into this.
default ExtendedAttributesBuilder	put(String key, String... value)	Puts a String array attribute into this.
default ExtendedAttributesBuilder	putAll(io.opentelemetry.api.common.Attributes attributes)	Puts all the provided attributes into this Builder.
default ExtendedAttributesBuilder	putAll(ExtendedAttributes attributes)	Puts all the provided attributes into this Builder.
default <T> ExtendedAttributesBuilder	remove(io.opentelemetry.api.common.AttributeKey<T> key)	Remove all attributes where AttributeKey.getKey() and AttributeKey.getType() match the key.
default <T> ExtendedAttributesBuilder	remove(ExtendedAttributeKey<T> key)	Remove all attributes where ExtendedAttributeKey.getKey() and ExtendedAttributeKey.getType() match the key.
ExtendedAttributesBuilder	removeIf(Predicate<ExtendedAttributeKey<?>> filter)	Remove all attributes that satisfy the given predicate.

Method Details

build

ExtendedAttributes build()

Create the ExtendedAttributes from this.

put

default <T> ExtendedAttributesBuilder put(io.opentelemetry.api.common.AttributeKey<T> key,
 T value)

Puts a AttributeKey with associated value into this.

put

<T> ExtendedAttributesBuilder put(ExtendedAttributeKey<T> key,
 T value)

Puts an ExtendedAttributeKey with an associated value into this if the value is non-null. Providing a null value does not remove or unset previously set values.

Simple attributes (ExtendedAttributeType.STRING, ExtendedAttributeType.LONG, ExtendedAttributeType.DOUBLE, ExtendedAttributeType.BOOLEAN, ExtendedAttributeType.STRING_ARRAY, ExtendedAttributeType.LONG_ARRAY, ExtendedAttributeType.DOUBLE_ARRAY, ExtendedAttributeType.BOOLEAN_ARRAY) SHOULD be used whenever possible. Instrumentations SHOULD assume that backends do not index individual properties of complex attributes, that querying or aggregating on such properties is inefficient and complicated, and that reporting complex attributes carries higher performance overhead.

Note: This method will automatically convert complex attributes (ExtendedAttributeType.VALUE) to simple attributes when possible.

• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of("a")) is equivalent to calling put(ExtendedAttributeKey.stringKey("key"), "a").
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(1L)) is equivalent to calling put(ExtendedAttributeKey.longKey("key"), 1L).
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(1.0)) is equivalent to calling put(ExtendedAttributeKey.doubleKey("key"), 1.0).
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(true)) is equivalent to calling put(ExtendedAttributeKey.booleanKey("key"), true).
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(Value.of("a"), Value.of("b"))) is equivalent to calling put(ExtendedAttributeKey.stringArrayKey("key"), Arrays.asList("a", "b")).
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(Value.of(1L), Value.of(2L))) is equivalent to calling put(ExtendedAttributeKey.longArrayKey("key"), Arrays.asList(1L, 2L)).
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(Value.of(1.0), Value.of(2.0))) is equivalent to calling put(ExtendedAttributeKey.doubleArrayKey("key"), Arrays.asList(1.0, 2.0)).
• Calling put(ExtendedAttributeKey.valueKey("key"), Value.of(Value.of(true), Value.of(false))) is equivalent to calling put(ExtendedAttributeKey.booleanArrayKey("key"), Arrays.asList(true, false)).

put

default ExtendedAttributesBuilder put(String key,
 String value)

Puts a String attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 long value)

Puts a long attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 double value)

Puts a double attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 boolean value)

Puts a boolean attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

@Deprecated
default <T> ExtendedAttributesBuilder put(String key,
 ExtendedAttributes value)

Deprecated.

Use put(ExtendedAttributeKey, Object) with Value.of(java.util.Map) instead.

Puts a ExtendedAttributes attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 String... value)

Puts a String array attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default <T> ExtendedAttributesBuilder put(io.opentelemetry.api.common.AttributeKey<List<T>> key,
 T... value)

Puts a List attribute into this.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 long... value)

Puts a Long array attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 double... value)

Puts a Double array attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default ExtendedAttributesBuilder put(String key,
 boolean... value)

Puts a Boolean array attribute into this.

Note: It is strongly recommended to use put(ExtendedAttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

putAll

default ExtendedAttributesBuilder putAll(io.opentelemetry.api.common.Attributes attributes)

Puts all the provided attributes into this Builder.

Returns:

this Builder

putAll

default ExtendedAttributesBuilder putAll(ExtendedAttributes attributes)

Puts all the provided attributes into this Builder.

Returns:

this Builder

remove

default <T> ExtendedAttributesBuilder remove(io.opentelemetry.api.common.AttributeKey<T> key)

Remove all attributes where AttributeKey.getKey() and AttributeKey.getType() match the key.

Returns:

this Builder

remove

default <T> ExtendedAttributesBuilder remove(ExtendedAttributeKey<T> key)

Remove all attributes where ExtendedAttributeKey.getKey() and ExtendedAttributeKey.getType() match the key.

Returns:

this Builder

removeIf

ExtendedAttributesBuilder removeIf(Predicate<ExtendedAttributeKey<?>> filter)

Remove all attributes that satisfy the given predicate. Errors or runtime exceptions thrown by the predicate are relayed to the caller.

Returns:

this Builder