io.lettuce.core.metrics

Interface CommandLatencyCollector

All Superinterfaces:

MetricCollector<Map<CommandLatencyId,CommandMetrics>>

All Known Implementing Classes:

DefaultCommandLatencyCollector

public interface CommandLatencyCollector
extends MetricCollector<Map<CommandLatencyId,CommandMetrics>>

MetricCollector for command latencies. Command latencies are collected per connection (identified by local/remote tuples of SocketAddresses) and command type. Two command latencies are available:

• Latency between command send and first response (first response received)
• Latency between command send and command completion (complete response received)

Since:

3.4

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
static CommandLatencyCollector	create(CommandLatencyCollectorOptions options) Creates a new CommandLatencyCollector using CommandLatencyCollectorOptions.
static CommandLatencyCollector	disabled() Returns a disabled no-op CommandLatencyCollector.
void	recordCommandLatency(SocketAddress local, SocketAddress remote, ProtocolKeyword commandType, long firstResponseLatency, long completionLatency) Record the command latency per connectionPoint and commandType.

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

isEnabled, retrieveMetrics, shutdown

Method Detail

create

static CommandLatencyCollector create(CommandLatencyCollectorOptions options)

Creates a new CommandLatencyCollector using CommandLatencyCollectorOptions.

Parameters:

options - must not be null.

Returns:

the CommandLatencyCollector using CommandLatencyCollectorOptions.

disabled

static CommandLatencyCollector disabled()

Returns a disabled no-op CommandLatencyCollector.

Returns:

Since:

5.1

recordCommandLatency

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

Record the command latency per connectionPoint and commandType.

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