latency-histogram.3valkey - Man Page
Returns the cumulative distribution of latencies of a subset or all commands.
Synopsis
LATENCY HISTOGRAM
COMMAND [COMMAND...]
Description
LATENCY HISTOGRAM
returns a cumulative distribution of commands’ latencies in histogram format.
By default, all available latency histograms are returned. You can filter the reply by providing specific command names.
Each histogram consists of the following fields:
- Command name
- The total calls for that command
A map of time buckets:
- Each bucket represents a latency range
- Each bucket covers twice the previous bucket’s range
- Empty buckets are excluded from the reply
- The tracked latencies are between 1 microsecond and roughly 1 second
- Everything above 1 second is considered +Inf
- At max, there will be log2(1,000,000,000)=30 buckets
This command requires the extended latency monitoring feature to be enabled, which is the default. If you need to enable it, call CONFIG SET latency-tracking yes
.
To delete the latency histograms’ data use the CONFIG RESETSTAT
command.
Reply
Resp2
valkey-protocol(7) Array reply: a map where each key is a command name, and each value is a map with the total calls, and an inner map of the histogram time buckets.
Resp3
valkey-protocol(7) Map reply: a map where each key is a command name, and each value is a map with the total calls, and an inner map of the histogram time buckets.
Complexity
O(N) where N is the number of commands with latency information being retrieved.
Acl Categories
@admin @dangerous @slow
History
- Available since: 7.0.0
Examples
127.0.0.1:6379> LATENCY HISTOGRAM set 1# "set" => 1# "calls" => (integer) 100000 2# "histogram_usec" => 1# (integer) 1 => (integer) 99583 2# (integer) 2 => (integer) 99852 3# (integer) 4 => (integer) 99914 4# (integer) 8 => (integer) 99940 5# (integer) 16 => (integer) 99968 6# (integer) 33 => (integer) 100000
See Also
acl(3valkey), acl-cat(3valkey), acl-deluser(3valkey), acl-dryrun(3valkey), acl-genpass(3valkey), acl-getuser(3valkey), acl-help(3valkey), acl-list(3valkey), acl-load(3valkey), acl-log(3valkey), acl-save(3valkey), acl-setuser(3valkey), acl-users(3valkey), acl-whoami(3valkey), bgrewriteaof(3valkey), bgsave(3valkey), command(3valkey), command-count(3valkey), command-docs(3valkey), command-getkeys(3valkey), command-getkeysandflags(3valkey), command-help(3valkey), command-info(3valkey), command-list(3valkey), config(3valkey), config-get(3valkey), config-help(3valkey), config-resetstat(3valkey), config-rewrite(3valkey), config-set(3valkey), dbsize(3valkey), debug(3valkey), failover(3valkey), flushall(3valkey), flushdb(3valkey), info(3valkey), lastsave(3valkey), latency(3valkey), latency-doctor(3valkey), latency-graph(3valkey), latency-help(3valkey), latency-history(3valkey), latency-latest(3valkey), latency-reset(3valkey), lolwut(3valkey), memory(3valkey), memory-doctor(3valkey), memory-help(3valkey), memory-malloc-stats(3valkey), memory-purge(3valkey), memory-stats(3valkey), memory-usage(3valkey), module(3valkey), module-help(3valkey), module-list(3valkey), module-load(3valkey), module-loadex(3valkey), module-unload(3valkey), monitor(3valkey), psync(3valkey), replconf(3valkey), replicaof(3valkey), restore-asking(3valkey), role(3valkey), save(3valkey), shutdown(3valkey), slowlog(3valkey), slowlog-get(3valkey), slowlog-help(3valkey), slowlog-len(3valkey), slowlog-reset(3valkey), swapdb(3valkey), sync(3valkey), time(3valkey)