io.lettuce.core.metrics

Class DefaultCommandLatencyCollectorOptions

java.lang.Object

io.lettuce.core.metrics.DefaultCommandLatencyCollectorOptions

All Implemented Interfaces:

CommandLatencyCollectorOptions

public class DefaultCommandLatencyCollectorOptions
extends Object
implements CommandLatencyCollectorOptions

The default implementation of CommandLatencyCollectorOptions.

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultCommandLatencyCollectorOptions.Builder Builder for DefaultCommandLatencyCollectorOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED
static boolean	DEFAULT_LOCAL_DISTINCTION
static boolean	DEFAULT_RESET_LATENCIES_AFTER_EVENT
static double[]	DEFAULT_TARGET_PERCENTILES
static TimeUnit	DEFAULT_TARGET_UNIT
static boolean	DEFAULT_USE_NO_PAUSE_DETECTOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultCommandLatencyCollectorOptions(DefaultCommandLatencyCollectorOptions.Builder builder)

Method Summary

Modifier and Type	Method and Description
static DefaultCommandLatencyCollectorOptions.Builder	builder() Returns a new DefaultCommandLatencyCollectorOptions.Builder to construct DefaultCommandLatencyCollectorOptions.
static DefaultCommandLatencyCollectorOptions	create() Create a new DefaultCommandLatencyCollectorOptions instance using default settings.
static DefaultCommandLatencyCollectorOptions	disabled() Create a DefaultCommandLatencyCollectorOptions instance with disabled event emission.
boolean	isEnabled() Returns whether the latency collector is enabled.
boolean	localDistinction() Returns whether to distinct latencies on local level.
DefaultCommandLatencyCollectorOptions.Builder	mutate() Returns a builder to create new DefaultCommandLatencyCollectorOptions whose settings are replicated from the current DefaultCommandLatencyCollectorOptions.
boolean	resetLatenciesAfterEvent() Returns whether the latencies should be reset once an event is emitted.
double[]	targetPercentiles() Returns the percentiles which should be exposed in the metric.
TimeUnit	targetUnit() Returns the target TimeUnit for the emitted latencies.
boolean	usePauseDetector() Returns whether PauseDetector is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TARGET_UNIT

public static final TimeUnit DEFAULT_TARGET_UNIT

DEFAULT_TARGET_PERCENTILES

public static final double[] DEFAULT_TARGET_PERCENTILES

DEFAULT_RESET_LATENCIES_AFTER_EVENT

public static final boolean DEFAULT_RESET_LATENCIES_AFTER_EVENT

See Also:

Constant Field Values

DEFAULT_LOCAL_DISTINCTION

public static final boolean DEFAULT_LOCAL_DISTINCTION

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

DEFAULT_USE_NO_PAUSE_DETECTOR

public static final boolean DEFAULT_USE_NO_PAUSE_DETECTOR

See Also:

Constant Field Values

Constructor Detail

DefaultCommandLatencyCollectorOptions

protected DefaultCommandLatencyCollectorOptions(DefaultCommandLatencyCollectorOptions.Builder builder)

Method Detail

create

public static DefaultCommandLatencyCollectorOptions create()

Create a new DefaultCommandLatencyCollectorOptions instance using default settings.

Specified by:

create in interface CommandLatencyCollectorOptions

Returns:

a new instance of DefaultCommandLatencyCollectorOptions instance using default settings

disabled

public static DefaultCommandLatencyCollectorOptions disabled()

Create a DefaultCommandLatencyCollectorOptions instance with disabled event emission.

Specified by:

disabled in interface CommandLatencyCollectorOptions

Returns:

a new instance of DefaultCommandLatencyCollectorOptions with disabled event emission

builder

public static DefaultCommandLatencyCollectorOptions.Builder builder()

Returns a new DefaultCommandLatencyCollectorOptions.Builder to construct DefaultCommandLatencyCollectorOptions.

Specified by:

builder in interface CommandLatencyCollectorOptions

Returns:

a new DefaultCommandLatencyCollectorOptions.Builder to construct DefaultCommandLatencyCollectorOptions.

mutate

public DefaultCommandLatencyCollectorOptions.Builder mutate()

Returns a builder to create new DefaultCommandLatencyCollectorOptions whose settings are replicated from the current DefaultCommandLatencyCollectorOptions.

Specified by:

mutate in interface CommandLatencyCollectorOptions

Returns:

a a CommandLatencyCollectorOptions.Builder to create new DefaultCommandLatencyCollectorOptions whose settings are replicated from the current DefaultCommandLatencyCollectorOptions

Since:

5.1

targetUnit

public TimeUnit targetUnit()

Description copied from interface: CommandLatencyCollectorOptions

Returns the target TimeUnit for the emitted latencies.

Specified by:

targetUnit in interface CommandLatencyCollectorOptions

Returns:

the target TimeUnit for the emitted latencies

targetPercentiles

public double[] targetPercentiles()

Description copied from interface: CommandLatencyCollectorOptions

Returns the percentiles which should be exposed in the metric.

Specified by:

targetPercentiles in interface CommandLatencyCollectorOptions

Returns:

the percentiles which should be exposed in the metric

resetLatenciesAfterEvent

public boolean resetLatenciesAfterEvent()

Description copied from interface: CommandLatencyCollectorOptions

Returns whether the latencies should be reset once an event is emitted.

Specified by:

resetLatenciesAfterEvent in interface CommandLatencyCollectorOptions

Returns:

true if the latencies should be reset once an event is emitted.

localDistinction

public boolean localDistinction()

Description copied from interface: CommandLatencyCollectorOptions

Returns whether to distinct latencies on local level. If true, multiple connections to the same host/connection point will be recorded separately which allows to inspect every connection individually. If false, multiple connections to the same host/connection point will be recorded together. This allows a consolidated view on one particular service.

Specified by:

localDistinction in interface CommandLatencyCollectorOptions

Returns:

true if latencies are recorded distinct on local level (per connection)

isEnabled

public boolean isEnabled()

Description copied from interface: CommandLatencyCollectorOptions

Returns whether the latency collector is enabled.

Specified by:

isEnabled in interface CommandLatencyCollectorOptions

Returns:

true if the latency collector is enabled

usePauseDetector

public boolean usePauseDetector()

Description copied from interface: CommandLatencyCollectorOptions

Returns whether PauseDetector is enabled. Defaults to no pause detector.

Specified by:

usePauseDetector in interface CommandLatencyCollectorOptions

Returns:

true if the PauseDetector is enabled