Package io.opentelemetry.sdk.trace

Class SpanLimits

java.lang.Object

io.opentelemetry.sdk.trace.SpanLimits

Direct Known Subclasses:

SpanLimits.SpanLimitsValue

public abstract class SpanLimits
extends java.lang.Object

Class that holds limits enforced during span recording.

Note: To allow dynamic updates of SpanLimits you should register a Supplier with SdkTracerProviderBuilder.setSpanLimits(java.util.function.Supplier) which supplies dynamic configs when queried.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SpanLimits.SpanLimitsValue

Field Summary

Fields

Modifier and Type	Field	Description
private static SpanLimits	DEFAULT
(package private) static int	DEFAULT_SPAN_MAX_ATTRIBUTE_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SpanLimits()	Deprecated. Will be made package private in 2.0.0.

Method Summary

Modifier and Type	Method	Description
static SpanLimitsBuilder	builder()	Returns a new SpanLimitsBuilder to construct a SpanLimits.
(package private) static SpanLimits	create(int maxNumAttributes, int maxNumEvents, int maxNumLinks, int maxNumAttributesPerEvent, int maxNumAttributesPerLink, int maxAttributeLength)
static SpanLimits	getDefault()	Returns the default SpanLimits.
int	getMaxAttributeValueLength()	Returns the max number of characters for string attribute values.
abstract int	getMaxNumberOfAttributes()	Returns the max number of attributes per Span.
abstract int	getMaxNumberOfAttributesPerEvent()	Returns the max number of attributes per event.
abstract int	getMaxNumberOfAttributesPerLink()	Returns the max number of attributes per link.
abstract int	getMaxNumberOfEvents()	Returns the max number of events per Span.
abstract int	getMaxNumberOfLinks()	Returns the max number of links per Span.
SpanLimitsBuilder	toBuilder()	Returns a SpanLimitsBuilder initialized to the same property values as the current instance.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SPAN_MAX_ATTRIBUTE_LENGTH

static final int DEFAULT_SPAN_MAX_ATTRIBUTE_LENGTH

See Also:

Constant Field Values

DEFAULT

private static final SpanLimits DEFAULT

Constructor Detail

SpanLimits

@Deprecated
protected SpanLimits()

Deprecated.

Will be made package private in 2.0.0.

Create an instance.

Method Detail

getDefault

public static SpanLimits getDefault()

Returns the default SpanLimits.

builder

public static SpanLimitsBuilder builder()

Returns a new SpanLimitsBuilder to construct a SpanLimits.

create

static SpanLimits create(int maxNumAttributes,
                         int maxNumEvents,
                         int maxNumLinks,
                         int maxNumAttributesPerEvent,
                         int maxNumAttributesPerLink,
                         int maxAttributeLength)

getMaxNumberOfAttributes

public abstract int getMaxNumberOfAttributes()

Returns the max number of attributes per Span.

Returns:

the max number of attributes per Span.

getMaxNumberOfEvents

public abstract int getMaxNumberOfEvents()

Returns the max number of events per Span.

Returns:

the max number of events per Span.

getMaxNumberOfLinks

public abstract int getMaxNumberOfLinks()

Returns the max number of links per Span.

Returns:

the max number of links per Span.

getMaxNumberOfAttributesPerEvent

public abstract int getMaxNumberOfAttributesPerEvent()

Returns the max number of attributes per event.

Returns:

the max number of attributes per event.

getMaxNumberOfAttributesPerLink

public abstract int getMaxNumberOfAttributesPerLink()

Returns the max number of attributes per link.

Returns:

the max number of attributes per link.

getMaxAttributeValueLength

public int getMaxAttributeValueLength()

Returns the max number of characters for string attribute values. For string array attribute values, applies to each entry individually.

Returns:

the max number of characters for attribute strings.

toBuilder

public SpanLimitsBuilder toBuilder()

Returns a SpanLimitsBuilder initialized to the same property values as the current instance.

Returns:

a SpanLimitsBuilder initialized to the same property values as the current instance.