Lsyncd实时同步搭建指南

时间：2023-03-09 02:43:18
Lsyncd实时同步搭建指南

Lsyncd实时同步搭建指南

linux文件实时同步： inotify+rsync、sersync、lsyncd工具比较

一、inotify + rsync

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

二、sersync

后来听同事说 sersync 这么个工具可以提高同步的性能，也解决了同步大文件时出现异常的问题，所以就尝试了一下。sersync是国内的一个开发者开源出来的，使用c++编写，采用多线程的方式进行同步，失败后还有重传机制，对临时文件过滤，自带crontab定时同步功能。网上看到有人说性能还不错，说一下我的观点：

  • 国产开源，文档不是很全，在2011年之后就没更新了（googlecode都要快关闭了，其实可以转交其他人维护），网上关于它的使用和讨论都止于10年了
  • 采用xml配置文件的方式，可读性比较好，但是有些原生的有些功能没有实现就没法使用了
  • 无法实现多目录同步，只能通过多个配置文件启动多个进程
  • 文件排除功能太弱。这个要看需求，不是每个人都需要排除子目录。而对于我的环境中，这个功能很重要，而且排除的规则较多
  • 虽然提供插件的功能，但很鸡肋，因为软件本身没有持续更新，也没有看到贡献有其它插件出现（可能是我知识面不够，还用不到里面的refreshCDNplugin）。

虽然不懂c++，但大致看了下源码 FileSynchronize，拼接rsync命令大概在273行左右，最后一个函数就是排除选项，简单一点可以将--exclude=改成--eclude-from来灵活控制。有机会再改吧。

另外，在作者的文章 Sersync服务器同步程序 项目简介与设计框架 评论中，说能解决上面 rsync + inotify中所描述的问题。阅读了下源码，这个应该是没有解决，因为在拼接rsync命令时，后面的目的地址始终是针对module的，只要执行rsync命令，就会对整个目录进行遍历，发送要比对的文件列表，然后再发送变化的文件。sersync只是减少了监听的事件，减少了rsync的次数——这已经是很大的改进，但每次rsync没办法改变。（如有其它看法可与我讨论）

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

三、 lsyncd

废话说这么多，本文就是介绍它了。有些博客说lsyncd是谷歌开源的，实际不是了，只是托管在了googlecode上而已，幸运的是已经迁移到github了：https://github.com/axkibe/lsyncd 。

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

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

lsyncd 还支持当监控到某个指定事件时就执行什么样的命令，由于是通过时间延迟和累计事件命中次数来触发同步，在设计上要优于inotify，另外他的同步速度完全取决于你的网络质量。

安装lsyncd

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

在Redhat系,可以通过编译的方式安装

$ yum install -y gcc gcc-c++ lua lua-devel cmake libxml2 libxml2-devel

$ cd /usr/local/src

$ wget https://github.com/axkibe/lsyncd/archive/release-2.2.2.tar.gz -O lsyncd-release-2.2.2.tar.gz

$ tar xf lsyncd-release-2.2.2.tar.gz

$ cd lsyncd-release-2.2.2

$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local/lsyncd

$ make && make install

$ ln -s /usr/local/lsyncd/bin/lsyncd /usr/bin/lsyncd

lsyncd.conf配置选项说明

重点参数说明：

--        # 注释符

settings  # 是全局配置

sync      # 定义同步参数 (lsyncd配置文件允许多个sync互不影响)

rsync     # 定义同步文件参数

ssh       # 定义服务器远程端口

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模式

  如果要同步到多个主机，可以参考：https://github.com/axkibe/lsyncd/issues/38

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

  • 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值。

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

以下是三种常用配置案例

  1. 远程同步rsync + ssh模式配置方案(需要事先做好ssh免密登陆，不然每次都需要输入密码)

     $ vim /etc/lsyncd.conf
    
 settings {
    
     logfile = "/var/log/lsyncd.log",          --日志路径
    
     statusFile = "/var/log/lsyncd.status",    --状态文件
    
     pidfile = "/var/run/lsyncd.pid",          --pid文件路径
    
     statusInterval = 1,                       --将lsyncd的状态写入上面的statusFile的间隔，默认10秒
    
     nodaemon = false,                         --daemon运行
    
     maxProcesses = 1,                         --同步进程的最大个数。假如同时有20个文件需要同步，而maxProcesses = 8，则最大能看到有8个rysnc进程
    
     maxDelays = 1,                            --累计到多少所监控的事件激活一次同步，即使后面的delay延迟时间还未到
    
 }
    
 sync {
    
     default.rsyncssh,      --默认rsync+ssh,rsync版本需要升级3以上版本
    
     source = "/apps/www/renwoleblog/",        --源目录
    
     delete = true,                            --保持完全同步
    
     host = "root@10.28.204.66",
    
     targetdir = "/apps/www/renwoleblog/bak/", --目标目录
    
     exclude={
    
         ".txt"            --需排除的文件
    
     },
    
     rsync = {
    
         binary = "/usr/bin/rsync", --需先安装好rsync
    
         archive = true,            --归档
    
         compress = false,          --压缩
    
         owner = true,              --属主
    
         perms = true,              --权限
    
         whole_file = false
    
         },
    
     ssh = {
    
         port = 22
    
     }
    
 }

  2. 本地目录同步配置方案：

     sync {
    
     default.rsync,
    
     source = "/apps/www/renwoleblog/",
    
     target = "/apps/www/renwoleblog/bak/",
    
 }

  3. 远程同步rsync-daemon模式配置方案(需要配置好rsync的服务端)

     settings {
    
     logfile = "/var/log/lsyncd.log",
    
     statusFile = "/var/log/lsyncd.status",
    
     pidfile = "/var/run/lsyncd.pid",
    
     statusInterval = 1,
    
     nodaemon = false,
    
     maxProcesses = 1,
    
     maxDelays = 1,
    
 }
    
 sync {
    
     default.rsync,
    
     source    = "/apps/www/renwoleblog/",
    
     target    = "rsyncuser@10.28.204.65::backup",
    
     delete="true",
    
     exclude = { ".bak*" },
    
     delay = 30,    --累计事件，等待rsync同步延时时间，默认15秒（最大累计到1000个不可合并的事件）。也就是15s内监控目录下发生的改动，会累积到一次rsync同步，避免过于频繁的同步。（可合并的意思是，15s内两次修改了同一文件，最后只同步最新的文件）
    
     init = true,  --这是一个优化选项，当init = false，只同步进程启动以后发生改动事件的文件，原有的目录即使有差异也不会同步。默认是true
    
     rsync = {
    
         binary = "/usr/bin/rsync",
    
         archive = true,
    
         compress = true,
    
         verbose   = true,
    
         perms = true,
    
         password_file = "/etc/rsync.password", --密码，权限是0600
    
         _extra    = {"--bwlimit=200"}    --bwlimit 限速，单位kb/s，与rsync相同（这么重要的选项在文档里竟然没有标出）
    
     }
    
 }

启动服务

#如果想将日志输出到屏幕则

$ /usr/local/lsyncd/bin/lsyncd -nodaemon /etc/lsyncd.conf

#如果想直接切到后台则

$ /usr/local/lsyncd/bin/lsyncd  /etc/lsyncd.conf

也可以通过脚本启动

$ systemctl restart lsyncd

  • 创建systemctl系统单元文件(可选)

    为了实现systemctl进行管理，请创建配置文件以及脚本启动文件，命令如下：

      $ vim /etc/sysconfig/lsyncd

    添加如下内容：

      LSYNCD_OPTIONS="/etc/lsyncd.conf"

    创建启动文件：

      $ vim /usr/lib/systemd/system/lsyncd.service

    添加如下内容：

      [Unit]
    
  Description=Live Syncing (Mirror) Daemon
    
  After=network.target

  [Service]
    
  Type=simple
    
  EnvironmentFile=-/etc/sysconfig/lsyncd
    
  ExecStart=/usr/local/lsyncd/bin/lsyncd -nodaemon $LSYNCD_OPTIONS

  [Install]
    
  WantedBy=multi-user.target

    启动lsyncd并加入开机自启动

      $ systemctl daemon-reload
    
  $ systemctl start lsyncd
    
  $ systemctl enable lsyncd

  • 创建init,service系统单元文件(可选)

    这个脚本占用的篇幅太长就不在文章中列出了。

来一例子

场景需求

lsync server: 10.0.0.7

rsyncd server: 10.0.0.13, 10.0.0.21, 10.0.0.6, 10.0.0.17

将10.0.0.7下的/usr/nginx/conf分别同步到10.0.0.13, 10.0.0.21, 10.0.0.6, 10.0.0.17的/usr/nginx/conf/

配置rsyncd服务

在10.0.0.13, 10.0.0.21, 10.0.0.6, 10.0.0.17配置rsyncd(假设已经安装好rsyncd)

  • rsyncd.conf (rsyncd.conf的配置这里就先不详细讲了)

      uid = nginx
    
  gid = nginx
    
  use chroot = no
    
  strict modes = no
    
  max connections = 1000
    
  charset=utf8
    
  log file = /var/log/rsyncd.log
    
  pid file = /var/run/rsyncd.pid
    
  hosts allow = 10.0.0.7
    
  hosts deny = *

  [nginx_rsync]
    
  path = /usr/nginx/conf/
    
  read only = rsync_user
    
  list = no
    
  exclude = .svn/
    
  dont compress = *.gz *.tgz *.zip *.z *.bz2 *.tbz
    
  auth users = rsync_user
    
  secrets file = /etc/rsync/rsync.pass

  • 创建rsync.pass(密码存储)

      $ vim /etc/rsync/rsync.pass
    
  rsync_user:1234567
    
  $ chown 0600 /etc/rsync/rsync.pass

配置lsync服务

以下在10.0.0.7操作(假设已经安装好lsync)

  • lsyncd.conf(lsyncd支持lua语法)

      settings {
    
      logfile = "/var/log/lsyncd.log",
    
      statusFile = "/var/log/lsyncd.status",
    
      pidfile = "/var/run/lsyncd.pid",
    
      statusInterval = 1,
    
      nodaemon = false,
    
      maxProcesses = 4
    
  }

  targetlist = {
    
      "rsync_user@10.0.0.13::nginx_rsync",
    
      "rsync_user@10.0.0.21::nginx_rsync",
    
      "rsync_user@10.0.0.6::nginx_rsync",
    
      "rsync_user@10.0.0.17::nginx_rsync",
    
  }

  for _, server in ipairs(targetlist) do
    
  sync {
    
      default.rsync,
    
      source    = "/usr/nginx/conf/",
    
      target    = server,
    
      delete    = "true",
    
      exclude = { ".bak*" },
    
      delay = 0,
    
      rsync = {
    
          binary = "/usr/bin/rsync",
    
          archive = true,
    
          compress = true,
    
          verbose   = true,
    
          perms = true,
    
          password_file = "/root/.lrsyncd.secret"
    
      }
    
  }
    
  end

  • 创建密码存储文件

      $ vim /root/.lrsyncd.secret
    
  1234567
    
  $ chown 0600 /root/.lrsyncd.secret

参考文档

https://klionsec.github.io/2017/11/18/lsyncd/

https://axkibe.github.io/lsyncd/manual/config/file/

https://github.com/axkibe/lsyncd/issues/241

原博

Lsyncd实时同步搭建指南

相关文章