Package org.forgerock.opendj.server.config.meta

Enum Class OpenTelemetryPluginCfgDefn.TracerSampler

java.lang.Object

java.lang.Enum<OpenTelemetryPluginCfgDefn.TracerSampler>

org.forgerock.opendj.server.config.meta.OpenTelemetryPluginCfgDefn.TracerSampler

All Implemented Interfaces:

Serializable, Comparable<OpenTelemetryPluginCfgDefn.TracerSampler>, java.lang.constant.Constable

Enclosing class:

OpenTelemetryPluginCfgDefn

public static enum OpenTelemetryPluginCfgDefn.TracerSampler
extends Enum<OpenTelemetryPluginCfgDefn.TracerSampler>

Defines the set of permissible values for the "tracer-sampler" property.

The strategy used by the span exporter to sample spans. The sampling strategy is evaluated each time a span is started.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS_OFF	Samples no span at all.
ALWAYS_ON	Samples all the spans.
PARENTBASED_ALWAYS_OFF	Follows the sampling decisions of the parent span.
PARENTBASED_ALWAYS_ON	Follows the sampling decisions of the parent span.
PARENTBASED_TRACEIDRATIO	Follows the sampling decisions of the parent span.
TRACEIDRATIO	Samples a ratio of spans.

Method Summary

Modifier and Type	Method	Description
String	toString()
static OpenTelemetryPluginCfgDefn.TracerSampler	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenTelemetryPluginCfgDefn.TracerSampler[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS_OFF

public static final OpenTelemetryPluginCfgDefn.TracerSampler ALWAYS_OFF

Samples no span at all.

ALWAYS_ON

public static final OpenTelemetryPluginCfgDefn.TracerSampler ALWAYS_ON

Samples all the spans.

PARENTBASED_ALWAYS_OFF

public static final OpenTelemetryPluginCfgDefn.TracerSampler PARENTBASED_ALWAYS_OFF

Follows the sampling decisions of the parent span. If there is no parent span, the span is never sampled.

PARENTBASED_ALWAYS_ON

public static final OpenTelemetryPluginCfgDefn.TracerSampler PARENTBASED_ALWAYS_ON

Follows the sampling decisions of the parent span. If there is no parent span, the span is always sampled.

PARENTBASED_TRACEIDRATIO

public static final OpenTelemetryPluginCfgDefn.TracerSampler PARENTBASED_TRACEIDRATIO

Follows the sampling decisions of the parent span. If there is no parent span, fallback to using the "traceidratio" sampler.

TRACEIDRATIO

public static final OpenTelemetryPluginCfgDefn.TracerSampler TRACEIDRATIO

Samples a ratio of spans. Prefer to use the "parentbased-traceidratio" sampler instead.

Method Details

values

public static OpenTelemetryPluginCfgDefn.TracerSampler[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OpenTelemetryPluginCfgDefn.TracerSampler valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<OpenTelemetryPluginCfgDefn.TracerSampler>