Package io.opentelemetry.api.incubator.common

Interface ExtendedAttributeKey<T>

Type Parameters:

T - The type of value that can be set with the key.

@Immutable
public interface ExtendedAttributeKey<T>

This interface provides a handle for setting the values of ExtendedAttributes. The type of value that can be set with an implementation of this key is denoted by the type parameter.

Implementations MUST be immutable, as these are used as the keys to Maps.

The allowed getType()s is a superset of those allowed in AttributeKey.

Convenience methods are provided for translating to / from AttributeKey:

• asAttributeKey() converts from ExtendedAttributeKey to AttributeKey
• fromAttributeKey(AttributeKey) converts from AttributeKey to ExtendedAttributeKey

Method Summary

Modifier and Type	Method	Description
default io.opentelemetry.api.common.AttributeKey<T>	asAttributeKey()	Return the equivalent AttributeKey, or null if the getType() has no equivalent AttributeType.
static ExtendedAttributeKey<List<Boolean>>	booleanArrayKey(String key)	Returns a new ExtendedAttributeKey for List<Boolean> valued attributes.
static ExtendedAttributeKey<Boolean>	booleanKey(String key)	Returns a new ExtendedAttributeKey for Boolean valued attributes.
static ExtendedAttributeKey<List<Double>>	doubleArrayKey(String key)	Returns a new ExtendedAttributeKey for List<Double> valued attributes.
static ExtendedAttributeKey<Double>	doubleKey(String key)	Returns a new ExtendedAttributeKey for Double valued attributes.
static ExtendedAttributeKey<ExtendedAttributes>	extendedAttributesKey(String key)	Deprecated. Use valueKey(String) in combination with Value.of(java.util.Map) instead.
static <T> ExtendedAttributeKey<T>	fromAttributeKey(io.opentelemetry.api.common.AttributeKey<T> attributeKey)	Return an ExtendedAttributeKey equivalent to the attributeKey.
String	getKey()	Returns the underlying String representation of the key.
ExtendedAttributeType	getType()	Returns the type of attribute for this key.
static ExtendedAttributeKey<List<Long>>	longArrayKey(String key)	Returns a new ExtendedAttributeKey for List<Long> valued attributes.
static ExtendedAttributeKey<Long>	longKey(String key)	Returns a new ExtendedAttributeKey for Long valued attributes.
static ExtendedAttributeKey<List<String>>	stringArrayKey(String key)	Returns a new ExtendedAttributeKey for List<String> valued attributes.
static ExtendedAttributeKey<String>	stringKey(String key)	Returns a new ExtendedAttributeKey for String valued attributes.
static ExtendedAttributeKey<io.opentelemetry.api.common.Value<?>>	valueKey(String key)	Returns a new ExtendedAttributeKey for Value valued attributes.

Method Details

getKey

String getKey()

Returns the underlying String representation of the key.

getType

ExtendedAttributeType getType()

Returns the type of attribute for this key. Useful for building switch statements.

asAttributeKey

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

Return the equivalent AttributeKey, or null if the getType() has no equivalent AttributeType.

fromAttributeKey

static <T> ExtendedAttributeKey<T> fromAttributeKey(io.opentelemetry.api.common.AttributeKey<T> attributeKey)

Return an ExtendedAttributeKey equivalent to the attributeKey.

stringKey

static ExtendedAttributeKey<String> stringKey(String key)

Returns a new ExtendedAttributeKey for String valued attributes.

booleanKey

static ExtendedAttributeKey<Boolean> booleanKey(String key)

Returns a new ExtendedAttributeKey for Boolean valued attributes.

longKey

static ExtendedAttributeKey<Long> longKey(String key)

Returns a new ExtendedAttributeKey for Long valued attributes.

doubleKey

static ExtendedAttributeKey<Double> doubleKey(String key)

Returns a new ExtendedAttributeKey for Double valued attributes.

stringArrayKey

static ExtendedAttributeKey<List<String>> stringArrayKey(String key)

Returns a new ExtendedAttributeKey for List<String> valued attributes.

booleanArrayKey

static ExtendedAttributeKey<List<Boolean>> booleanArrayKey(String key)

Returns a new ExtendedAttributeKey for List<Boolean> valued attributes.

longArrayKey

static ExtendedAttributeKey<List<Long>> longArrayKey(String key)

Returns a new ExtendedAttributeKey for List<Long> valued attributes.

doubleArrayKey

static ExtendedAttributeKey<List<Double>> doubleArrayKey(String key)

Returns a new ExtendedAttributeKey for List<Double> valued attributes.

extendedAttributesKey

@Deprecated
static ExtendedAttributeKey<ExtendedAttributes> extendedAttributesKey(String key)

Deprecated.

Use valueKey(String) in combination with Value.of(java.util.Map) instead.

Returns a new ExtendedAttributeKey for ExtendedAttributes valued attributes.

valueKey

static ExtendedAttributeKey<io.opentelemetry.api.common.Value<?>> valueKey(String key)

Returns a new ExtendedAttributeKey for Value valued attributes.

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.