Zookeeper常用命令大全之四字监控命令

本是古典何须时尚 2023-09-24 14:58 56阅读 0赞

#### 文章目录 ####

*  四字监控命令
 *   *   *  0. 官方文档
         *  1. conf命令
         *  2. cons命令
         *  3. crst命令
         *  4. dump命令
         *  5. envi命令
         *  6. ruok命令
         *  7. stat命令
         *  8. srst命令
         *  9. wchs命令
         *  10. wchc命令(一般不用)
         *  11. wchp命令(一般不用)
         *  12. mntr命令

## 四字监控命令 ##

zookeeper支持某些特定的四字命令与其的交互。它们大多是查询命令，用来获取zookeeper服务的当前状态及相关信息。用户在客户端可以用过**telnet**或**nc**向zookeeper提交相应的命令。

**zookeeper常用的四字命令见下表所示：**

<table> 
 <thead> 
  <tr> 
   <th>命令</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>conf</td> 
   <td>输出相关服务配置的详情信息。如：端口、zk数据及日志配置路径、最大连接数，session超时时间、serverID等。</td> 
  </tr> 
  <tr> 
   <td>cons</td> 
   <td>列出所有连接到这台服务器的客户端连接/会话的详细信息。包括“接受/发送"的包数量、sessionID、操作延迟、最后的操作执行等信息。</td> 
  </tr> 
  <tr> 
   <td>crst</td> 
   <td>重置当前这台服务器的所有连接/会话的统计信息</td> 
  </tr> 
  <tr> 
   <td>dump</td> 
   <td>列出未经处理的会话和临时节点</td> 
  </tr> 
  <tr> 
   <td>envi</td> 
   <td>输出关于服务器的环境详细信息</td> 
  </tr> 
  <tr> 
   <td>ruok</td> 
   <td>测试服务是否处于正确的运行状态。如果正常返回"imok"，否则返回空。</td> 
  </tr> 
  <tr> 
   <td>stat</td> 
   <td>输出服务器的详细信息：发送/接收包数量、连接数、模式(leader/follower)、节点总数、延迟。所有客户端的列表。</td> 
  </tr> 
  <tr> 
   <td>srst</td> 
   <td>重置server状态</td> 
  </tr> 
  <tr> 
   <td>wchs</td> 
   <td>列出服务器watches的简洁信息：连接总数、watching节点总数和watches总数。</td> 
  </tr> 
  <tr> 
   <td>wchc</td> 
   <td>通过session分组，列出watch的所有节点，它的输出是一个与watch相关的会话的节点列表。</td> 
  </tr> 
  <tr> 
   <td>mntr</td> 
   <td>列出集群的健康状态。包括”接收/发送"的包数量、操作延迟、当前服务模式(leader /follower)、节点总数、watch总数、临时节点总数。</td> 
  </tr> 
 </tbody> 
</table>

nc命令工具安装：

#root用户安装
    # 下载安装包
    yum install nc.x86_64
    
    # 查看集群的健康状态
    echo mntr | nc localhost 2181

**nc命令在执行时会创建一个会话。**

#### 0. 官方文档 ####

[https://zookeeper.apache.org/doc/current/zookeeperAdmin.html\#sc\_4lw][https_zookeeper.apache.org_doc_current_zookeeperAdmin.html_sc_4lw]

![在这里插入图片描述][280257aca4754c68bdca6e05ac8ff6f4.png]

#### 1. conf命令 ####

输出相关服务配置的详细信息

echo conf | nc 127.0.0.1 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>clientPort</td> 
   <td>客户端端口号</td> 
  </tr> 
  <tr> 
   <td>dataDir</td> 
   <td>数据快照文件目录 默认情况下10万吃事务操作生成一次快照</td> 
  </tr> 
  <tr> 
   <td>dataLogDir</td> 
   <td>事务日志文件目录，生产环境中放在独立的磁盘上</td> 
  </tr> 
  <tr> 
   <td>tickTime</td> 
   <td>服务器之间或客户端与服务器之间维持心跳的时间间隔(ms)</td> 
  </tr> 
  <tr> 
   <td>maxClientCnxns</td> 
   <td>最大连接数</td> 
  </tr> 
  <tr> 
   <td>minSessionTimeout</td> 
   <td>最小session超时 minSessionTimeout=tickTime*2</td> 
  </tr> 
  <tr> 
   <td>maxSessionTimeout</td> 
   <td>最大session超时 maxSessionTimeout=tickTime*20</td> 
  </tr> 
  <tr> 
   <td>serverId</td> 
   <td>服务器编号</td> 
  </tr> 
  <tr> 
   <td>initLimit</td> 
   <td>集群中的follower服务器(F)与leader服务器(L)之间初始连接时能容忍的最多心跳数</td> 
  </tr> 
  <tr> 
   <td>syncLimit</td> 
   <td>集群中的follower服务器(F)与leader服务器(L)之间 请求和应答值间能容忍的最多心跳数。</td> 
  </tr> 
  <tr> 
   <td>electionAlg</td> 
   <td>选举算法–&gt; 0：基于UDP的LeaderElection。 1:基于UDP的FastLeaderElection。 2:基于UDP和认证的FastLeaderElection。 3:基于TCP的FastLeaderElection，在3.4.14版本中，默认是3</td> 
  </tr> 
  <tr> 
   <td>electionPort</td> 
   <td>选举端口</td> 
  </tr> 
  <tr> 
   <td>quorumPort</td> 
   <td>数据通信端口</td> 
  </tr> 
  <tr> 
   <td>peerType</td> 
   <td>是否为观察者，1为观察者</td> 
  </tr> 
 </tbody> 
</table>

#### 2. cons命令 ####

列出所有连接到这台服务器的客户端连接/会话的详细信息

echo cons | nc 127.0.0.1 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ip</td> 
   <td>ip地址</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>端口号</td> 
  </tr> 
  <tr> 
   <td>queued</td> 
   <td>等待被处理的请求数，请求缓存在队列中</td> 
  </tr> 
  <tr> 
   <td>received</td> 
   <td>收到的包数</td> 
  </tr> 
  <tr> 
   <td>sent</td> 
   <td>发送的包数</td> 
  </tr> 
  <tr> 
   <td>sid</td> 
   <td>会话ID</td> 
  </tr> 
  <tr> 
   <td>lop</td> 
   <td>最后的操作 GETD-读数据 DELE-删除数据 CREA-创建数据</td> 
  </tr> 
  <tr> 
   <td>est</td> 
   <td>连续时间戳</td> 
  </tr> 
  <tr> 
   <td>to</td> 
   <td>超时时间</td> 
  </tr> 
  <tr> 
   <td>lcxid</td> 
   <td>当前会话的操作id 每次操作+1</td> 
  </tr> 
  <tr> 
   <td>lzxid</td> 
   <td>最大事务id</td> 
  </tr> 
  <tr> 
   <td>lresp</td> 
   <td>最后响应时间戳</td> 
  </tr> 
  <tr> 
   <td>llat</td> 
   <td>最后/最新 延时</td> 
  </tr> 
  <tr> 
   <td>minlat</td> 
   <td>最小延时</td> 
  </tr> 
  <tr> 
   <td>maxlat</td> 
   <td>最大延时</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>平均延时</td> 
  </tr> 
 </tbody> 
</table>

#### 3. crst命令 ####

重置当前这台服务器所有连接/会话的统计信息

echo crst | nc 127.0.0.1 2181

#### 4. dump命令 ####

列出未经处理的会话和临时节点

echo dump | nc 127.0.0.1 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>session id</td> 
   <td>znode path(1对多，处于队列中排队的session和临时节点)</td> 
  </tr> 
 </tbody> 
</table>

#### 5. envi命令 ####

输出关于服务器的环境配置信息

echo envi | nc 127.0.0.1 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>zookeeper.verison</td> 
   <td>版本</td> 
  </tr> 
  <tr> 
   <td>host.name</td> 
   <td>host信息</td> 
  </tr> 
  <tr> 
   <td>java.version</td> 
   <td>java版本</td> 
  </tr> 
  <tr> 
   <td>java.vendor</td> 
   <td>供应商</td> 
  </tr> 
  <tr> 
   <td>java.home</td> 
   <td>运行环境所在目录</td> 
  </tr> 
  <tr> 
   <td>java.class.path</td> 
   <td>classpath</td> 
  </tr> 
  <tr> 
   <td>java.libraray.path</td> 
   <td>第三方库指定非java类包的位置(如：dll,so)</td> 
  </tr> 
  <tr> 
   <td>java.io.tempdir</td> 
   <td>默认的临时文件路径</td> 
  </tr> 
  <tr> 
   <td>java.compiler</td> 
   <td>JIT编译器的名称</td> 
  </tr> 
  <tr> 
   <td>os.name</td> 
   <td>Linux</td> 
  </tr> 
  <tr> 
   <td>os.arch</td> 
   <td>amd</td> 
  </tr> 
  <tr> 
   <td>os.version</td> 
   <td>3.10.0-1062.el7.x86_64</td> 
  </tr> 
  <tr> 
   <td>user.name</td> 
   <td>root</td> 
  </tr> 
  <tr> 
   <td>user.home</td> 
   <td>/root</td> 
  </tr> 
  <tr> 
   <td>user.dir</td> 
   <td>/software/Zookeeper/group/zookeeper2181/bin</td> 
  </tr> 
 </tbody> 
</table>

#### 6. ruok命令 ####

测试服务是否处于正确运行状态

echo ruok | nc 127.0.0.1 2181

#### 7. stat命令 ####

输出服务器的详细信息与srvr相似，但是多了每个连接的会话信息

echo stat | nc 127.0.0.1 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Zookeeper version</td> 
   <td>版本</td> 
  </tr> 
  <tr> 
   <td>Latency min/avg/max</td> 
   <td>延时</td> 
  </tr> 
  <tr> 
   <td>Received</td> 
   <td>接收到的包数</td> 
  </tr> 
  <tr> 
   <td>Sent</td> 
   <td>发送的包数</td> 
  </tr> 
  <tr> 
   <td>Connections</td> 
   <td>连接数</td> 
  </tr> 
  <tr> 
   <td>Outstanding</td> 
   <td>堆积数</td> 
  </tr> 
  <tr> 
   <td>Zxid</td> 
   <td>最大事务ID</td> 
  </tr> 
  <tr> 
   <td>Mode</td> 
   <td>服务器角色</td> 
  </tr> 
  <tr> 
   <td>Node count</td> 
   <td>节点数</td> 
  </tr> 
 </tbody> 
</table>

#### 8. srst命令 ####

重置server状态

echo srst | nc 127.0.0.1 2181

#### 9. wchs命令 ####

列出服务器watches的简洁信息

echo wchs | nc 127.0.0.1 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>connections</td> 
   <td>连接数</td> 
  </tr> 
  <tr> 
   <td>watch-paths</td> 
   <td>watch节点数</td> 
  </tr> 
  <tr> 
   <td>watchers</td> 
   <td>watcher数量</td> 
  </tr> 
 </tbody> 
</table>

#### 10. wchc命令(一般不用) ####

通过session分组，列出watch的所有节点，它输出的是一个与watch相关的会话的节点列表。

echo wchc | nc 127.0.0.1 2181

问题：

wchc is not executed because it is not in the whitelist.

解决方法：

# 修改启动指令 zkServer.sh
    
    # 注意找到这个信息
    else echo "JMX disabled by user request" >&2
        ZOOMAIN="org.apache.zookeeper.server.quorum.QuorumPeerMain"
    fi
    
    #下面添加如下信息
    ZOOMAIN="-Dzookeeper.4lw.commands.whitelist=* ${ZOOMAIN}"

#### 11. wchp命令(一般不用) ####

通过路径分组，列出所有的watch的session id信息。

echo wchp | nc 127.0.0.1 2181

问题：

wchc is not executed because it is not in the whitelist.

解决方法：

#### 12. mntr命令 ####

列出服务器的健康状态

echo mntr | nc localhost 2181

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>zk_version</td> 
   <td>版本</td> 
  </tr> 
  <tr> 
   <td>zk_avg_latency</td> 
   <td>平均延时</td> 
  </tr> 
  <tr> 
   <td>zk_max_latency</td> 
   <td>最大延时</td> 
  </tr> 
  <tr> 
   <td>zk_min_latency</td> 
   <td>最小延时</td> 
  </tr> 
  <tr> 
   <td>zk_packets_received</td> 
   <td>收包数</td> 
  </tr> 
  <tr> 
   <td>zk_packets_sent</td> 
   <td>发包数</td> 
  </tr> 
  <tr> 
   <td>zk_num_alive_connections</td> 
   <td>连接数</td> 
  </tr> 
  <tr> 
   <td>zk_outstanding_requests</td> 
   <td>堆积请求数</td> 
  </tr> 
  <tr> 
   <td>zk_server_state</td> 
   <td>leader/follower状态</td> 
  </tr> 
  <tr> 
   <td>zk_znode_count</td> 
   <td>znode数量</td> 
  </tr> 
  <tr> 
   <td>zk_watch_count</td> 
   <td>watch数量</td> 
  </tr> 
  <tr> 
   <td>zk_ephemerals_count</td> 
   <td>临时节点（znode）</td> 
  </tr> 
  <tr> 
   <td>zk_approximate_data_size</td> 
   <td>数据大小</td> 
  </tr> 
  <tr> 
   <td>zk_open_file_descriptor_count</td> 
   <td>打开的文件描述符数量</td> 
  </tr> 
  <tr> 
   <td>zk_max_file_descriptor_count</td> 
   <td>最大文件描述符数量</td> 
  </tr> 
 </tbody> 
</table>

[https_zookeeper.apache.org_doc_current_zookeeperAdmin.html_sc_4lw]: https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_4lw
[280257aca4754c68bdca6e05ac8ff6f4.png]: https://img-blog.csdnimg.cn/280257aca4754c68bdca6e05ac8ff6f4.png