lsyncd实时同步搭建指南——取代rsync+inotify1. 几大实时同步工具比较2. 使用 lsyncd 本地目录实时备份3. lsyncd的其它功能

最近一直在寻求生产服务服务器上的同步替代方案，原先使用的是<code>inotify + rsync</code>，但随着文件数量的增大到100w+，目录下的文件列表就达20m，在网络状况不佳或者限速的情况下，变更的文件可能10来个才几m，却因此要发送的文件列表就达20m，严重减低的带宽的使用效率以及同步效率；更为要紧的是，加入inotifywait在5s内监控到10个小文件发生变化，便会触发10个rsync同步操作，结果就是真正需要传输的才2-3m的文件，比对的文件列表就达200m。使用这两个组合的好处在于，它们都是最基本的软件，可以通过不同选项做到很精确的控制，比如排除同步的目录，同步多个模块或同步到多个主机。

国产开源，文档不是很全，在2011年之后就没更新了（googlecode都要快关闭了，其实可以转交其他人维护），网上关于它的使用和讨论都止于10年了

采用xml配置文件的方式，可读性比较好，但是有些原生的有些功能没有实现就没法使用了

无法实现多目录同步，只能通过多个配置文件启动多个进程

文件排除功能太弱。这个要看需求，不是每个人都需要排除子目录。而对于我的环境中，这个功能很重要，而且排除的规则较多

虽然提供插件的功能，但很鸡肋，因为软件本身没有持续更新，也没有看到贡献有其它插件出现（可能是我知识面不够，还用不到里面的refreshcdn plugin）。

其实我们也不能要求每一个软件功能都十分健全，关键是看能否满足我们当下的特定的需求。所谓好的架构不是设计出来的，而是进化来的。目前使用<code>sersync2</code>没什么问题，而且看了它的设计思路应该是比较科学的，特别是过滤队列的设计。双向同步看起来也是可以实现。

lysncd 实际上是lua语言封装了 inotify 和 rsync 工具，采用了 linux 内核（2.6.13 及以后）里的 inotify 触发机制，然后通过rsync去差异同步，达到实时的效果。我认为它最令人称道的特性是，完美解决了 <code>inotify + rsync</code>海量文件同步带来的文件频繁发送文件列表的问题 —— 通过时间延迟或累计触发事件次数实现。另外，它的配置方式很简单，lua本身就是一种配置语言，可读性非常强。lsyncd也有多种工作模式可以选择，本地目录cp，本地目录rsync，远程目录rsyncssh。

实现简单高效的本地目录同步备份（网络存储挂载也当作本地目录），一个命令搞定。

这一节实现的功能是，本地目录source实时同步到另一个目录target，而在source下有大量的文件，并且有部分目录和临时文件不需要同步。

安装<code>lsyncd</code>极为简单，已经收录在ubuntu的官方镜像源里，直接通过<code>apt-get install lsyncd</code>就可以。

源码编译安装

从源码编译安装可以使用最新版的lsyncd程序，但必须要相应的依赖库文件和编译工具：<code>yum install lua lua-devel asciidoc cmake</code>。

我这个版本编译时有个小bug，如果按照<code>install</code>在<code>build</code>目录中make，会提示：

解决办法是要么直接在解压目录下cmake，不要<code>mkdir build</code>，要么在<code>cmakelist.txt</code>中搜索<code>doc</code>字符串，在前面加上<code>${project_source_dir}</code>。

下面都是在编译安装的情况下操作。

到这启动 lsycnd 就可以完成实时同步了，默认的许多参数可以满足绝大部分需求，非常简单。

settings

里面是全局设置，<code>--</code>开头表示注释，下面是几个常用选项说明：

<code>logfile</code> 定义日志文件

<code>stausfile</code> 定义状态文件

<code>nodaemon=true</code> 表示不启用守护模式，默认

<code>statusinterval</code> 将lsyncd的状态写入上面的statusfile的间隔，默认10秒

<code>inotifymode</code> 指定inotify监控的事件，默认是<code>closewrite</code>，还可以是<code>modify</code>或<code>closewrite or modify</code>

<code>maxprocesses</code> 同步进程的最大个数。假如同时有20个文件需要同步，而<code>maxprocesses = 8</code>，则最大能看到有8个rysnc进程

<code>maxdelays</code> 累计到多少所监控的事件激活一次同步，即使后面的<code>delay</code>延迟时间还未到

sync

里面是定义同步参数，可以继续使用<code>maxdelays</code>来重写settings的全局变量。一般第一个参数指定<code>lsyncd</code>以什么模式运行：<code>rsync</code>、<code>rsyncssh</code>、<code>direct</code>三种模式：

<code>default.rsync</code> ：本地目录间同步，使用rsync，也可以达到使用ssh形式的远程rsync效果，或daemon方式连接远程rsyncd进程；

<code>default.direct</code> ：本地目录间同步，使用<code>cp</code>、<code>rm</code>等命令完成差异文件备份；

<code>default.rsyncssh</code> ：同步到远程主机目录，rsync的ssh模式，需要使用key来认证

<code>source</code> 同步的源目录，使用绝对路径。

<code>target</code> 定义目的地址.对应不同的模式有几种写法：

<code>/tmp/dest</code> ：本地目录同步，可用于<code>direct</code>和<code>rsync</code>模式

<code>172.29.88.223:/tmp/dest</code> ：同步到远程服务器目录，可用于<code>rsync</code>和<code>rsyncssh</code>模式，拼接的命令类似于<code>/usr/bin/rsync -ltsd --delete --include-from=- --exclude=* source target</code>，剩下的就是rsync的内容了，比如指定username，免密码同步

<code>172.29.88.223::module</code> ：同步到远程服务器目录，用于<code>rsync</code>模式

三种模式的示例会在后面给出。

<code>init</code> 这是一个优化选项，当<code>init = false</code>，只同步进程启动以后发生改动事件的文件，原有的目录即使有差异也不会同步。默认是<code>true</code>

<code>delay</code> 累计事件，等待rsync同步延时时间，默认15秒（最大累计到1000个不可合并的事件）。也就是15s内监控目录下发生的改动，会累积到一次rsync同步，避免过于频繁的同步。（可合并的意思是，15s内两次修改了同一文件，最后只同步最新的文件）

<code>excludefrom</code> 排除选项，后面指定排除的列表文件，如<code>excludefrom = "/etc/lsyncd.exclude"</code>，如果是简单的排除，可以使用<code>exclude = list</code>。

这里的排除规则写法与原生rsync有点不同，更为简单：

监控路径里的任何部分匹配到一个文本，都会被排除，例如<code>/bin/foo/bar</code>可以匹配规则<code>foo</code>

如果规则以斜线<code>/</code>开头，则从头开始要匹配全部

如果规则以<code>/</code>结尾，则要匹配监控路径的末尾

<code>?</code>匹配任何字符，但不包括<code>/</code>

<code>*</code>匹配0或多个字符，但不包括<code>/</code>

<code>**</code>匹配0或多个字符，可以是<code>/</code>

rsync

（提示一下，<code>delete</code>和<code>exclude</code>本来都是rsync的选项，上面是配置在sync中的，我想这样做的原因是为了减少rsync的开销）

<code>bwlimit</code> 限速，单位kb/s，与rsync相同（这么重要的选项在文档里竟然没有标出）

<code>compress</code> 压缩传输默认为<code>true</code>。在带宽与cpu负载之间权衡，本地目录同步可以考虑把它设为<code>false</code>

<code>perms</code> 默认保留文件权限。

其它rsync的选项

其它还有rsyncssh模式独有的配置项，如<code>host</code>、<code>targetdir</code>、<code>rsync_path</code>、<code>password_file</code>，见后文示例。<code>rsyncops={"-avz","--delete"}</code>这样的写法在2.1.*版本已经不支持。

<code>lsyncd.conf</code>可以有多个<code>sync</code>，各自的source，各自的target，各自的模式，互不影响。

使用命令加载配置文件，启动守护进程，自动同步目录操作。

以下配置本人都已经过验证可行，必须根据实际需要裁剪配置：

上面的内容几乎涵盖了所有同步的模式，其中第<code>iii</code>个要求像rsync一样配置rsyncd服务端，见本文开头。第<code>iv</code>、<code>v</code>配置ssh方式同步，达到的效果相同，但实际同步时你会发现每次同步都会提示输入ssh的密码，可以通过以下方法解决：

在远端被同步的服务器上开启ssh无密码登录，请注意用户身份：

把<code>id_rsa</code>私钥拷贝到执行lsyncd的机器上

另外偶然想到个问题，同时设置了<code>maxdelays</code>和<code>delay</code>，当监控目录一直没有文件变化了，也会发生同步操作，虽然没有可rsync的文件。

to-do：