官网文档:https://axkibe.github.io/lsyncd/

一、lsyncd 介绍

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

二、lsyncd安装

ubuntu

安装lsyncd极为简单,已经收录在ubuntu的官方镜像源里,直接通过(安装的版本是2.1.5)

1
apt-get install lsyncd

Redhat

可以手动去下载lsyncd-2.1.5-6.fc21.x86_64.rpm,但首先你得安装两个依赖

1
yum install lua lua-devel -y  

也可以通过在线安装,需要epel-release扩展包:

1
2
3
4
5
rpm -ivh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
yum install lsyncd -y

systemctl enable lsyncd
systemctl start lsyncd

编译安装

github上下载lsyncd-master.zip 的2.2.2版本使用的是 cmake 编译工具,无法./configure:

1
2
3
4
uzip lsyncd-master.zip
cd lsyncd-master
cmake -DCMAKE_INSTALL_PREFIX=/usr/local/lsyncd
make && make install

三、lsyncd配置

配置文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
shell > cat lsyncd.conf.lua
settings {
logfile = "/data/logs/lsyncd/lsyncd.log",
statusFile = "/data/logs/lsyncd/lsyncd.status",
pidfile = "/var/run/lsyncd.pid",
inotifyMode = "CloseWrite or Modify",
maxProcesses = 8,
-- nodaemon =true,
}
sync {
default.rsync,
source = "/data/rsyslog", # 同步目录
target = "x.x.x.x::bgo_log_server", # 目的rsync
-- excludeFrom = "/etc/rsyncd.d/rsync_exclude.lst", # 排除目录
delay = 30,
init = false,
rsync = {
binary = "/usr/bin/rsync",
password_file = "/etc/rsync.pas",
archive = true,
compress = true,
verbose = true,
update = true,
checksum = true,
}
}

配置文件说明


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模式
    • ip:/tmp/dest :同步到远程服务器目录,可用于rsync和rsyncssh模式,拼接的命令类似于/usr/bin/rsync -ltsd –delete –include-from=- –exclude=* SOURCE TARGET,剩下的就是rsync的内容了,比如指定username,免密码同步
    • ip::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值。


创建配置文件

1
CONFIG=/etc/lsyncd/lsyncd.conf.lua

四、启动

1
2
3
/usr/local/lsyncd/bin/lsyncd -pidfile /var/run/lsyncd.pid /etc/lsyncd/lsyncd.conf.lua
# 或者
/etc/init.d/lsyncd start

五、遇到问题IO过大

  • 运用场景 日志实时写,做到实时同步
  • 每次同步,多会重新同步一次文件,造成io过高
  • 解决方案
  • 升级lsyncd 到2.x 版本 2.x版本才支持rsync append (追加同步减少io)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/etc/init.d/lsyncd stop
git clone https://github.com/axkibe/lsyncd.git
apt-get remove lsyncd
apt-get install liblua5.1-0-dev
cd lsyncd/
cmake -DCMAKE_INSTALL_PREFIX=/usr/local/lsyncd
make
make install
# 修改配置文件sync - rsync
vim /etc/lsyncd/lsyncd.conf.lua
append = true,
# 修改启动文件 bin 路径
vim /etc/init.d/lsyncd
# 启动
/etc/init.d/lsyncd start