05-zk 日志和快照

zookeeper日志和快照

• 在zookeeper的配置文件zoo.cfg文件中，dataDir对应的是快照日志文件保存路径，dataLogDir对应的是事务日志文件，当我们直接查看日志文件时，看到是二进制文件，我们无法直接解读。

一、事物日志

• 事务日志指zookeeper系统在正常运行过程中，针对所有的写操作，在返回客户端“更新成功”的响应前，zookeeper会保证已经将本次更新操作的事务日志已经写到磁盘上，
  只有这样，整个更新操作才会生效。文件的命名规则是log.xx,xx是16进制表示的第一个写入的事物的ID

1.1 查看事物日志

• zookeeper提供了LogFormatter工具进行转换，查看事务日志内容，命令如下：

java -classpath .:lib/slf4j-api-1.7.25.jar:zookeeper-3.4.14.jar org.apache.zookeeper.server.LogFormatter /opt/zookeeper/transactionLog/version-2/log.4

其中：/opt/zookeeper/transactionLog/version-2/log.4是日志路径下的日志文件
命令是在zookeeper的bin目录下执行的，因此使用.:lib
zookeeper-3.4.14.jar表示我所使用的zk版本是3.4.12版本

• 截取部分日志内容如下（这是我使用zookeeper测试了分布式锁之后的事物日志）：

6/14/19 12:47:42 PM CST session 0x1006bbdec860091 cxid 0xe7 zxid 0x5c9 closeSession null
6/14/19 12:47:42 PM CST session 0x1006bbdec8600d3 cxid 0x6c zxid 0x5ca create '/lock,,v{s{31,s{'world,'anyone}}},T,198

6/14/19 12:47:42 PM CST session 0x1006bbdec8600bf cxid 0x9a zxid 0x5cb error -110

6/14/19 12:47:42 PM CST session 0x1006bbdec86009c cxid 0xc2 zxid 0x5cc error -110

6/14/19 12:47:42 PM CST session 0x1006bbdec8600d3 cxid 0x6d zxid 0x5cd delete '/lock

6/14/19 12:47:42 PM CST session 0x1006bbdec8600d3 cxid 0x6e zxid 0x5ce closeSession null
6/14/19 12:47:42 PM CST session 0x1006bbdec86009c cxid 0xc7 zxid 0x5cf create '/lock,,v{s{31,s{'world,'anyone}}},T,199

6/14/19 12:47:42 PM CST session 0x1006bbdec8600bf cxid 0x9f zxid 0x5d0 error -110

6/14/19 12:47:42 PM CST session 0x1006bbdec86009c cxid 0xc8 zxid 0x5d1 delete '/lock

6/14/19 12:47:42 PM CST session 0x1006bbdec86009c cxid 0xc9 zxid 0x5d2 closeSession null
6/14/19 12:47:42 PM CST session 0x1006bbdec8600bf cxid 0xa4 zxid 0x5d3 create '/lock,,v{s{31,s{'world,'anyone}}},T,200

6/14/19 12:47:42 PM CST session 0x1006bbdec8600bf cxid 0xa5 zxid 0x5d4 delete '/lock

6/14/19 12:47:42 PM CST session 0x1006bbdec8600bf cxid 0xa6 zxid 0x5d5 closeSession null

1.2 事物日志配置

• 配置项dataLogDir是事物日志的存储路径。事务日志对ZooKeeper的影响非常大，强烈建议事务日志目录和数据目录分开，不要将事务日志记录在数据目录(主要用来存放内存数据库快照)下。

dataLogDir=/opt/zookeeper/transactionLog

二、快照日志

• 事物日志可以理解为zookeeper记录了相关的事物操作，而快照日志则可以理解是将全部的数据做一次完整的序列化，比如zk运行了很久之后，内存中的
  使用树形结构组织起来的数据有很多，将这些数据全部序列化后以文件的形式存储即为快照日志。假如在t1时刻保存了完整的快照日志，那么t1之前的所有
  事物日志即使全部丢失，也可以还原t1时刻zookeeper的状态。
• zookeeper快照文件的命名规则为snapshot.xx，xx表示zookeeper触发快照的那个瞬间，提交的最后一个事务的ID。

2.1 查看快照日志

• zookeeper提供了SnapshotFormatter 工具进行转换，查看快照日志内容，命令如下：

java -classpath .:lib/slf4j-api-1.7.25.jar:zookeeper-3.4.14.jar org.apache.zookeeper.server.SnapshotFormatter /opt/zookeeper/snapshotLog/version-2/snapshot.12154

• 还是在zookeeeper的主目录下面执行，因此lib使用的是.代表当前路径，snapshotLog是我的快照日志存储路径
• 截取部分快照日志内容如下（这是我使用zookeeper测试了分布式锁之后的事物日志）：

ZNode Details (count=5):
----
/
  cZxid = 0x00000000000000
  ctime = Thu Jan 01 08:00:00 CST 1970
  mZxid = 0x00000000000000
  mtime = Thu Jan 01 08:00:00 CST 1970
  pZxid = 0x00000000012154
  cversion = 16706
  dataVersion = 0
  aclVersion = 0
  ephemeralOwner = 0x00000000000000
  dataLength = 0
----
/lock
  cZxid = 0x00000000012154
  ctime = Fri Jun 14 14:02:39 CST 2019
  mZxid = 0x00000000012154
  mtime = Fri Jun 14 14:02:39 CST 2019
  pZxid = 0x00000000012154
  cversion = 0
  dataVersion = 0
  aclVersion = 0
  ephemeralOwner = 0x100704397b24141
  no data
----
/zookeeper
  cZxid = 0x00000000000000
  ctime = Thu Jan 01 08:00:00 CST 1970
  mZxid = 0x00000000000000
  mtime = Thu Jan 01 08:00:00 CST 1970
  pZxid = 0x00000000000000
  cversion = 0
  dataVersion = 0
  aclVersion = 0
  ephemeralOwner = 0x00000000000000
  dataLength = 0
----
/zookeeper/quota
  cZxid = 0x00000000000000
  ctime = Thu Jan 01 08:00:00 CST 1970
  mZxid = 0x00000000000000
  mtime = Thu Jan 01 08:00:00 CST 1970
  pZxid = 0x00000000000000
  cversion = 0
  dataVersion = 0
  aclVersion = 0
  ephemeralOwner = 0x00000000000000
  dataLength = 0
----
Session Details (sid, timeout, ephemeralCount):
0x100704397b24141, 30000, 1
0x100704397b24142, 30000, 0

2.2 快照日志配置

• 配置项dataDir是快照日志的存储路径

dataDir=/opt/zookeeper/snapshotLog

三、日志清理

• 可以配置快照日志和事物日志的清理频率和快照日志文件保存的个数

配置	作用	默认值
autopurge.snapRetainCount	开启自动清理功能后清理时要保留的版本数量。	默认值为3，最小值也为3
autopurge.purgeInterval	指定触发自动清理功能的时间间隔，单位为小时，值为大于或等于1的整数	默认值为0，表示不开启自动清理功能
dataDir	快照日志存储路径	默认是/tmp下面
dataLogDir	事物日志存储路径	无
preAllocSize	事物日志预先开辟大小	64MB (每个事务日志大小就是64M)
snapCount	写多少次事务日志后进行一次快照	100000(也就是默认进行了10W次事物之后，拍一次快照)

四、事物日志和快照日志的关联

• ZooKeeper集群中的每个服务器节点每次接收到写操作请求时，都会先将这次请求发送给leader，leader将这次写操作转换为带有状态的事务，然后leader会对这次写操作广播出去以便进行协调。当协调通过(大多数节点允许这次写)后，
  leader通知所有的服务器节点，让它们将这次写操作应用到内存数据库中，并将其记录到事务日志中。当事务日志记录的次数达到一定数量后(默认10W次)，就会将内存数据库序列化一次，使其持久化保存到磁盘上，序列化后的文件称
  为"快照文件"。每次拍快照都会生成新的事务日志。有了事务日志和快照，就可以让任意节点恢复到任意时间点(只要没有清理事务日志和快照)。
• 事物日志和快照日志可用于zookeeper恢复数据，假设t1时刻保存了快照日志，t1到t2时刻保存了事物日志(这段时间内没有再新增快照)，那么t2时刻重启zookeeper，数据不会丢失
• 快照相当于将当前的zookeeper状态记录了下来，保留了快照之后，该快照之前创建的快照和事物日志丢失是没有影响的。
• 如果t1时刻保存了快照，但是t1到t2的事物日志丢失并且后面也没有快照，那么t1到t2之间的数据无法恢复，只能恢复到t1时刻的状态。

五、zookeeper系统日志

• 前面的事物日志和快照日志是zookeeper在作为一个分布式协调者对外提供功能的日志，保证数据的恢复，那么zookeeper作为一个组件，还有自己的运行日志。zookeeper的运行日志是有log4j来配置。

5.1 配置

• ZooKeeper使用的log4j的配置文件为$ZOOKEEPER_HOME/conf/log4j.properties。

5.2 路径

• 默认情况下，系统日志文件为ZooKeeper安装目录下的zookeeper.out。如下是zkServer.sh文件中的一行内容，并且在使用start选项启动zookeeper的时候，日志会输出到"$ZOO_LOG_DIR/zookeeper.out"中。

_ZOO_DAEMON_OUT="$ZOO_LOG_DIR/zookeeper.out"

六、小结

• 本文主要了解zookeeper的事物日志，快照日志和系统日志，了解相关的配置和基本操作。

七、参考

• [1] zookeeper 事务日志与快照日志
• [2] zookeeper运行原理：zookeeper的快照和日志的关系snapshot和log
• [3] ZooKeeper系列(5)：ZooKeeper的日志和快照