Help Center/ Distributed Cache Service/ User Guide/ Managing Instances/ Viewing Client Information of a DCS Instance Session
Updated on 2025-09-02 GMT+08:00

Viewing Client Information of a DCS Instance Session

Session management helps addressing DCS instance performance issues or abnormal operations. Client connection information, command execution, and connection duration of a target instance session can be viewed in real time. Abnormal sessions can be terminated as required.

Notes and Constraints

  • The session management page displays only the information about the external client connections. Information about the Web CLI connections is not displayed.
  • This function is available only in the CN North-Beijing1, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN South-Guangzhou, and CN Southwest-Guiyang1 regions.
  • This function is supported by DCS Redis 4.0 instances and later. To query the client IP information of Redis 3.0 instances, use the Client List command.
  • If client IP pass-through is disabled for the instance, the value of addr is not the actual IP address of the client. Instead, the internal private network IP address 198.19.xxx.xxx is displayed.
  • To query the actual client IP address, see Enabling Client IP Pass-through. When client IP pass-through is enabled, addr of a new client connection is the actual client IP address.

Procedure

  1. Log in to the DCS console.
  2. Click in the upper left corner of the console and select the region where your instance is located.
  3. In the navigation pane, choose Cache Manager.
  4. On the Cache Manager page, click the name of the desired DCS instance to go to the instance details page.
  5. Click the Sessions tab.
  6. Information about client connections of the instance is displayed.

    • For Proxy Cluster and read/write splitting instances, connections to proxy nodes are displayed. For single-node, master/standby, and Redis Cluster instances, connections to Redis Server nodes are displayed.
    • On the page, you can specify a Redis Server or proxy node to query, enter an address, update the query results, and set columns to display.
    • If client IP pass-through is disabled for the instance, the value of addr is not the actual IP address of the client. Instead, the internal private network IP address 198.19.xxx.xxx is displayed.
    • To query the actual client IP address, see Enabling Client IP Pass-through. When client IP pass-through is enabled, addr of a new client connection is the actual client IP address.
    Figure 1 Managing sessions
    Table 1 Session fields

    Field

    Description

    ID

    Unique ID of a session.

    addr

    Session address. If IP pass-through is enabled, this address is referred to the client IP address. If not, this address is a private IP address.

    name

    Client name, which can be configured using setClientName (...) in the code. This parameter can be left blank.

    cmd

    The last command executed.

    age

    Connection duration, in seconds.

    idle

    Idle connection duration, in seconds.

    db

    The DB identifier in the last executed command, for example, the value of DB0 is 0.

    flags

    Connection flags. M indicates a connection from a master node. S indicates a connection from a standby node. For other flags, see https://redis.io/docs/latest/commands/client-list/.

    fd

    File descriptor.

    sub

    Number of channel subscriptions.

    psub

    Number of pattern matching subscriptions.

    multi

    Number of commands run in transactions or Lua scripts. The value -1 indicates that no such command is executed.

    qbuf

    Query buffer length (bytes).

    qbuf-free

    Free space of the query buffer (bytes).

    obl

    Output buffer length.

    oll

    Output list length.

    omem

    Output buffer memory usage (bytes).

    events

    File descriptor events (readable, writable). Read: r; Write: w.

  7. Select connections to kill and click Kill Selected to disconnect the corresponding clients. You can also click Kill All.

    If a disconnected client can reconnect, it will be automatically reconnected after being disconnected.

  8. To export sessions data, click Export. You can export all or selected data.

Related Document

To manage sessions by calling an API, see Session Management.