Skip to content

Commit af26ec2

Browse files
Updated Documentation for CLIENT KILL and CLIENT LIST (#218)
Documentation for valkey-io/valkey#1401 --------- Signed-off-by: Sarthak Aggarwal <[email protected]>
1 parent fffb5dd commit af26ec2

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

commands/client-kill.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ instead of killing just by address. The following filters are available:
1313

1414
* `CLIENT KILL ADDR ip:port`. This is exactly the same as the old three-arguments behavior.
1515
* `CLIENT KILL LADDR ip:port`. Kill all clients connected to specified local (bind) address.
16-
* `CLIENT KILL ID client-id`. Allows to kill a client by its unique `ID` field. Client `ID`'s are retrieved using the `CLIENT LIST` command.
16+
* `CLIENT KILL ID client-id [client-id ...]`. Allows to kill a client by its unique `ID` field. Client `ID`'s can be retrieved using the `CLIENT LIST` command. The filter supports one or more `client-id` arguments.
1717
* `CLIENT KILL TYPE type`, where *type* is one of `normal`, `master`, `replica` and `pubsub`. This closes the connections of **all the clients** in the specified class. Note that clients blocked into the `MONITOR` command are considered to belong to the `normal` class.
1818
* `CLIENT KILL USER username`. Closes all the connections that are authenticated with the specified [ACL](../topics/acl.md) username, however it returns an error if the username does not map to an existing ACL user.
1919
* `CLIENT KILL SKIPME yes/no`. By default this option is set to `yes`, that is, the client calling the command will not get killed, however setting this option to `no` will have the effect of also killing the client calling the command.

commands/client-list.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
The `CLIENT LIST` command returns information and statistics about the client
22
connections server in a mostly human readable format.
33

4-
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.
4+
You can use one or more optional arguments to filter the list:
55

6-
The `ID` filter only returns entries for clients with IDs matching the `client-id` arguments.
6+
- **`TYPE type`**: Filters the list by clients' type, where *type* is one of `normal`, `master`, `replica`, and `pubsub`.
7+
> Note: Clients blocked by the `MONITOR` command belong to the `normal` class.
8+
9+
- **`ID client-id [client-id ...]`**: Returns entries for clients with IDs matching one or more `client-id` arguments.
10+
11+
- **`USER user`**: Filters the list to include only clients authenticated as the specified user.
12+
13+
- **`ADDR ip:port`**: Filters the list to include only clients connected from the specified address and port.
14+
15+
- **`LADDR ip:port`**: Filters the list to include only clients connected to the specified local address and port.
16+
17+
- **`SKIPME yes|no`**: Filters whether the list should skip the client making the request.
18+
- `yes`: Skips the client making the request.
19+
- `no`: Includes the client making the request.
20+
21+
- **`MAXAGE milliseconds`**: Filters the list to include only clients whose connection age (time since the client was created) is greater than or equal to the specified number of milliseconds.
22+
> Note: This is actually a minimum age, not a maximum age. This filter was first added to CLIENT KILL, where the intention was to keep clients of a maximum age and kill the ones than the max age.
23+
24+
Filters can be combined to perform more precise searches. The command will handle multiple filters via logical AND.
725

826
Here is the meaning of the fields:
927

@@ -72,6 +90,12 @@ r: the client socket is readable (event loop)
7290
w: the client socket is writable (event loop)
7391
```
7492

93+
## Examples
94+
95+
```bash
96+
CLIENT LIST TYPE normal USER admin MAXAGE 5000 ID 1234 5678
97+
```
98+
7599
## Notes
76100

77101
New fields are regularly added for debugging purpose. Some could be removed

0 commit comments

Comments
 (0)