文件同步工具 lsyncd2.1.6 安装使用问题

项目有文件实时同步备份的需求，做了一下调查，比较好的解决方法是使用lsyncd工具。这里主要记录一下遇到的问题及解决方法。

lsyncd 的相关介绍和对比可见：

lsyncd实时同步搭建指南——取代rsync+inotify

Linux下同步工具inotify+rsync使用详解

Linux文件系统Inotify机制

lsyncd官方文档：

Lsyncd - Live Syncing (Mirror) Daemon

---

 1、安装问题

安装时需要先安装 lua和cmake，可直接使用apt-get：

apt-get install lua5.1

apt-get install lua5.1-dev

apt-get install cmake

接着可以下载 lsyncd-2.1.6 版本解压安装，解压后进入改目录：

cmake ,

make

make install

即可完成安装。

---

 2、使用问题

如果使用在大型系统上，文件数量多、大，文件变化频繁，则要修改一些系统参数。

因为lsyncd 有用到 inotify监听，其中相关的主要是这几个参数：

#ls -l /proc/sys/fs/inotify/
total 0
-rw-r--r-- 1 root root 0 Oct  9 09:36 max_queued_events
-rw-r--r-- 1 root root 0 Oct  9 09:36 max_user_instances
-rw-r--r-- 1 root root 0 Oct  9 09:36 max_user_watches

/proc/sys/fs/inotify/max_user_instances 默认值: 128 指定了每一个real user ID可创建的inotify instatnces的数量上限
/proc/sys/fs/inotify/max_user_watches 默认值: 8192 指定了每个inotify instance相关联的watches的上限
/proc/sys/fs/inotify/max_queued_events 默认值： 16384，Inotify 管理的队列的最大长度

如果监听的文件数量大，则增大 max_user_watches（否则可能启动失败），如果文件变化频繁，则增大max_queued_events（否则队列溢出，导致部分文件未同步或lsyncd重启） ：

一次性方法：

sysctl fs.inotify.max_user_watches=xxxxxx

长久有效：

fs.inotify.max_user_watches=xxxxxx 写进 /ect/sysctl.conf，然后 sysctl -p 打印查看

（注意：max_queued_events 修改后，需要重启lsyncd才能生效----2018-6-14 更新说明）

参考：

linux 高效的文件系统事件监控 内核级解析方案 inotify

Lsyncd causes load while monitoring large filesystem.

---

 3、基本参数介绍

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

• logfile 定义日志文件
• stausFile 定义状态文件
• nodaemon=true 表示不启用守护模式，默认
• statusInterval 将lsyncd的状态写入上面的statusFile的间隔，默认10秒
• inotifyMode 指定inotify监控的事件，默认是CloseWrite，还可以是Modify或CloseWrite or Modify
• maxProcesses 同步进程的最大个数。假如同时有20个文件需要同步，而maxProcesses = 8，则最大能看到有8个rysnc进程
• maxDelays 累计到多少所监控的事件激活一次同步，即使后面的delay延迟时间还未到

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

• default.rsync ：本地目录间同步，使用rsync，也可以达到使用ssh形式的远程rsync效果，或daemon方式连接远程rsyncd进程；
  default.direct ：本地目录间同步，使用cp、rm等命令完成差异文件备份；
  default.rsyncssh ：同步到远程主机目录，rsync的ssh模式，需要使用key来认证

• source 同步的源目录，使用绝对路径。

• target 定义目的地址.对应不同的模式有几种写法：
  /tmp/dest ：本地目录同步，可用于direct和rsync模式
  172.29.88.223:/tmp/dest ：同步到远程服务器目录，可用于rsync和rsyncssh模式，拼接的命令类似于/usr/bin/rsync -ltsd --delete --include-from=- --exclude=* SOURCE TARGET，剩下的就是rsync的内容了，比如指定username，免密码同步
  172.29.88.223::module ：同步到远程服务器目录，用于rsync模式
  三种模式的示例会在后面给出。

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

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

• excludeFrom 排除选项，后面指定排除的列表文件，如excludeFrom = "/etc/lsyncd.exclude"，如果是简单的排除，可以使用exclude = LIST。
  这里的排除规则写法与原生rsync有点不同，更为简单：
  • 监控路径里的任何部分匹配到一个文本，都会被排除，例如/bin/foo/bar可以匹配规则foo
  • 如果规则以斜线/开头，则从头开始要匹配全部
  • 如果规则以/结尾，则要匹配监控路径的末尾
  • ?匹配任何字符，但不包括/
  • *匹配0或多个字符，但不包括/
  • **匹配0或多个字符，可以是/

• delete 为了保持target与souce完全同步，Lsyncd默认会delete = true来允许同步删除。它除了false，还有startup、running值，请参考 Lsyncd 2.1.x ‖ Layer 4 Config ‖ Default Behavior。

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

• bwlimit 限速，单位kb/s，与rsync相同（这么重要的选项在文档里竟然没有标出）
• compress 压缩传输默认为true。在带宽与cpu负载之间权衡，本地目录同步可以考虑把它设为false
• perms 默认保留文件权限。
• 其它rsync的选项

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

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

引用：

lsyncd实时同步搭建指南——取代rsync+inotify

---

更新至 2018-06-06