Package io.opentelemetry.semconv

Class AttributeKeyTemplate<T>

java.lang.Object

io.opentelemetry.semconv.AttributeKeyTemplate<T>

Type Parameters:

T - The type of the nested AttributeKeys.

public final class AttributeKeyTemplate<T>
extends Object

This class provides a handle for creating and caching dynamic / template-type attributes of the form <prefix>.<key>. The <prefix> is fixed for a template instance while AttributeKeys can be created and are cached for different values of the <key> part.

An example template-type attribute is the set of attributes for HTTP headers: http.request.header.<key>

Method Summary

Modifier and Type	Method	Description
static AttributeKeyTemplate<List<Boolean>>	booleanArrayKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.BOOLEAN_ARRAY and the given prefix.
static AttributeKeyTemplate<Boolean>	booleanKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.BOOLEAN and the given prefix.
static AttributeKeyTemplate<List<Double>>	doubleArrayKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.DOUBLE_ARRAY and the given prefix.
static AttributeKeyTemplate<Double>	doubleKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.DOUBLE and the given prefix.
io.opentelemetry.api.common.AttributeKey<T>	getAttributeKey(String key)	Returns an AttributeKey object for the given attribute key whereby the key is the variable part of the full attribute name in a template-typed attribute, for example http.request.header.<key>.
static AttributeKeyTemplate<List<Long>>	longArrayKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.LONG_ARRAY and the given prefix.
static AttributeKeyTemplate<Long>	longKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.LONG and the given prefix.
static AttributeKeyTemplate<List<String>>	stringArrayKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.STRING_ARRAY and the given prefix.
static AttributeKeyTemplate<String>	stringKeyTemplate(String prefix)	Create an AttributeKeyTemplate with type AttributeType.STRING and the given prefix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

stringKeyTemplate

public static AttributeKeyTemplate<String> stringKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.STRING and the given prefix.

stringArrayKeyTemplate

public static AttributeKeyTemplate<List<String>> stringArrayKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.STRING_ARRAY and the given prefix.

booleanKeyTemplate

public static AttributeKeyTemplate<Boolean> booleanKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.BOOLEAN and the given prefix.

booleanArrayKeyTemplate

public static AttributeKeyTemplate<List<Boolean>> booleanArrayKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.BOOLEAN_ARRAY and the given prefix.

longKeyTemplate

public static AttributeKeyTemplate<Long> longKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.LONG and the given prefix.

longArrayKeyTemplate

public static AttributeKeyTemplate<List<Long>> longArrayKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.LONG_ARRAY and the given prefix.

doubleKeyTemplate

public static AttributeKeyTemplate<Double> doubleKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.DOUBLE and the given prefix.

doubleArrayKeyTemplate

public static AttributeKeyTemplate<List<Double>> doubleArrayKeyTemplate(String prefix)

Create an AttributeKeyTemplate with type AttributeType.DOUBLE_ARRAY and the given prefix.

getAttributeKey

public io.opentelemetry.api.common.AttributeKey<T> getAttributeKey(String key)

Returns an AttributeKey object for the given attribute key whereby the key is the variable part of the full attribute name in a template-typed attribute, for example http.request.header.<key>.

AttributeKey objets are being created and cached on the first invocation of this method for a certain key. Subsequent invocations of this method with the same key return the cached object.

Parameters:

key - The variable part of the template-typed attribute name.

Returns:

An AttributeKey object for the given key.