Module lettuce.core

Package io.lettuce.core.metrics

Class DefaultCommandLatencyCollectorOptions.Builder

java.lang.Object

io.lettuce.core.metrics.DefaultCommandLatencyCollectorOptions.Builder

All Implemented Interfaces:

CommandLatencyCollectorOptions.Builder

Enclosing class:

DefaultCommandLatencyCollectorOptions

public static class DefaultCommandLatencyCollectorOptions.Builder
extends Object
implements CommandLatencyCollectorOptions.Builder

Builder for DefaultCommandLatencyCollectorOptions.

Method Summary

Modifier and Type	Method	Description
DefaultCommandLatencyCollectorOptions	build()
DefaultCommandLatencyCollectorOptions.Builder	disable()	Disable the latency collector.
DefaultCommandLatencyCollectorOptions.Builder	enable()	Enable the latency collector.
DefaultCommandLatencyCollectorOptions.Builder	localDistinction(boolean localDistinction)	Enables per connection metrics tracking insead of per host/port.
DefaultCommandLatencyCollectorOptions.Builder	resetLatenciesAfterEvent(boolean resetLatenciesAfterEvent)	Sets whether the recorded latencies should be reset once the metrics event was emitted.
DefaultCommandLatencyCollectorOptions.Builder	targetPercentiles(double[] targetPercentiles)	Sets the emitted percentiles.
DefaultCommandLatencyCollectorOptions.Builder	targetUnit(TimeUnit targetUnit)	Set the target unit for the latencies.

Methods inherited from class java.lang.Object

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

Method Details

disable

public DefaultCommandLatencyCollectorOptions.Builder disable()

Disable the latency collector.

Specified by:

disable in interface CommandLatencyCollectorOptions.Builder

Returns:

this DefaultCommandLatencyCollectorOptions.Builder.

enable

public DefaultCommandLatencyCollectorOptions.Builder enable()

Enable the latency collector.

Specified by:

enable in interface CommandLatencyCollectorOptions.Builder

Returns:

this DefaultCommandLatencyCollectorOptions.Builder.

Since:

5.1

targetUnit

public DefaultCommandLatencyCollectorOptions.Builder targetUnit(TimeUnit targetUnit)

Set the target unit for the latencies. Defaults to TimeUnit.MILLISECONDS. See DefaultCommandLatencyCollectorOptions.DEFAULT_TARGET_UNIT.

Specified by:

targetUnit in interface CommandLatencyCollectorOptions.Builder

Parameters:

targetUnit - the target unit, must not be null

Returns:

this DefaultCommandLatencyCollectorOptions.Builder.

targetPercentiles

public DefaultCommandLatencyCollectorOptions.Builder targetPercentiles(double[] targetPercentiles)

Sets the emitted percentiles. Defaults to 50.0, 90.0, 95.0, 99.0, 99.9} . See DefaultCommandLatencyCollectorOptions.DEFAULT_TARGET_PERCENTILES.

Specified by:

targetPercentiles in interface CommandLatencyCollectorOptions.Builder

Parameters:

targetPercentiles - the percentiles which should be emitted, must not be null

Returns:

this DefaultCommandLatencyCollectorOptions.Builder.

resetLatenciesAfterEvent

public DefaultCommandLatencyCollectorOptions.Builder resetLatenciesAfterEvent(boolean resetLatenciesAfterEvent)

Sets whether the recorded latencies should be reset once the metrics event was emitted. Defaults to true. See DefaultCommandLatencyCollectorOptions.DEFAULT_RESET_LATENCIES_AFTER_EVENT.

Specified by:

resetLatenciesAfterEvent in interface CommandLatencyCollectorOptions.Builder

Parameters:

resetLatenciesAfterEvent - true if the recorded latencies should be reset once the metrics event was emitted

Returns:

this DefaultCommandLatencyCollectorOptions.Builder.

localDistinction

public DefaultCommandLatencyCollectorOptions.Builder localDistinction(boolean localDistinction)

Enables per connection metrics tracking insead of per host/port. 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. Defaults to false. See DefaultCommandLatencyCollectorOptions.DEFAULT_LOCAL_DISTINCTION.

Specified by:

localDistinction in interface CommandLatencyCollectorOptions.Builder

Parameters:

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

Returns:

this DefaultCommandLatencyCollectorOptions.Builder.

build

public DefaultCommandLatencyCollectorOptions build()

Specified by:

build in interface CommandLatencyCollectorOptions.Builder

Returns:

a new instance of DefaultCommandLatencyCollectorOptions.