CLIENT

CLIENT LIST

CLIENT LIST [TYPE <NORMAL | MASTER | REPLICA | PUBSUB>]
  [ID client-id [client-id ...]]

Доступно с версии:

2.4.0

Сложность по времени:

O(N), где N — количество подключений клиентов

Категории ACL:

@admin, @slow, @dangerous, @connection,

Команда CLIENT LIST возвращает информацию и статистику о подключенных к серверу клиентах в формате, преимущественно удобном для чтения человеком.

Вы можете использовать один из необязательных подкоманд для фильтрации списка. Подкоманда TYPE type фильтрует список по типу клиента, где тип — одно из значений normal, master, replica, и pubsub. Обратите внимание, что клиенты, заблокированные командой MONITOR, относятся к классу normal.

Фильтр ID возвращает только записи для клиентов с идентификаторами, соответствующими аргументам client-id.

Возврат

Ответ в формате строки со множественными значениями: уникальная строка, отформатированная следующим образом:

• По одному подключению клиента на строку (разделенные символом LF)
• Каждая строка состоит из последовательности property=value полей, разделенных пробелом.

Вот значение полей:

• id: уникальный 64-битный идентификатор клиента
• addr: адрес/порт клиента
• laddr: адрес/порт локального адреса, к которому подключен клиент (адрес привязки)
• fd: дескриптор файла, соответствующий сокету
• name: имя, заданное клиентом с помощью CLIENT SETNAME
• age: общее время подключения в секундах
• idle: время простоя подключения в секундах
• flags: флаги клиента (см. ниже)
• db: текущий идентификатор базы данных
• sub: количество подписок на каналы
• psub: количество подписок с шаблоном соответствия
• ssub: количество подписок на каналы фрагмента. Добавлено в Redis 7.0.3
• multi: количество команд в контексте MULTI/EXEC
• qbuf: длина буфера запроса (0 означает, что запрос не ожидается)
• qbuf-free: свободный размер буфера запроса (0 означает, что буфер заполнен)
• argv-mem: неполные аргументы для следующей команды (уже извлечены из буфера запроса)
• multi-mem: объем памяти, используемой буферизованными многократными командами. Добавлено в Redis 7.0
• obl: длина буфера вывода
• oll: длина списка вывода (ответы очередизируются в этом списке, когда буфер заполнен)
• omem: использование памяти буфером вывода
• tot-mem: общий объем памяти, используемый данным клиентом в его различных буферах
• events: события дескрипторов файлов (см. ниже)
• cmd: последняя исполненная команда
• user: аутентифицированное имя пользователя клиента
• redir: идентификатор клиента текущего отслеживания перенаправления
• resp: версия протокола RESP клиента. Добавлено в Redis 7.0

Флаги клиента могут быть комбинацией:

A: connection to be closed ASAP
b: the client is waiting in a blocking operation
c: connection to be closed after writing entire reply
d: a watched keys has been modified - EXEC will fail
i: the client is waiting for a VM I/O (deprecated)
M: the client is a master
N: no specific flag set
O: the client is a client in MONITOR mode
P: the client is a Pub/Sub subscriber
r: the client is in readonly mode against a cluster node
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 

События дескриптора файла могут быть:

r: the client socket is readable (event loop)
w: the client socket is writable (event loop)

Примечания

Новые поля регулярно добавляются в целях отладки. Некоторые из них могут быть удалены в будущем. Безопасный клиент Redis, использующий эту команду, должен соответствующим образом анализировать вывод (т. е. обрабатывать отсутствие полей, пропускать неизвестные поля).

История

• Начиная с версии Redis 2.8.12: добавлено уникальное поле клиента id.
• Начиная с версии Redis 5.0.0: добавлен необязательный фильтр TYPE.
• Начиная с версии Redis 6.0.0: добавлено поле user.
• Начиная с версии Redis 6.2.0: добавлены поля argv-mem, tot-mem, laddr и redir и необязательный фильтр ID.
• Начиная с версии Redis 7.0.0: добавлены поля resp, multi-mem, rbs и rbp.
• Начиная с версии Redis 7.0.3: добавлено поле ssub.