Package io.opentelemetry.api.incubator.common

Interface ExtendedAttributes

@Immutable
public interface ExtendedAttributes

An immutable container for extended attributes.

"extended" refers an extended set of allowed value types compared to standard Attributes. Notably, ExtendedAttributes values can be of type ExtendedAttributeType.EXTENDED_ATTRIBUTES, allowing nested ExtendedAttributes of arbitrary depth.

Where standard Attributes are accepted everyone that OpenTelemetry represents key / value pairs, ExtendedAttributes are only accepted in select places, such as log records (e.g. ExtendedLogRecordBuilder.setAttribute(ExtendedAttributeKey, Object)).

The keys are ExtendedAttributeKeys and the values are Object instances that match the type of the provided key.

Null keys will be silently dropped.

Note: The behavior of null-valued attributes is undefined, and hence strongly discouraged.

Implementations of this interface *must* be immutable and have well-defined value-based equals/hashCode implementations. If an implementation does not strictly conform to these requirements, behavior of the OpenTelemetry APIs and default SDK cannot be guaranteed.

For this reason, it is strongly suggested that you use the implementation that is provided here via the factory methods and the ExtendedAttributesBuilder.

Convenience methods are provided for translating to / from Attributes:

• asAttributes() converts from ExtendedAttributes to Attributes
• ExtendedAttributesBuilder.putAll(Attributes) converts from Attributes to ExtendedAttributes
• get(AttributeKey) supports reading values using standard AttributeKey

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.api.common.Attributes	asAttributes()	Return a view of this extended attributes with entries limited to those representable as standard attributes.
Map<ExtendedAttributeKey<?>,Object>	asMap()	Returns a read-only view of this ExtendedAttributes as a Map.
static ExtendedAttributesBuilder	builder()	Returns a new ExtendedAttributesBuilder instance for creating arbitrary ExtendedAttributes.
static ExtendedAttributes	empty()	Returns a ExtendedAttributes instance with no attributes.
void	forEach(BiConsumer<? super ExtendedAttributeKey<?>,? super Object> consumer)	Iterates over all the key-value pairs of attributes contained by this instance.
default <T> T	get(io.opentelemetry.api.common.AttributeKey<T> key)	Returns the value for the given AttributeKey, or null if not found.
<T> T	get(ExtendedAttributeKey<T> key)	Returns the value for the given ExtendedAttributeKey, or null if not found.
boolean	isEmpty()	Whether there are any attributes contained in this.
int	size()	The number of attributes contained in this.
ExtendedAttributesBuilder	toBuilder()	Returns a new ExtendedAttributesBuilder instance populated with the data of this ExtendedAttributes.

Method Details

get

@Nullable
default <T> T get(io.opentelemetry.api.common.AttributeKey<T> key)

Returns the value for the given AttributeKey, or null if not found.

get

@Nullable
<T> T get(ExtendedAttributeKey<T> key)

Returns the value for the given ExtendedAttributeKey, or null if not found.

forEach

void forEach(BiConsumer<? super ExtendedAttributeKey<?>,? super Object> consumer)

Iterates over all the key-value pairs of attributes contained by this instance.

size

int size()

The number of attributes contained in this.

isEmpty

boolean isEmpty()

Whether there are any attributes contained in this.

asMap

Map<ExtendedAttributeKey<?>,Object> asMap()

Returns a read-only view of this ExtendedAttributes as a Map.

asAttributes

io.opentelemetry.api.common.Attributes asAttributes()

Return a view of this extended attributes with entries limited to those representable as standard attributes.

empty

static ExtendedAttributes empty()

Returns a ExtendedAttributes instance with no attributes.

builder

static ExtendedAttributesBuilder builder()

Returns a new ExtendedAttributesBuilder instance for creating arbitrary ExtendedAttributes.

toBuilder

ExtendedAttributesBuilder toBuilder()

Returns a new ExtendedAttributesBuilder instance populated with the data of this ExtendedAttributes.