io.lettuce.core

Class HotkeysArgs

java.lang.Object

io.lettuce.core.HotkeysArgs

All Implemented Interfaces:

CompositeArgument

@Experimental
public class HotkeysArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis HOTKEYS START command. Static import the methods from HotkeysArgs.Builder and chain the method calls: metrics(Metric.CPU, Metric.NET).count(20).

HotkeysArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

7.4

Author:

Aleksandar Todorov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HotkeysArgs.Builder Builder entry points for HotkeysArgs.
static class	HotkeysArgs.Metric Metrics to track for hotkeys.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COUNT_MAX Maximum value for COUNT option.
static int	COUNT_MIN Minimum value for COUNT option.
static long	DURATION_MIN Minimum value for DURATION option (seconds). 0 means no auto-stop.
static int	SAMPLE_MIN Minimum value for SAMPLE option.
static int	SLOT_MAX Maximum slot number (inclusive).
static int	SLOT_MIN Minimum slot number (inclusive).
static int	SLOTS_MAX_COUNT Maximum number of slots that can be specified.

Constructor Summary

Constructors

Constructor and Description
HotkeysArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
HotkeysArgs	count(int count) Set the number of top keys to report.
HotkeysArgs	duration(Duration duration) Set the auto-stop duration.
HotkeysArgs	duration(long duration) Set the auto-stop duration in seconds.
HotkeysArgs	metrics(HotkeysArgs.Metric... metrics) Set the metrics to track.
HotkeysArgs	sample(int ratio) Set the sampling ratio.
HotkeysArgs	slots(int... slots) Set the slot numbers to track (cluster mode only).

Methods inherited from class java.lang.Object

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

Field Detail

COUNT_MIN

public static final int COUNT_MIN

Minimum value for COUNT option.

See Also:

Constant Field Values

COUNT_MAX

public static final int COUNT_MAX

Maximum value for COUNT option.

See Also:

Constant Field Values

DURATION_MIN

public static final long DURATION_MIN

Minimum value for DURATION option (seconds). 0 means no auto-stop.

See Also:

Constant Field Values

SAMPLE_MIN

public static final int SAMPLE_MIN

Minimum value for SAMPLE option.

See Also:

Constant Field Values

SLOT_MIN

public static final int SLOT_MIN

Minimum slot number (inclusive).

See Also:

Constant Field Values

SLOT_MAX

public static final int SLOT_MAX

Maximum slot number (inclusive).

See Also:

Constant Field Values

SLOTS_MAX_COUNT

public static final int SLOTS_MAX_COUNT

Maximum number of slots that can be specified.

See Also:

Constant Field Values

Constructor Detail

HotkeysArgs

public HotkeysArgs()

Method Detail

metrics

public HotkeysArgs metrics(HotkeysArgs.Metric... metrics)

Set the metrics to track. At least one metric must be specified, maximum two (CPU and NET).

Parameters:

metrics - the metrics to track (CPU and/or NET).

Returns:

this HotkeysArgs.

count

public HotkeysArgs count(int count)

Set the number of top keys to report.

Parameters:

count - number of keys (min: 10, max: 64).

Returns:

this HotkeysArgs.

duration

public HotkeysArgs duration(long duration)

Set the auto-stop duration in seconds. Use 0 to disable auto-stop.

Parameters:

duration - duration in seconds (min: 0L, 0 = no auto-stop).

Returns:

this HotkeysArgs.

duration

public HotkeysArgs duration(Duration duration)

Set the auto-stop duration.

Parameters:

duration - duration (min: 0Ls).

Returns:

this HotkeysArgs.

sample

public HotkeysArgs sample(int ratio)

Set the sampling ratio.

Parameters:

ratio - sampling ratio (min: 1, 1 = track every key, higher values = sample less frequently).

Returns:

this HotkeysArgs.

slots

public HotkeysArgs slots(int... slots)

Set the slot numbers to track (cluster mode only). Each slot must be between 0 and 16383 inclusive. Maximum 16384 slots can be specified.

In the response, Redis groups consecutive slots into ranges. For example, if you specify slots 0, 1, 2, and 100, the response's HotkeysReply.getSelectedSlots() will contain two entries: a range [0, 2] for the consecutive slots and [100, 100] for the single slot.

Parameters:

slots - the slot numbers.

Returns:

this HotkeysArgs.

See Also:

HotkeysReply.getSelectedSlots()

build

public <K,V> void build(CommandArgs<K,V> args)

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.