org.apache.ignite.internal.commandline.tracing.configuration

Class TracingConfigurationArguments.Builder

java.lang.Object

org.apache.ignite.internal.commandline.tracing.configuration.TracingConfigurationArguments.Builder

Enclosing class:

TracingConfigurationArguments

public static class TracingConfigurationArguments.Builder
extends Object

Builder of TracingConfigurationArguments.

Constructor Summary

Constructors

Constructor and Description
Builder(TracingConfigurationSubcommand cmd) Constructor.

Method Summary

Modifier and Type	Method and Description
TracingConfigurationArguments	build() Builder's build method that produces TracingConfigurationArguments.
@NotNull TracingConfigurationArguments.Builder	withIncludedScopes(Set<Scope> includedScopes) Builder method that allows to set included scopes.
@NotNull TracingConfigurationArguments.Builder	withLabel(@Nullable String lb) Builder method that allows to set optional label attribute.
@NotNull TracingConfigurationArguments.Builder	withSamplingRate(double samplingRate) Builder method that allows to set sampling rate.
@NotNull TracingConfigurationArguments.Builder	withScope(Scope scope) Builder method that allows to set scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(TracingConfigurationSubcommand cmd)

Constructor.

Parameters:

cmd - TracingConfigurationSubcommand command.

Method Detail

withScope

@NotNull
public @NotNull TracingConfigurationArguments.Builder withScope(Scope scope)

Builder method that allows to set scope.

Parameters:

scope - Scope of a trace's root span to which some specific tracing configuration will be applied.

Returns:

Builder.

withSamplingRate

@NotNull
public @NotNull TracingConfigurationArguments.Builder withSamplingRate(double samplingRate)

Builder method that allows to set sampling rate.

Parameters:

samplingRate - Number between 0 and 1 that more or less reflects the probability of sampling specific trace. 0 and 1 have special meaning here, 0 means never 1 means always. Default value is 0 (never).

Returns:

Builder.

withLabel

@NotNull
public @NotNull TracingConfigurationArguments.Builder withLabel(@Nullable
                                                                         @Nullable String lb)

Builder method that allows to set optional label attribute.

Parameters:

lb - Label of traced operation. It's an optional attribute.

Returns:

Builder

withIncludedScopes

@NotNull
public @NotNull TracingConfigurationArguments.Builder withIncludedScopes(Set<Scope> includedScopes)

Builder method that allows to set included scopes.

Parameters:

includedScopes - Set of Scope that defines which sub-traces will be included in given trace. In other words, if child's span scope is equals to parent's scope or it belongs to the parent's span included scopes, then given child span will be attached to the current trace, otherwise it'll be skipped. See Span.isChainable(Scope) for more details.

Returns:

Builder

build

public TracingConfigurationArguments build()

Builder's build method that produces TracingConfigurationArguments.

Returns:

TracingConfigurationArguments instance.