io.opentelemetry.trace.attributes

Class StringAttributeSetter

java.lang.Object

io.opentelemetry.trace.attributes.StringAttributeSetter

@Immutable
public final class StringAttributeSetter
extends Object

Defines the behavior for a span attribute with string values.

Method Summary

Modifier and Type	Method and Description
static StringAttributeSetter	create(String attributeKey) Returns a new attribute setter.
String	key() Returns the attribute name.
void	set(Attributes.Builder attributesBuilder, String value) Sets the attribute on the provided Attributes.Builder.
void	set(Span.Builder spanBuilder, String value) Sets the attribute on the provided span builder.
void	set(Span span, String value) Sets the attribute on the provided span.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StringAttributeSetter create(String attributeKey)

Returns a new attribute setter.

Parameters:

attributeKey - the attribute name

Returns:

the setter object

key

public String key()

Returns the attribute name.

Returns:

the attribute map key

set

public void set(Span span,
                @Nullable
                String value)

Sets the attribute on the provided span.

Parameters:

span - the span to add the attribute to

value - the value for this attribute

set

public void set(Span.Builder spanBuilder,
                @Nullable
                String value)

Sets the attribute on the provided span builder.

Parameters:

spanBuilder - the span builder to add the attribute to

value - the value for this attribute

set

public void set(Attributes.Builder attributesBuilder,
                @Nullable
                String value)

Sets the attribute on the provided Attributes.Builder.

Parameters:

attributesBuilder - the attributes builder to add the attribute to

value - the value for this attribute

toString

public String toString()

Overrides:

toString in class Object