Package io.lettuce.core.metrics

Class DefaultCommandLatencyCollector

java.lang.Object

io.lettuce.core.metrics.DefaultCommandLatencyCollector

All Implemented Interfaces:

CommandLatencyCollector, CommandLatencyRecorder, MetricCollector<Map<CommandLatencyId,CommandMetrics>>

public class DefaultCommandLatencyCollector
extends Object
implements CommandLatencyCollector

Default implementation of a CommandLatencyCollector for command latencies.

Author:

Mark Paluch, Bryce J. Fisher

Constructor Summary

Constructors

Constructor	Description
DefaultCommandLatencyCollector(CommandLatencyCollectorOptions options)

Method Summary

Modifier and Type	Method	Description
static CommandLatencyCollector	disabled()	Returns a disabled no-op CommandLatencyCollector.
static boolean	isAvailable()	Returns true if HdrUtils and LatencyUtils are available on the class path.
boolean	isEnabled()	Returns true if the metric collector is enabled.
void	recordCommandLatency(SocketAddress local, SocketAddress remote, ProtocolKeyword commandType, long firstResponseLatency, long completionLatency)	Record the command latency per connectionPoint and commandType.
Map<CommandLatencyId,CommandMetrics>	retrieveMetrics()	Returns the collected/aggregated metrics.
void	shutdown()	Shut down the metrics collector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lettuce.core.metrics.CommandLatencyRecorder

recordCommandLatency

Constructor Detail

DefaultCommandLatencyCollector

public DefaultCommandLatencyCollector(CommandLatencyCollectorOptions options)

Method Detail

recordCommandLatency

public void recordCommandLatency(SocketAddress local,
                                 SocketAddress remote,
                                 ProtocolKeyword commandType,
                                 long firstResponseLatency,
                                 long completionLatency)

Record the command latency per connectionPoint and commandType.

Specified by:

recordCommandLatency in interface CommandLatencyRecorder

Parameters:

local - the local address

remote - the remote address

commandType - the command type

firstResponseLatency - latency value in TimeUnit.NANOSECONDS from send to the first response

completionLatency - latency value in TimeUnit.NANOSECONDS from send to the command completion

isEnabled

public boolean isEnabled()

Description copied from interface: CommandLatencyRecorder

Returns true if the metric collector is enabled.

Specified by:

isEnabled in interface CommandLatencyRecorder

Returns:

true if the metric collector is enabled

shutdown

public void shutdown()

Description copied from interface: MetricCollector

Shut down the metrics collector.

Specified by:

shutdown in interface MetricCollector<Map<CommandLatencyId,CommandMetrics>>

retrieveMetrics

public Map<CommandLatencyId,CommandMetrics> retrieveMetrics()

Description copied from interface: MetricCollector

Returns the collected/aggregated metrics.

Specified by:

retrieveMetrics in interface MetricCollector<Map<CommandLatencyId,CommandMetrics>>

Returns:

the collected/aggregated metrics

isAvailable

public static boolean isAvailable()

Returns true if HdrUtils and LatencyUtils are available on the class path.

Returns:

disabled

public static CommandLatencyCollector disabled()

Returns a disabled no-op CommandLatencyCollector.

Returns: