ClickHouse/docs/en/operations/system-tables/zookeeper_log.md

system.zookeeper_log

This table contains information about the parameters of the request to the ZooKeeper server and the response from it.

For requests, only columns with request parameters are filled in, and the remaining columns are filled with default values (0 or NULL). When the response arrives, the data from the response is added to the other columns.

Columns with request parameters:

• type (Enum) — Event type in the ZooKeeper client. Can have one of the following values:
  • Request — The request has been sent.
  • Response — The response was received.
  • Finalize — The connection is lost, no response was received.
• event_date (Date) — The date when the event happened.
• event_time (DateTime64) — The date and time when the event happened.
• address (IPv6) — IP address of ZooKeeper server that was used to make the request.
• port (UInt16) — The port of ZooKeeper server that was used to make the request.
• session_id (Int64) — The session ID that the ZooKeeper server sets for each connection.
• xid (Int32) — The ID of the request within the session. This is usually a sequential request number. It is the same for the request row and the paired response/finalize row.
• has_watch (UInt8) — The request whether the watch has been set.
• op_num (Enum) — The type of request or response.
• path (String) — The path to the ZooKeeper node specified in the request, or an empty string if the request not requires specifying a path.
• data (String) — The data written to the ZooKeeper node (for the SET and CREATE requests — what the request wanted to write, for the response to the GET request — what was read) or an empty string.
• is_ephemeral (UInt8) — Is the ZooKeeper node being created as an ephemeral.
• is_sequential (UInt8) — Is the ZooKeeper node being created as an sequential.
• version (Nullable(Int32)) — The version of the ZooKeeper node that the request expects when executing. This is supported for CHECK, SET, REMOVE requests (is relevant -1 if the request does not check the version or NULL for other requests that do not support version checking).
• requests_size (UInt32) — The number of requests included in the multi request (this is a special request that consists of several consecutive ordinary requests and executes them atomically). All requests included in multi request will have the same xid.
• request_idx (UInt32) — The number of the request included in multi request (for multi request — 0, then in order from 1).

Columns with request response parameters:

• zxid (Int64) — ZooKeeper transaction ID. The serial number issued by the ZooKeeper server in response to a successfully executed request (0 if the request was not executed/returned an error/the client does not know whether the request was executed).
• error (Nullable(Enum)) — Error code. Can have many values, here are just some of them:
  • ZOK — The request was executed seccessfully.
  • ZCONNECTIONLOSS — The connection was lost.
  • ZOPERATIONTIMEOUT — The request execution timeout has expired.
  • ZSESSIONEXPIRED — The session has expired.
  • NULL — The request is completed.
• watch_type (Nullable(Enum)) — The type of the watch event (for responses with op_num = Watch), for the remaining responses: NULL.
• watch_state (Nullable(Enum)) — The status of the watch event (for responses with op_num = Watch), for the remaining responses: NULL.
• path_created (String) — The path to the created ZooKeeper node (for responses to the CREATE request), may differ from the path if the node is created as a sequential.
• stat_czxid (Int64) — The zxid of the change that caused this ZooKeeper node to be created.
• stat_mzxid (Int64) — The zxid of the change that last modified this ZooKeeper node.
• stat_pzxid (Int64) — The transaction ID of the change that last modified childern of this ZooKeeper node.
• stat_version (Int32) — The number of changes to the data of this ZooKeeper node.
• stat_cversion (Int32) — The number of changes to the children of this ZooKeeper node.
• stat_dataLength (Int32) — The length of the data field of this ZooKeeper node.
• stat_numChildren (Int32) — The number of children of this ZooKeeper node.
• children (Array(String)) — The list of child ZooKeeper nodes (for responses to LIST request).

Example

Query:

SELECT * FROM system.zookeeper_log WHERE (session_id = '106662742089334927') AND (xid = '10858') FORMAT Vertical;

Result:

Row 1:
──────
type:             Request
event_date:       2021-08-09
event_time:       2021-08-09 21:38:30.291792
address:          ::
port:             2181
session_id:       106662742089334927
xid:              10858
has_watch:        1
op_num:           List
path:             /clickhouse/task_queue/ddl
data:             
is_ephemeral:     0
is_sequential:    0
version:          ᴺᵁᴸᴸ
requests_size:    0
request_idx:      0
zxid:             0
error:            ᴺᵁᴸᴸ
watch_type:       ᴺᵁᴸᴸ
watch_state:      ᴺᵁᴸᴸ
path_created:     
stat_czxid:       0
stat_mzxid:       0
stat_pzxid:       0
stat_version:     0
stat_cversion:    0
stat_dataLength:  0
stat_numChildren: 0
children:         []

Row 2:
──────
type:             Response
event_date:       2021-08-09
event_time:       2021-08-09 21:38:30.292086
address:          ::
port:             2181
session_id:       106662742089334927
xid:              10858
has_watch:        1
op_num:           List
path:             /clickhouse/task_queue/ddl
data:             
is_ephemeral:     0
is_sequential:    0
version:          ᴺᵁᴸᴸ
requests_size:    0
request_idx:      0
zxid:             16926267
error:            ZOK
watch_type:       ᴺᵁᴸᴸ
watch_state:      ᴺᵁᴸᴸ
path_created:     
stat_czxid:       16925469
stat_mzxid:       16925469
stat_pzxid:       16926179
stat_version:     0
stat_cversion:    7
stat_dataLength:  0
stat_numChildren: 7
children:         ['query-0000000006','query-0000000005','query-0000000004','query-0000000003','query-0000000002','query-0000000001','query-0000000000']

See Also

• ZooKeeper
• ZooKeeper guide