io.lettuce.core

Class HotkeysReply

java.lang.Object

io.lettuce.core.HotkeysReply

@Experimental
public class HotkeysReply
extends Object

Reply from the Redis HOTKEYS GET command. Contains tracking session information and top K hotkeys by CPU time and network bytes.

Since:

7.4

Author:

Aleksandar Todorov

Constructor Summary

Constructors

Constructor and Description

HotkeysReply(boolean trackingActive, int sampleRatio, List<Range<Integer>> selectedSlots, Long sampledCommandSelectedSlotsUs, Long allCommandsSelectedSlotsUs, Long allCommandsAllSlotsUs, Long netBytesSampledCommandsSelectedSlots, Long netBytesAllCommandsSelectedSlots, Long netBytesAllCommandsAllSlots, Long collectionStartTimeUnixMs, Long collectionDurationMs, Long totalCpuTimeUserMs, Long totalCpuTimeSysMs, Long totalNetBytes, Map<String,Long> byCpuTimeUs, Map<String,Long> byNetBytes) Creates a new HotkeysReply.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Long	getAllCommandsAllSlotsUs()
Long	getAllCommandsSelectedSlotsUs()
Map<String,Long>	getByCpuTimeUs()
Map<String,Long>	getByNetBytes()
Long	getCollectionDurationMs()
Long	getCollectionStartTimeUnixMs()
Long	getNetBytesAllCommandsAllSlots()
Long	getNetBytesAllCommandsSelectedSlots()
Long	getNetBytesSampledCommandsSelectedSlots()
Long	getSampledCommandSelectedSlotsUs()
int	getSampleRatio()
List<Range<Integer>>	getSelectedSlots() Returns the selected slot ranges for which hotkeys data was collected.
Long	getTotalCpuTimeSysMs()
Long	getTotalCpuTimeUserMs()
Long	getTotalNetBytes()
int	hashCode()
boolean	isTrackingActive()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HotkeysReply

public HotkeysReply(boolean trackingActive,
                    int sampleRatio,
                    List<Range<Integer>> selectedSlots,
                    Long sampledCommandSelectedSlotsUs,
                    Long allCommandsSelectedSlotsUs,
                    Long allCommandsAllSlotsUs,
                    Long netBytesSampledCommandsSelectedSlots,
                    Long netBytesAllCommandsSelectedSlots,
                    Long netBytesAllCommandsAllSlots,
                    Long collectionStartTimeUnixMs,
                    Long collectionDurationMs,
                    Long totalCpuTimeUserMs,
                    Long totalCpuTimeSysMs,
                    Long totalNetBytes,
                    Map<String,Long> byCpuTimeUs,
                    Map<String,Long> byNetBytes)

Creates a new HotkeysReply.

Parameters:

trackingActive - whether tracking is currently active.

sampleRatio - the sampling ratio.

selectedSlots - the selected slot ranges; consecutive slots are grouped into ranges, single slots are represented as ranges where lower equals upper (e.g., Range.create(100, 100)); empty if all slots were selected.

sampledCommandSelectedSlotsUs - CPU time for sampled commands on selected slots in microseconds (nullable).

allCommandsSelectedSlotsUs - CPU time for all commands on selected slots in microseconds (nullable).

allCommandsAllSlotsUs - CPU time for all commands on all slots in microseconds.

netBytesSampledCommandsSelectedSlots - network bytes for sampled commands on selected slots (nullable).

netBytesAllCommandsSelectedSlots - network bytes for all commands on selected slots (nullable).

netBytesAllCommandsAllSlots - network bytes for all commands on all slots.

collectionStartTimeUnixMs - collection start time in Unix milliseconds.

collectionDurationMs - collection duration in milliseconds.

totalCpuTimeUserMs - total CPU user time in milliseconds.

totalCpuTimeSysMs - total CPU system time in milliseconds.

totalNetBytes - total network bytes.

byCpuTimeUs - top K keys by CPU time in microseconds (key -> microseconds).

byNetBytes - top K keys by network bytes (key -> bytes).

Method Detail

isTrackingActive

public boolean isTrackingActive()

getSampleRatio

public int getSampleRatio()

getSelectedSlots

public List<Range<Integer>> getSelectedSlots()

Returns the selected slot ranges for which hotkeys data was collected.

Redis groups consecutive slots into ranges. For example, if slots 0, 1, 2, and 100 were selected, Redis returns them as two entries: [[0, 2], [100]]. This method represents each entry as a Range:

• Consecutive slots are represented as Range.create(start, end), e.g., Range.create(0, 2)
• Single slots are represented as Range.create(slot, slot), e.g., Range.create(100, 100)

To check if a range represents a single slot, compare range.getLower().getValue().equals(range.getUpper().getValue()).

Returns:

an unmodifiable list of slot ranges, or an empty list if all slots were selected (no filtering).

getSampledCommandSelectedSlotsUs

public Long getSampledCommandSelectedSlotsUs()

getAllCommandsSelectedSlotsUs

public Long getAllCommandsSelectedSlotsUs()

getAllCommandsAllSlotsUs

public Long getAllCommandsAllSlotsUs()

getNetBytesSampledCommandsSelectedSlots

public Long getNetBytesSampledCommandsSelectedSlots()

getNetBytesAllCommandsSelectedSlots

public Long getNetBytesAllCommandsSelectedSlots()

getNetBytesAllCommandsAllSlots

public Long getNetBytesAllCommandsAllSlots()

getCollectionStartTimeUnixMs

public Long getCollectionStartTimeUnixMs()

getCollectionDurationMs

public Long getCollectionDurationMs()

getTotalCpuTimeUserMs

public Long getTotalCpuTimeUserMs()

getTotalCpuTimeSysMs

public Long getTotalCpuTimeSysMs()

getTotalNetBytes

public Long getTotalNetBytes()

getByCpuTimeUs

public Map<String,Long> getByCpuTimeUs()

getByNetBytes

public Map<String,Long> getByNetBytes()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object