diff options
Diffstat (limited to 'iredis/data/commands/client-list.md')
| -rw-r--r-- | iredis/data/commands/client-list.md | 28 |
1 files changed, 23 insertions, 5 deletions
diff --git a/iredis/data/commands/client-list.md b/iredis/data/commands/client-list.md index ea0b775..7956f2b 100644 --- a/iredis/data/commands/client-list.md +++ b/iredis/data/commands/client-list.md @@ -1,10 +1,13 @@ The `CLIENT LIST` command returns information and statistics about the client connections server in a mostly human readable format. -As of v5.0, the optional `TYPE type` subcommand can be used to filter the list -by clients' type, where _type_ is one of `normal`, `master`, `replica` and -`pubsub`. Note that clients blocked into the `MONITOR` command are considered to -belong to the `normal` class. +You can use one of the optional subcommands to filter the list. The `TYPE type` +subcommand filters the list by clients' type, where _type_ is one of `normal`, +`master`, `replica`, and `pubsub`. Note that clients blocked by the `MONITOR` +command belong to the `normal` class. + +The `ID` filter only returns entries for clients with IDs matching the +`client-id` arguments. @return @@ -16,9 +19,10 @@ belong to the `normal` class. Here is the meaning of the fields: -- `id`: an unique 64-bit client ID (introduced in Redis 2.8.12). +- `id`: an unique 64-bit client ID. - `name`: the name set by the client with `CLIENT SETNAME` - `addr`: address/port of the client +- `laddr`: address/port of local address client connected to (bind address) - `fd`: file descriptor corresponding to the socket - `age`: total duration of the connection in seconds - `idle`: idle time of the connection in seconds @@ -35,6 +39,11 @@ Here is the meaning of the fields: - `omem`: output buffer memory usage - `events`: file descriptor events (see below) - `cmd`: last command played +- `argv-mem`: incomplete arguments for the next command (already extracted from + query buffer) +- `tot-mem`: total memory consumed by this client in its various buffers +- `redir`: client id of current client tracking redirection +- `user`: the authenticated username of the client The client flags can be a combination of: @@ -53,6 +62,9 @@ S: the client is a replica node connection to this instance u: the client is unblocked U: the client is connected via a Unix domain socket x: the client is in a MULTI/EXEC context +t: the client enabled keys tracking in order to perform client side caching +R: the client tracking target client is invalid +B: the client enabled broadcast tracking mode ``` The file descriptor events can be: @@ -68,3 +80,9 @@ New fields are regularly added for debugging purpose. Some could be removed in the future. A version safe Redis client using this command should parse the output accordingly (i.e. handling gracefully missing fields, skipping unknown fields). + +@history + +- `>= 2.8.12`: Added unique client `id` field. +- `>= 5.0`: Added optional `TYPE` filter. +- `>= 6.2`: Added `laddr` field and the optional `ID` filter. |