ZooKeeper 的四字命令（Four-Letter Words, 4LW）是一组简单的管理和监控命令，方便运维人员快速获取 ZooKeeper 集群和节点的运行状态。这些命令通常用于健康检查、性能监控、节点配置查看等操作。通过这些命令，可以轻松获取关于 ZooKeeper 服务的关键信息。

四字命令可以通过 TCP 连接直接向 ZooKeeper 服务器发送请求，ZooKeeper 服务会返回相应的状态信息。这些命令只接受四个字母输入，故称为“四字命令”。

ZooKeeper 四字命令详解

1. ruok

• 功能：检查 ZooKeeper 服务节点是否正常运行。

• 用法：

  echo ruok | nc 127.0.0.1 2181

• 返回：imok 表示节点健康运行。如果没有响应，可能是节点宕机或网络不通。

• 用途：通常用于健康检查，特别适合用在负载均衡器或监控系统中确认服务是否存活。

2. stat

• 功能：获取 ZooKeeper 节点的详细状态信息。

• 用法：

  echo stat | nc 127.0.0.1 2181

• 返回：

  • 服务器版本
  • 当前节点连接的客户端数
  • 请求的接收/发送数量
  • 节点角色（Leader/Follower/Standalone）
  • 节点的延迟统计等

• 用途：用于查看 ZooKeeper 节点的整体运行状况，包括连接数和角色等。

3. srvr

• 功能：类似于 stat 命令，但不包括客户端的详细信息。

• 用法：

  echo srvr | nc 127.0.0.1 2181

• 返回：返回服务器版本、节点角色（Leader/Follower）、会话数、zxid（事务ID）等。

• 用途：用于快速查看 ZooKeeper 节点的基本状态，尤其是节点的角色。

4. conf

• 功能：查看 ZooKeeper 节点的配置信息。

• 用法：

  echo conf | nc 127.0.0.1 2181

• 返回：当前 ZooKeeper 配置参数，如 clientPort、dataDir、tickTime 等等。

• 用途：用于确认 ZooKeeper 节点的配置，特别适合检查多节点集群中节点配置的一致性。

5. mntr

• 功能：提供详细的监控指标信息。

• 用法：

  echo mntr | nc 127.0.0.1 2181

• 返回：

  • zk_version：ZooKeeper 版本
  • zk_avg_latency：请求的平均延迟
  • zk_max_latency：最大延迟
  • zk_packets_received：接收到的请求数
  • zk_packets_sent：发送的响应数
  • zk_num_alive_connections：当前活动连接数
  • zk_outstanding_requests：未处理的请求数

• 用途：适合监控 ZooKeeper 节点性能和负载情况，常与外部监控系统集成。

6. wchs

• 功能：查看监控（watchers）相关信息。

• 用法：

  echo wchs | nc 127.0.0.1 2181

• 返回：关于 ZooKeeper 中监控器（watchers）的统计数据，包括监控的路径和设置监控的客户端数量。

• 用途：用于调试和查看 ZooKeeper 的 watch 机制。

7. wchc

• 功能：显示设置了监视器的客户端的详细信息。

• 用法：

  echo wchc | nc 127.0.0.1 2181

• 返回：列出每个客户端 session 和其监控的详细信息。

• 用途：用于追踪客户端的监控器设置，调试复杂的 watch 场景。

8. wchp

• 功能：显示被监控的 ZNode 路径。

• 用法：

  echo wchp | nc 127.0.0.1 2181

• 返回：列出所有被监控的 ZNode 路径。

• 用途：调试哪些节点设置了监控（watch），帮助识别被过度监控的路径。

9. cons

• 功能：查看当前连接到 ZooKeeper 的客户端信息。

• 用法：

  echo cons | nc 127.0.0.1 2181

• 返回：列出所有连接的客户端信息，包括 IP 地址、连接时间、会话 ID 等。

• 用途：监控哪些客户端正在连接 ZooKeeper，特别在处理性能问题时有用。

10. envi

• 功能：显示 ZooKeeper 节点的环境变量。

• 用法：

  echo envi | nc 127.0.0.1 2181

• 返回：JVM 环境信息、操作系统信息、ZooKeeper 启动参数等。

• 用途：调试 ZooKeeper 运行环境，适合检查 JVM 配置问题或运行环境不一致的情况。

11. dump

• 功能：显示与 Leader 节点相关的会话信息（仅在 Leader 节点上有效）。

• 用法：

  echo dump | nc 127.0.0.1 2181

• 返回：列出当前 Leader 管理的会话和临时节点。

• 用途：调试 Leader 节点的会话管理和数据一致性问题。

12. srst

• 功能：重置统计信息。

• 用法：

  echo srst | nc 127.0.0.1 2181

• 返回：无输出，仅重置统计数据。

• 用途：在性能调试或基准测试中用于清除当前统计信息以进行新一轮测试。

13. crst

• 功能：重置连接统计信息。

• 用法：

  echo crst | nc 127.0.0.1 2181

• 返回：无输出，仅重置连接统计数据。

• 用途：用于清除当前连接的统计信息，通常用于调试连接问题。

14. dirs

• 功能：显示当前节点的数据目录及事务日志目录的大小。

• 用法：

  echo dirs | nc 127.0.0.1 2181

• 返回：列出数据目录和事务日志目录的大小（以字节为单位）。

• 用途：用于监控 ZooKeeper 数据存储的磁盘使用情况。

所有四字命令的列表

• ruok：检查节点健康状况。
• stat：获取节点状态信息。
• srvr：获取节点服务器信息。
• conf：获取节点配置。
• mntr：获取详细监控数据。
• wchs：查看监控器统计信息。
• wchc：查看设置监控器的客户端。
• wchp：查看被监控的路径。
• cons：查看当前连接的客户端信息。
• envi：显示节点环境变量。
• dump：查看 Leader 节点的会话信息。
• srst：重置统计数据。
• crst：重置连接统计数据。
• dirs：显示数据目录和日志目录的大小。

如何启用或限制四字命令

从 ZooKeeper 3.5 版本开始，你可以通过 zoo.cfg 配置文件中的 4lw.commands.whitelist 参数来控制哪些四字命令可以被执行：

• 启用所有命令：

  4lw.commands.whitelist=*

• 启用特定命令（如 ruok 和 stat）：

  4lw.commands.whitelist=ruok,stat

修改配置文件后，重启 ZooKeeper 以生效：

zkServer.sh restart

小结

ZooKeeper 的四字命令为运维人员提供了一种快速、轻量的方式来监控和管理节点的状态和健康。通过这些命令，能够轻松诊断集群运行问题并进行健康检查。