什麼是Etcd?

    文章大部分引至：http://jolestar.com/etcd-architecture/

Etcd 按照官方介紹

Etcd is a distributed, consistent key-value store for shared configuration and service discovery

是一個分佈式的，一致的 key-value 存儲，主要用途是共享配置和服務發現。Etcd 已經在不少分佈式系統中獲得普遍的使用，本文的架構與實現部分主要解答如下問題：

1. Etcd是如何實現一致性的？
2. Etcd的存儲是如何實現的？
3. Etcd的watch機制是如何實現的？
4. Etcd的key過時機制是如何實現的？

爲何須要 Etcd ？

全部的分佈式系統，都面臨的一個問題是多個節點之間的數據共享問題，這個和團隊協做的道理是同樣的，成員能夠分頭幹活，但老是須要共享一些必須的信息，好比誰是 leader， 都有哪些成員，依賴任務之間的順序協調等。因此分佈式系統要麼本身實現一個可靠的共享存儲來同步信息（好比 Elasticsearch ），要麼依賴一個可靠的共享存儲服務，而 Etcd 就是這樣一個服務。

Etcd 提供什麼能力？

Etcd 主要提供如下能力，已經熟悉 Etcd 的讀者能夠略過本段。

1. 提供存儲以及獲取數據的接口，它經過協議保證 Etcd 集羣中的多個節點數據的強一致性。用於存儲元信息以及共享配置。
2. 提供監聽機制，客戶端能夠監聽某個key或者某些key的變動（v2和v3的機制不一樣，參看後面文章）。用於監聽和推送變動。
3. 提供key的過時以及續約機制，客戶端經過定時刷新來實現續約（v2和v3的實現機制也不同）。用於集羣監控以及服務註冊發現。
4. 提供原子的CAS（Compare-and-Swap）和 CAD（Compare-and-Delete）支持（v2經過接口參數實現，v3經過批量事務實現）。用於分佈式鎖以及leader選舉。

更詳細的使用場景不在這裏描述，有興趣的能夠參看文末infoq的一篇文章。

Etcd 如何實現一致性的？

說到這個就不得不提及raft協議。但這篇文章不是專門分析raft的，篇幅所限，不能詳細分析，有興趣的建議看raft協議的一個動畫。便於看後面的文章，我這裏簡單作個總結：

1. raft經過對不一樣的場景（選主，日誌複製）設計不一樣的機制，雖然下降了通用性（相對paxos），但同時也下降了複雜度，便於理解和實現。
2. raft內置的選主協議是給本身用的，用於選出主節點，理解raft的選主機制的關鍵在於理解raft的時鐘週期以及超時機制。
3. 理解 Etcd 的數據同步的關鍵在於理解raft的日誌同步機制。

Etcd 實現raft的時候，充分利用了go語言CSP併發模型和chan的魔法，想更進行一步瞭解的能夠去看源碼，這裏只簡單分析下它的wal日誌。

wal日誌是二進制的，解析出來後是以上數據結構LogEntry。其中第一個字段type，只有兩種，一種是0表示Normal，1表示ConfChange（ConfChange表示 Etcd 自己的配置變動同步，好比有新的節點加入等）。第二個字段是term，每一個term表明一個主節點的任期，每次主節點變動term就會變化。第三個字段是index，這個序號是嚴格有序遞增的，表明變動序號。第四個字段是二進制的data，將raft request對象的pb結構整個保存下。Etcd 源碼下有個tools/etcd-dump-logs，能夠將wal日誌dump成文本查看，能夠協助分析raft協議。

raft協議自己不關心應用數據，也就是data中的部分，一致性都經過同步wal日誌來實現，每一個節點將從主節點收到的data apply到本地的存儲，raft只關心日誌的同步狀態，若是本地存儲實現的有bug，好比沒有正確的將data apply到本地，也可能會致使數據不一致。

Etcd v2 與 v3

Etcd v2 和 v3 本質上是共享同一套 raft 協議代碼的兩個獨立的應用，接口不同，存儲不同，數據互相隔離。也就是說若是從 Etcd v2 升級到 Etcd v3，原來v2 的數據仍是隻能用 v2 的接口訪問，v3 的接口建立的數據也只能訪問經過 v3 的接口訪問。因此咱們按照 v2 和 v3 分別分析。

Etcd v2 存儲，Watch以及過時機制

Etcd v2 是個純內存的實現，並未實時將數據寫入到磁盤，持久化機制很簡單，就是將store整合序列化成json寫入文件。數據在內存中是一個簡單的樹結構。好比如下數據存儲到 Etcd 中的結構就如圖所示。

/nodes/1/name  node1  
/nodes/1/ip    192.168.1.1

store中有一個全局的currentIndex，每次變動，index會加1.而後每一個event都會關聯到currentIndex.

當客戶端調用watch接口（參數中增長 wait參數）時，若是請求參數中有waitIndex，而且waitIndex 小於 currentIndex，則從 EventHistroy 表中查詢index小於等於waitIndex，而且和watch key 匹配的 event，若是有數據，則直接返回。若是歷史表中沒有或者請求沒有帶 waitIndex，則放入WatchHub中，每一個key會關聯一個watcher列表。 當有變動操做時，變動生成的event會放入EventHistroy表中，同時通知和該key相關的watcher。

這裏有幾個影響使用的細節問題：

1. EventHistroy 是有長度限制的，最長1000。也就是說，若是你的客戶端停了許久，而後從新watch的時候，可能和該waitIndex相關的event已經被淘汰了，這種狀況下會丟失變動。
2. 若是通知watch的時候，出現了阻塞（每一個watch的channel有100個緩衝空間），Etcd 會直接把watcher刪除，也就是會致使wait請求的鏈接中斷，客戶端須要從新鏈接。
3. Etcd store的每一個node中都保存了過時時間，經過定時機制進行清理。

從而能夠看出，Etcd v2 的一些限制：

1. 過時時間只能設置到每一個key上，若是多個key要保證生命週期一致則比較困難。
2. watch只能watch某一個key以及其子節點（經過參數 recursive),不能進行多個watch。
3. 很難經過watch機制來實現完整的數據同步（有丟失變動的風險），因此當前的大多數使用方式是經過watch得知變動，而後經過get從新獲取數據，並不徹底依賴於watch的變動event。

Etcd v3 存儲，Watch以及過時機制

Etcd v3 將watch和store拆開實現，咱們先分析下store的實現。

Etcd v3 store 分爲兩部分，一部分是內存中的索引，kvindex，是基於google開源的一個golang的btree實現的，另一部分是後端存儲。按照它的設計，backend能夠對接多種存儲，當前使用的boltdb。boltdb是一個單機的支持事務的kv存儲，Etcd 的事務是基於boltdb的事務實現的。Etcd 在boltdb中存儲的key是reversion，value是 Etcd 本身的key-value組合，也就是說 Etcd 會在boltdb中把每一個版本都保存下，從而實現了多版本機制。

舉個例子： 用etcdctl經過批量接口寫入兩條記錄：

etcdctl txn <<<' 
put key1 "v1" 
put key2 "v2" 

'

再經過批量接口更新這兩條記錄：

etcdctl txn <<<' 
put key1 "v12" 
put key2 "v22" 

'

boltdb中其實有了4條數據：

rev={3 0}, key=key1, value="v1" 
rev={3 1}, key=key2, value="v2" 
rev={4 0}, key=key1, value="v12" 
rev={4 1}, key=key2, value="v22"

reversion主要由兩部分組成，第一部分main rev，每次事務進行加一，第二部分sub rev，同一個事務中的每次操做加一。如上示例，第一次操做的main rev是3，第二次是4。固然這種機制你們想到的第一個問題就是空間問題，因此 Etcd 提供了命令和設置選項來控制compact，同時支持put操做的參數來精確控制某個key的歷史版本數。

瞭解了 Etcd 的磁盤存儲，能夠看出若是要從boltdb中查詢數據，必須經過reversion，但客戶端都是經過key來查詢value，因此 Etcd 的內存kvindex保存的就是key和reversion以前的映射關係，用來加速查詢。

而後咱們再分析下watch機制的實現。Etcd v3 的watch機制支持watch某個固定的key，也支持watch一個範圍（能夠用於模擬目錄的結構的watch），因此 watchGroup 包含兩種watcher，一種是 key watchers，數據結構是每一個key對應一組watcher，另一種是 range watchers, 數據結構是一個 IntervalTree（不熟悉的參看文文末連接），方便經過區間查找到對應的watcher。

同時，每一個 WatchableStore 包含兩種 watcherGroup，一種是synced，一種是unsynced，前者表示該group的watcher數據都已經同步完畢，在等待新的變動，後者表示該group的watcher數據同步落後於當前最新變動，還在追趕。

當 Etcd 收到客戶端的watch請求，若是請求攜帶了revision參數，則比較請求的revision和store當前的revision，若是大於當前revision，則放入synced組中，不然放入unsynced組。同時 Etcd 會啓動一個後臺的goroutine持續同步unsynced的watcher，而後將其遷移到synced組。也就是這種機制下，Etcd v3 支持從任意版本開始watch，沒有v2的1000條歷史event表限制的問題（固然這是指沒有compact的狀況下）。

另外咱們前面提到的，Etcd v2在通知客戶端時，若是網絡很差或者客戶端讀取比較慢，發生了阻塞，則會直接關閉當前鏈接，客戶端須要從新發起請求。Etcd v3爲了解決這個問題，專門維護了一個推送時阻塞的watcher隊列，在另外的goroutine裏進行重試。

Etcd v3 對過時機制也作了改進，過時時間設置在lease上，而後key和lease關聯。這樣能夠實現多個key關聯同一個lease id，方便設置統一的過時時間，以及實現批量續約。

相比Etcd v2, Etcd v3的一些主要變化：

1. 接口經過grpc提供rpc接口，放棄了v2的http接口。優點是長鏈接效率提高明顯，缺點是使用不如之前方便，尤爲對不方便維護長鏈接的場景。
2. 廢棄了原來的目錄結構，變成了純粹的kv，用戶能夠經過前綴匹配模式模擬目錄。
3. 內存中再也不保存value，一樣的內存能夠支持存儲更多的key。
4. watch機制更穩定，基本上能夠經過watch機制實現數據的徹底同步。
5. 提供了批量操做以及事務機制，用戶能夠經過批量事務請求來實現Etcd v2的CAS機制（批量事務支持if條件判斷）。

Etcd，Zookeeper，Consul 比較

這三個產品是常常被人拿來作選型比較的。 Etcd 和 Zookeeper 提供的能力很是類似，都是通用的一致性元信息存儲，都提供watch機制用於變動通知和分發，也都被分佈式系統用來做爲共享信息存儲，在軟件生態中所處的位置也幾乎是同樣的，能夠互相替代的。兩者除了實現細節，語言，一致性協議上的區別，最大的區別在周邊生態圈。Zookeeper 是apache下的，用java寫的，提供rpc接口，最先從hadoop項目中孵化出來，在分佈式系統中獲得普遍使用（hadoop, solr, kafka, mesos 等）。Etcd 是coreos公司旗下的開源產品，比較新，以其簡單好用的rest接口以及活躍的社區俘獲了一批用戶，在新的一些集羣中獲得使用（好比kubernetes）。雖然v3爲了性能也改爲二進制rpc接口了，但其易用性上比 Zookeeper 仍是好一些。 而 Consul 的目標則更爲具體一些，Etcd 和 Zookeeper 提供的是分佈式一致性存儲能力，具體的業務場景須要用戶本身實現，好比服務發現，好比配置變動。而Consul 則以服務發現和配置變動爲主要目標，同時附帶了kv存儲。 在軟件生態中，越抽象的組件適用範圍越廣，但同時對具體業務場景需求的知足上確定有不足之處。

Etcd 的周邊工具

1. Confd
   在分佈式系統中，理想狀況下是應用程序直接和 Etcd 這樣的服務發現/配置中心交互，經過監聽 Etcd 進行服務發現以及配置變動。但咱們還有許多歷史遺留的程序，服務發現以及配置大多都是經過變動配置文件進行的。Etcd 本身的定位是通用的kv存儲，因此並無像 Consul 那樣提供實現配置變動的機制和工具，而 Confd 就是用來實現這個目標的工具。
   Confd 經過watch機制監聽 Etcd 的變動，而後將數據同步到本身的一個本地存儲。用戶能夠經過配置定義本身關注那些key的變動，同時提供一個配置文件模板。Confd 一旦發現數據變動就使用最新數據渲染模板生成配置文件，若是新舊配置文件有變化，則進行替換，同時觸發用戶提供的reload腳本，讓應用程序從新加載配置。
   Confd 至關於實現了部分 Consul 的agent以及consul-template的功能，做者是kubernetes的Kelsey Hightower，但大神貌似很忙，沒太多時間關注這個項目了，好久沒有發佈版本，咱們着急用，因此fork了一份本身更新維護，主要增長了一些新的模板函數以及對metad後端的支持。confd
2. Metad
   服務註冊的實現模式通常分爲兩種，一種是調度系統代爲註冊，一種是應用程序本身註冊。調度系統代爲註冊的狀況下，應用程序啓動後須要有一種機制讓應用程序知道『我是誰』，而後發現本身所在的集羣以及本身的配置。Metad 提供這樣一種機制，客戶端請求 Metad 的一個固定的接口 /self，由 Metad 告知應用程序其所屬的元信息，簡化了客戶端的服務發現和配置變動邏輯。
   Metad 經過保存一個ip到元信息路徑的映射關係來作到這一點，當先後端支持Etcd v3，提供簡單好用的 http rest 接口。 它會把 Etcd 的數據經過watch機制同步到本地內存中，至關於 Etcd 的一個代理。因此也能夠把它當作Etcd 的代理來使用，適用於不方便使用 Etcd v3的rpc接口或者想下降 Etcd 壓力的場景。 metad
3. Etcd 集羣一鍵搭建腳本
   Etcd 官方那個一鍵搭建腳本有bug，我本身整理了一個腳本，經過docker的network功能，一鍵搭建一個本地的 Etcd 集羣便於測試和試驗。一鍵搭建腳本

Etcd 使用注意事項

1. Etcd cluster 初始化的問題
   若是集羣第一次初始化啓動的時候，有一臺節點未啓動，經過v3的接口訪問的時候，會報告Error:  Etcdserver: not capable 錯誤。這是爲兼容性考慮，集羣啓動時默認的API版本是2.3，只有當集羣中的全部節點都加入了，確認全部節點都支持v3接口時，才提高集羣版本到v3。這個只有第一次初始化集羣的時候會遇到，若是集羣已經初始化完畢，再掛掉節點，或者集羣關閉重啓（關閉重啓的時候會從持久化數據中加載集羣API版本），都不會有影響。
2. Etcd 讀請求的機制
   v2  quorum=true 的時候，讀取是經過raft進行的，經過cli請求，該參數默認爲true。
   v3  –consistency=「l」 的時候（默認）經過raft讀取，不然讀取本地數據。sdk 代碼裏則是經過是否打開：WithSerializable option 來控制。
   一致性讀取的狀況下，每次讀取也須要走一次raft協議，能保證一致性，但性能有損失，若是出現網絡分區，集羣的少數節點是不能提供一致性讀取的。但若是不設置該參數，則是直接從本地的store裏讀取，這樣就損失了一致性。使用的時候須要注意根據應用場景設置這個參數，在一致性和可用性之間進行取捨。
3. Etcd 的 compact 機制Etcd 默認不會自動 compact，須要設置啓動參數，或者經過命令進行compact，若是變動頻繁建議設置，不然會致使空間和內存的浪費以及錯誤。Etcd v3 的默認的 backend quota 2GB，若是不 compact，boltdb 文件大小超過這個限制後，就會報錯：」Error: etcdserver: mvcc: database space exceeded」，致使數據沒法寫入。