lsyncd實時同步搭建指南——取代rsync+inotify

時間 2020-01-23

標籤 lsyncd 實時同步搭建指南取代 rsync+inotify rsync inotify 欄目 Linux 简体版

原文原文鏈接

1. 幾大實時同步工具比較

1.1 inotify + rsync

最近一直在尋求生產服務服務器上的同步替代方案，原先使用的是inotify + rsync，但隨着文件數量的增大到100W+，目錄下的文件列表就達20M，在網絡情況不佳或者限速的狀況下，變動的文件可能10來個才幾M，卻所以要發送的文件列表就達20M，嚴重減低的帶寬的使用效率以及同步效率；更爲要緊的是，加入inotifywait在5s內監控到10個小文件發生變化，便會觸發10個rsync同步操做，結果就是真正須要傳輸的才2-3M的文件，比對的文件列表就達200M。使用這兩個組合的好處在於，它們都是最基本的軟件，能夠經過不一樣選項作到很精確的控制，好比排除同步的目錄，同步多個模塊或同步到多個主機。css

搭建過程參考 Linux下同步工具inotify+rsync使用詳解。html

1.2 sersync

後來聽同事說 sersync 這麼個工具能夠提升同步的性能，也解決了同步大文件時出現異常的問題，因此就嘗試了一下。sersync是國內的一個開發者開源出來的，使用c++編寫，採用多線程的方式進行同步，失敗後還有重傳機制，對臨時文件過濾，自帶crontab定時同步功能。網上看到有人說性能還不錯，說一下個人觀點：java

國產開源，文檔不是很全，在2011年以後就沒更新了（googlecode都要快關閉了，其實能夠轉交其餘人維護），網上關於它的使用和討論都止於10年了linux
採用xml配置文件的方式，可讀性比較好，可是有些原生的有些功能沒有實現就無法使用了c++
沒法實現多目錄同步，只能經過多個配置文件啓動多個進程git
文件排除功能太弱。這個要看需求，不是每一個人都須要排除子目錄。而對於個人環境中，這個功能很重要，並且排除的規則較多github
雖然提供插件的功能，但很雞肋，由於軟件自己沒有持續更新，也沒有看到貢獻有其它插件出現（多是我知識面不夠，還用不到裏面的refreshCDN plugin）。shell

雖然不懂c++，但大體看了下源碼 FileSynchronize，拼接rsync命令大概在273行左右，最後一個函數就是排除選項，簡單一點能夠將--exclude=改爲--eclude-from來靈活控制。有機會再改吧。數據庫

另外，在做者的文章 Sersync服務器同步程序項目簡介與設計框架評論中，說能解決上面 rsync + inotify中所描述的問題。閱讀了下源碼，這個應該是沒有解決，由於在拼接rsync命令時，後面的目的地址始終是針對module的，只要執行rsync命令，就會對整個目錄進行遍歷，發送要比對的文件列表，而後再發送變化的文件。sersync只是減小了監聽的事件，減小了rsync的次數——這已是很大的改進，但每次rsync沒辦法改變。（若有其它見解可與我討論）ubuntu

其實咱們也不能要求每個軟件功能都十分健全，關鍵是看可否知足咱們當下的特定的需求。所謂好的架構不是設計出來的，而是進化來的。目前使用sersync2沒什麼問題，並且看了它的設計思路應該是比較科學的，特別是過濾隊列的設計。雙向同步看起來也是能夠實現。

1.3 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。

實現簡單高效的本地目錄同步備份（網絡存儲掛載也看成本地目錄），一個命令搞定。

2. 使用 lsyncd 本地目錄實時備份

這一節實現的功能是，本地目錄source實時同步到另外一個目錄target，而在source下有大量的文件，而且有部分目錄和臨時文件不須要同步。

2.1 安裝lsyncd

安裝lsyncd極爲簡單，已經收錄在ubuntu的官方鏡像源裏，直接經過apt-get install lsyncd就能夠。
在Redhat系（個人環境是CentOS 6.2 x86_64 ），能夠手動去下載 lsyncd-2.1.5-6.fc21.x86_64.rpm，但首先你得安裝兩個依賴yum install lua lua-devel。也能夠經過在線安裝，須要epel-release擴展包：

12	# rpm -ivh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm# yum install lsyncd

源碼編譯安裝
從源碼編譯安裝可使用最新版的lsyncd程序，但必需要相應的依賴庫文件和編譯工具：yum install lua lua-devel asciidoc cmake。

從 googlecode lsyncd 上下載的lsyncd-2.1.5.tar.gz，直接./configure、make && make install就能夠了。

從github上下載lsyncd-master.zip 的2.1.5版本使用的是 cmake 編譯工具，沒法./configure：

1234	# uzip lsyncd-master.zip# cd lsyncd-master# cmake -DCMAKE_INSTALL_PREFIX=/usr/local/lsyncd-2.1.5# make && make install

我這個版本編譯時有個小bug，若是按照INSTALL在build目錄中make，會提示：

[100%] Generating doc/lsyncd.1Updating the manpagea2x: failed: source file not found: doc/lsyncd.1.txtmake[2]: *** [doc/lsyncd.1] Error 1make[1]: *** [CMakeFiles/manpage.dir/all] Error 2make: *** [all] Error 2

解決辦法是要麼直接在解壓目錄下cmake，不要mkdir build，要麼在CMakeList.txt中搜索doc字符串，在前面加上${PROJECT_SOURCE_DIR}。

2.2 lsyncd.conf

下面都是在編譯安裝的狀況下操做。

2.2.1 lsyncd同步配置

1234567891011121314151617181920212223

# cd /usr/local/lsyncd-2.1.5# mkdir etc var# vi etc/lsyncd.confsettings {logfile      ="/usr/local/lsyncd-2.1.5/var/lsyncd.log",statusFile   ="/usr/local/lsyncd-2.1.5/var/lsyncd.status",inotifyMode  = "CloseWrite",maxProcesses = 7,-- nodaemon =true,}sync {default.rsync,source    = "/tmp/src",target    = "/tmp/dest",-- excludeFrom = "/etc/rsyncd.d/rsync_exclude.lst",rsync     = {binary    = "/usr/bin/rsync",archive   = true,compress  = true,verbose   = true}}

到這啓動 lsycnd 就能夠完成實時同步了，默認的許多參數能夠知足絕大部分需求，很是簡單。

2.2.2 lsyncd.conf配置選項說明

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，各自的模式，互不影響。

2.3 啓動lsyncd

使用命令加載配置文件，啓動守護進程，自動同步目錄操做。

lsyncd -log Exec /usr/local/lsyncd-2.1.5/etc/lsyncd.conf

2.4 lsyncd.conf其它模式示例

如下配置本人都已通過驗證可行，必須根據實際須要裁剪配置：

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091

settings {logfile ="/usr/local/lsyncd-2.1.5/var/lsyncd.log",statusFile ="/usr/local/lsyncd-2.1.5/var/lsyncd.status",inotifyMode = "CloseWrite",maxProcesses = 8,}-- I. 本地目錄同步，direct：cp/rm/mv。 適用：500+萬文件，變更不大sync {default.direct,source    = "/tmp/src",target    = "/tmp/dest",delay = 1maxProcesses = 1}-- II. 本地目錄同步，rsync模式：rsyncsync {default.rsync,source    = "/tmp/src",target    = "/tmp/dest1",excludeFrom = "/etc/rsyncd.d/rsync_exclude.lst",rsync     = {binary = "/usr/bin/rsync",archive = true,compress = true,bwlimit   = 2000}}-- III. 遠程目錄同步，rsync模式 + rsyncd daemonsync {default.rsync,source    = "/tmp/src",target    = "syncuser@172.29.88.223::module1",delete="running",exclude = { ".*", ".tmp" },delay = 30,init = false,rsync     = {binary = "/usr/bin/rsync",archive = true,compress = true,verbose   = true,password_file = "/etc/rsyncd.d/rsync.pwd",_extra    = {"--bwlimit=200"}}}-- IV. 遠程目錄同步，rsync模式 + ssh shellsync {default.rsync,source    = "/tmp/src",target    = "172.29.88.223:/tmp/dest",-- target    = "root@172.29.88.223:/remote/dest",-- 上面target，注意若是是普通用戶，必須擁有寫權限maxDelays = 5,delay = 30,-- init = true,rsync     = {binary = "/usr/bin/rsync",archive = true,compress = true,bwlimit   = 2000-- rsh = "/usr/bin/ssh -p 22 -o StrictHostKeyChecking=no"-- 若是要指定其它端口，請用上面的rsh}}-- V. 遠程目錄同步，rsync模式 + rsyncssh，效果與上面相同sync {default.rsyncssh,source    = "/tmp/src2",host      = "172.29.88.223",targetdir = "/remote/dir",excludeFrom = "/etc/rsyncd.d/rsync_exclude.lst",-- maxDelays = 5,delay = 0,-- init = false,rsync    = {binary = "/usr/bin/rsync",archive = true,compress = true,verbose   = true,_extra = {"--bwlimit=2000"},},ssh      = {port  =  1234}}

上面的內容幾乎涵蓋了全部同步的模式，其中第III個要求像rsync同樣配置rsyncd服務端，見本文開頭。第IV、V配置ssh方式同步，達到的效果相同，但實際同步時你會發現每次同步都會提示輸入ssh的密碼，能夠經過如下方法解決：

在遠端被同步的服務器上開啓ssh無密碼登陸，請注意用戶身份：

1234	user$ ssh-keygen -t rsa一路回車...user$ cd ~/.sshuser$ cat id_rsa.pub >> authorized_keys

把id_rsa私鑰拷貝到執行lsyncd的機器上

123	user$ chmod 600 ~/.ssh/id_rsa測試可否無密碼登陸user$ ssh user@172.29.88.223

3. lsyncd的其它功能

lsyncd的功能不只僅是同步，官方手冊 Lsyncd 2.1.x ‖ Layer 2 Config ‖ Advanced onAction 高級功能提到，還能夠監控某個目錄下的文件，根據觸發的事件本身定義要執行的命令，example是監控某個某個目錄，只要是有jpg、gif、png格式的文件參數，就把它們轉成pdf，而後同步到另外一個目錄。正好在我運維的一個項目中有這個需求，如今都是在java代碼裏轉換，還容易出現異常，經過lsyncd能夠代替這樣的功能。但，門檻在於要會一點點lua語言（根據官方example仍是能夠寫出來）。

另外偶然想到個問題，同時設置了maxDelays和delay，當監控目錄一直沒有文件變化了，也會發生同步操做，雖然沒有可rsync的文件。

TO-DO：