peer_server.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848
  1. package server
  2. import (
  3. "bytes"
  4. "encoding/json"
  5. "fmt"
  6. "io/ioutil"
  7. "math/rand"
  8. "net/http"
  9. "net/url"
  10. "sort"
  11. "strconv"
  12. "sync"
  13. "time"
  14. "github.com/coreos/etcd/third_party/github.com/goraft/raft"
  15. "github.com/coreos/etcd/third_party/github.com/gorilla/mux"
  16. "github.com/coreos/etcd/discovery"
  17. etcdErr "github.com/coreos/etcd/error"
  18. "github.com/coreos/etcd/log"
  19. "github.com/coreos/etcd/metrics"
  20. "github.com/coreos/etcd/pkg/btrfs"
  21. "github.com/coreos/etcd/store"
  22. )
  23. const (
  24. // ThresholdMonitorTimeout is the time between log notifications that the
  25. // Raft heartbeat is too close to the election timeout.
  26. ThresholdMonitorTimeout = 5 * time.Second
  27. // ActiveMonitorTimeout is the time between checks on the active size of
  28. // the cluster. If the active size is different than the actual size then
  29. // etcd attempts to promote/demote to bring it to the correct number.
  30. ActiveMonitorTimeout = 1 * time.Second
  31. // PeerActivityMonitorTimeout is the time between checks for dead nodes in
  32. // the cluster.
  33. PeerActivityMonitorTimeout = 1 * time.Second
  34. )
  35. const (
  36. peerModeFlag = 0
  37. standbyModeFlag = 1
  38. )
  39. type PeerServerConfig struct {
  40. Name string
  41. Scheme string
  42. URL string
  43. SnapshotCount int
  44. RetryTimes int
  45. RetryInterval float64
  46. }
  47. type PeerServer struct {
  48. Config PeerServerConfig
  49. clusterConfig *ClusterConfig
  50. raftServer raft.Server
  51. server *Server
  52. joinIndex uint64
  53. followersStats *raftFollowersStats
  54. serverStats *raftServerStats
  55. registry *Registry
  56. store store.Store
  57. snapConf *snapshotConf
  58. mode Mode
  59. closeChan chan bool
  60. routineGroup sync.WaitGroup
  61. timeoutThresholdChan chan interface{}
  62. standbyPeerURL string
  63. standbyClientURL string
  64. metrics *metrics.Bucket
  65. sync.Mutex
  66. }
  67. // TODO: find a good policy to do snapshot
  68. type snapshotConf struct {
  69. // Etcd will check if snapshot is need every checkingInterval
  70. checkingInterval time.Duration
  71. // The index when the last snapshot happened
  72. lastIndex uint64
  73. // If the incremental number of index since the last snapshot
  74. // exceeds the snapshot Threshold, etcd will do a snapshot
  75. snapshotThr uint64
  76. }
  77. func NewPeerServer(psConfig PeerServerConfig, registry *Registry, store store.Store, mb *metrics.Bucket, followersStats *raftFollowersStats, serverStats *raftServerStats) *PeerServer {
  78. s := &PeerServer{
  79. Config: psConfig,
  80. clusterConfig: NewClusterConfig(),
  81. registry: registry,
  82. store: store,
  83. followersStats: followersStats,
  84. serverStats: serverStats,
  85. timeoutThresholdChan: make(chan interface{}, 1),
  86. metrics: mb,
  87. }
  88. return s
  89. }
  90. func (s *PeerServer) SetRaftServer(raftServer raft.Server) {
  91. s.snapConf = &snapshotConf{
  92. checkingInterval: time.Second * 3,
  93. // this is not accurate, we will update raft to provide an api
  94. lastIndex: raftServer.CommitIndex(),
  95. snapshotThr: uint64(s.Config.SnapshotCount),
  96. }
  97. raftServer.AddEventListener(raft.StateChangeEventType, s.raftEventLogger)
  98. raftServer.AddEventListener(raft.LeaderChangeEventType, s.raftEventLogger)
  99. raftServer.AddEventListener(raft.TermChangeEventType, s.raftEventLogger)
  100. raftServer.AddEventListener(raft.AddPeerEventType, s.raftEventLogger)
  101. raftServer.AddEventListener(raft.RemovePeerEventType, s.raftEventLogger)
  102. raftServer.AddEventListener(raft.HeartbeatIntervalEventType, s.raftEventLogger)
  103. raftServer.AddEventListener(raft.ElectionTimeoutThresholdEventType, s.raftEventLogger)
  104. raftServer.AddEventListener(raft.HeartbeatEventType, s.recordMetricEvent)
  105. s.raftServer = raftServer
  106. }
  107. // Mode retrieves the current mode of the server.
  108. func (s *PeerServer) Mode() Mode {
  109. return s.mode
  110. }
  111. // SetMode updates the current mode of the server.
  112. // Switching to a peer mode will start the Raft server.
  113. // Switching to a standby mode will stop the Raft server.
  114. func (s *PeerServer) setMode(mode Mode) {
  115. s.mode = mode
  116. switch mode {
  117. case PeerMode:
  118. if !s.raftServer.Running() {
  119. s.raftServer.Start()
  120. }
  121. case StandbyMode:
  122. if s.raftServer.Running() {
  123. s.raftServer.Stop()
  124. }
  125. }
  126. }
  127. // ClusterConfig retrieves the current cluster configuration.
  128. func (s *PeerServer) ClusterConfig() *ClusterConfig {
  129. return s.clusterConfig
  130. }
  131. // SetClusterConfig updates the current cluster configuration.
  132. // Adjusting the active size will cause the PeerServer to demote peers or
  133. // promote standbys to match the new size.
  134. func (s *PeerServer) SetClusterConfig(c *ClusterConfig) {
  135. // Set minimums.
  136. if c.ActiveSize < MinActiveSize {
  137. c.ActiveSize = MinActiveSize
  138. }
  139. if c.PromoteDelay < MinPromoteDelay {
  140. c.PromoteDelay = MinPromoteDelay
  141. }
  142. s.clusterConfig = c
  143. }
  144. // Try all possible ways to find clusters to join
  145. // Include log data in -data-dir, -discovery and -peers
  146. //
  147. // Peer discovery follows this order:
  148. // 1. previous peers in -data-dir
  149. // 2. -discovery
  150. // 3. -peers
  151. //
  152. // TODO(yichengq): RaftServer should be started as late as possible.
  153. // Current implementation to start it is not that good,
  154. // and should be refactored later.
  155. func (s *PeerServer) findCluster(discoverURL string, peers []string) {
  156. name := s.Config.Name
  157. isNewNode := s.raftServer.IsLogEmpty()
  158. // Try its best to find possible peers, and connect with them.
  159. if !isNewNode {
  160. // Take old nodes into account.
  161. allPeers := s.getKnownPeers()
  162. // Discover registered peers.
  163. // TODO(yichengq): It may mess up discoverURL if this is
  164. // set wrong by mistake. This may need to refactor discovery
  165. // module. Fix it later.
  166. if discoverURL != "" {
  167. discoverPeers, _ := s.handleDiscovery(discoverURL)
  168. allPeers = append(allPeers, discoverPeers...)
  169. }
  170. allPeers = append(allPeers, peers...)
  171. allPeers = s.removeSelfFromList(allPeers)
  172. // If there is possible peer list, use it to find cluster.
  173. if len(allPeers) > 0 {
  174. // TODO(yichengq): joinCluster may fail if there's no leader for
  175. // current cluster. It should wait if the cluster is under
  176. // leader election, or the node with changed IP cannot join
  177. // the cluster then.
  178. if err := s.startAsFollower(allPeers, 1); err == nil {
  179. log.Debugf("%s joins to the previous cluster %v", name, allPeers)
  180. return
  181. }
  182. log.Warnf("%s cannot connect to previous cluster %v", name, allPeers)
  183. }
  184. // TODO(yichengq): Think about the action that should be done
  185. // if it cannot connect any of the previous known node.
  186. s.raftServer.Start()
  187. log.Debugf("%s is restarting the cluster %v", name, allPeers)
  188. return
  189. }
  190. // Attempt cluster discovery
  191. if discoverURL != "" {
  192. discoverPeers, discoverErr := s.handleDiscovery(discoverURL)
  193. // It is registered in discover url
  194. if discoverErr == nil {
  195. // start as a leader in a new cluster
  196. if len(discoverPeers) == 0 {
  197. log.Debugf("%s is starting a new cluster via discover service", name)
  198. s.startAsLeader()
  199. } else {
  200. log.Debugf("%s is joining a cluster %v via discover service", name, discoverPeers)
  201. if err := s.startAsFollower(discoverPeers, s.Config.RetryTimes); err != nil {
  202. log.Fatal(err)
  203. }
  204. }
  205. return
  206. }
  207. log.Warnf("%s failed to connect discovery service[%v]: %v", name, discoverURL, discoverErr)
  208. if len(peers) == 0 {
  209. log.Fatalf("%s, the new leader, must register itself to discovery service as required", name)
  210. }
  211. }
  212. if len(peers) > 0 {
  213. if err := s.startAsFollower(peers, s.Config.RetryTimes); err != nil {
  214. log.Fatalf("%s cannot connect to existing cluster %v", name, peers)
  215. }
  216. return
  217. }
  218. log.Infof("%s is starting a new cluster.", s.Config.Name)
  219. s.startAsLeader()
  220. return
  221. }
  222. // Start the raft server
  223. func (s *PeerServer) Start(snapshot bool, discoverURL string, peers []string) error {
  224. s.Lock()
  225. defer s.Unlock()
  226. // LoadSnapshot
  227. if snapshot {
  228. err := s.raftServer.LoadSnapshot()
  229. if err == nil {
  230. log.Debugf("%s finished load snapshot", s.Config.Name)
  231. } else {
  232. log.Debug(err)
  233. }
  234. }
  235. s.raftServer.Init()
  236. // Set NOCOW for data directory in btrfs
  237. if btrfs.IsBtrfs(s.raftServer.LogPath()) {
  238. if err := btrfs.SetNOCOWFile(s.raftServer.LogPath()); err != nil {
  239. log.Warnf("Failed setting NOCOW: %v", err)
  240. }
  241. }
  242. s.findCluster(discoverURL, peers)
  243. s.closeChan = make(chan bool)
  244. s.daemon(s.monitorSync)
  245. s.daemon(s.monitorTimeoutThreshold)
  246. s.daemon(s.monitorActiveSize)
  247. s.daemon(s.monitorPeerActivity)
  248. // open the snapshot
  249. if snapshot {
  250. s.daemon(s.monitorSnapshot)
  251. }
  252. return nil
  253. }
  254. func (s *PeerServer) Stop() {
  255. s.Lock()
  256. defer s.Unlock()
  257. if s.closeChan != nil {
  258. close(s.closeChan)
  259. }
  260. s.raftServer.Stop()
  261. s.routineGroup.Wait()
  262. s.closeChan = nil
  263. }
  264. func (s *PeerServer) HTTPHandler() http.Handler {
  265. router := mux.NewRouter()
  266. // internal commands
  267. router.HandleFunc("/name", s.NameHttpHandler)
  268. router.HandleFunc("/version", s.VersionHttpHandler)
  269. router.HandleFunc("/version/{version:[0-9]+}/check", s.VersionCheckHttpHandler)
  270. router.HandleFunc("/upgrade", s.UpgradeHttpHandler)
  271. router.HandleFunc("/join", s.JoinHttpHandler)
  272. router.HandleFunc("/promote", s.PromoteHttpHandler).Methods("POST")
  273. router.HandleFunc("/remove/{name:.+}", s.RemoveHttpHandler)
  274. router.HandleFunc("/vote", s.VoteHttpHandler)
  275. router.HandleFunc("/log", s.GetLogHttpHandler)
  276. router.HandleFunc("/log/append", s.AppendEntriesHttpHandler)
  277. router.HandleFunc("/snapshot", s.SnapshotHttpHandler)
  278. router.HandleFunc("/snapshotRecovery", s.SnapshotRecoveryHttpHandler)
  279. router.HandleFunc("/etcdURL", s.EtcdURLHttpHandler)
  280. router.HandleFunc("/v2/admin/config", s.getClusterConfigHttpHandler).Methods("GET")
  281. router.HandleFunc("/v2/admin/config", s.setClusterConfigHttpHandler).Methods("PUT")
  282. router.HandleFunc("/v2/admin/machines", s.getMachinesHttpHandler).Methods("GET")
  283. router.HandleFunc("/v2/admin/machines/{name}", s.getMachineHttpHandler).Methods("GET")
  284. router.HandleFunc("/v2/admin/machines/{name}", s.addMachineHttpHandler).Methods("PUT")
  285. router.HandleFunc("/v2/admin/machines/{name}", s.removeMachineHttpHandler).Methods("DELETE")
  286. return router
  287. }
  288. // Retrieves the underlying Raft server.
  289. func (s *PeerServer) RaftServer() raft.Server {
  290. return s.raftServer
  291. }
  292. // Associates the client server with the peer server.
  293. func (s *PeerServer) SetServer(server *Server) {
  294. s.server = server
  295. }
  296. func (s *PeerServer) startAsLeader() {
  297. s.raftServer.Start()
  298. // leader need to join self as a peer
  299. for {
  300. c := &JoinCommandV1{
  301. MinVersion: store.MinVersion(),
  302. MaxVersion: store.MaxVersion(),
  303. Name: s.raftServer.Name(),
  304. RaftURL: s.Config.URL,
  305. EtcdURL: s.server.URL(),
  306. }
  307. _, err := s.raftServer.Do(c)
  308. if err == nil {
  309. break
  310. }
  311. }
  312. log.Debugf("%s start as a leader", s.Config.Name)
  313. }
  314. func (s *PeerServer) startAsFollower(cluster []string, retryTimes int) error {
  315. // start as a follower in a existing cluster
  316. for i := 0; ; i++ {
  317. ok := s.joinCluster(cluster)
  318. if ok {
  319. break
  320. }
  321. if i == retryTimes-1 {
  322. return fmt.Errorf("Cannot join the cluster via given peers after %x retries", s.Config.RetryTimes)
  323. }
  324. log.Warnf("%v is unable to join the cluster using any of the peers %v at %dth time. Retrying in %.1f seconds", s.Config.Name, cluster, i, s.Config.RetryInterval)
  325. time.Sleep(time.Second * time.Duration(s.Config.RetryInterval))
  326. }
  327. s.raftServer.Start()
  328. return nil
  329. }
  330. // getVersion fetches the peer version of a cluster.
  331. func getVersion(t *transporter, versionURL url.URL) (int, error) {
  332. resp, _, err := t.Get(versionURL.String())
  333. if err != nil {
  334. return 0, err
  335. }
  336. defer resp.Body.Close()
  337. body, err := ioutil.ReadAll(resp.Body)
  338. if err != nil {
  339. return 0, err
  340. }
  341. // Parse version number.
  342. version, _ := strconv.Atoi(string(body))
  343. return version, nil
  344. }
  345. // Upgradable checks whether all peers in a cluster support an upgrade to the next store version.
  346. func (s *PeerServer) Upgradable() error {
  347. nextVersion := s.store.Version() + 1
  348. for _, peerURL := range s.registry.PeerURLs(s.raftServer.Leader(), s.Config.Name) {
  349. u, err := url.Parse(peerURL)
  350. if err != nil {
  351. return fmt.Errorf("PeerServer: Cannot parse URL: '%s' (%s)", peerURL, err)
  352. }
  353. t, _ := s.raftServer.Transporter().(*transporter)
  354. checkURL := (&url.URL{Host: u.Host, Scheme: s.Config.Scheme, Path: fmt.Sprintf("/version/%d/check", nextVersion)}).String()
  355. resp, _, err := t.Get(checkURL)
  356. if err != nil {
  357. return fmt.Errorf("PeerServer: Cannot check version compatibility: %s", u.Host)
  358. }
  359. if resp.StatusCode != 200 {
  360. return fmt.Errorf("PeerServer: Version %d is not compatible with peer: %s", nextVersion, u.Host)
  361. }
  362. }
  363. return nil
  364. }
  365. // Helper function to do discovery and return results in expected format
  366. func (s *PeerServer) handleDiscovery(discoverURL string) (peers []string, err error) {
  367. peers, err = discovery.Do(discoverURL, s.Config.Name, s.Config.URL, s.closeChan, s.daemon)
  368. // Warn about errors coming from discovery, this isn't fatal
  369. // since the user might have provided a peer list elsewhere,
  370. // or there is some log in data dir.
  371. if err != nil {
  372. log.Warnf("Discovery encountered an error: %v", err)
  373. return
  374. }
  375. for i := range peers {
  376. // Strip the scheme off of the peer if it has one
  377. // TODO(bp): clean this up!
  378. purl, err := url.Parse(peers[i])
  379. if err == nil {
  380. peers[i] = purl.Host
  381. }
  382. }
  383. log.Infof("Discovery fetched back peer list: %v", peers)
  384. return
  385. }
  386. // getKnownPeers gets the previous peers from log
  387. func (s *PeerServer) getKnownPeers() []string {
  388. peers := s.registry.PeerURLs(s.raftServer.Leader(), s.Config.Name)
  389. for i := range peers {
  390. u, err := url.Parse(peers[i])
  391. if err != nil {
  392. log.Debug("getPrevPeers cannot parse url %v", peers[i])
  393. }
  394. peers[i] = u.Host
  395. }
  396. return peers
  397. }
  398. // removeSelfFromList removes url of the peerServer from the peer list
  399. func (s *PeerServer) removeSelfFromList(peers []string) []string {
  400. // Remove its own peer address from the peer list to join
  401. u, err := url.Parse(s.Config.URL)
  402. if err != nil {
  403. log.Fatalf("removeSelfFromList cannot parse peer address %v", s.Config.URL)
  404. }
  405. newPeers := make([]string, 0)
  406. for _, v := range peers {
  407. if v != u.Host {
  408. newPeers = append(newPeers, v)
  409. }
  410. }
  411. return newPeers
  412. }
  413. func (s *PeerServer) joinCluster(cluster []string) bool {
  414. for _, peer := range cluster {
  415. if len(peer) == 0 {
  416. continue
  417. }
  418. err := s.joinByPeer(s.raftServer, peer, s.Config.Scheme)
  419. if err == nil {
  420. log.Debugf("%s joined the cluster via peer %s", s.Config.Name, peer)
  421. return true
  422. }
  423. if _, ok := err.(etcdErr.Error); ok {
  424. log.Fatal(err)
  425. }
  426. log.Warnf("Attempt to join via %s failed: %s", peer, err)
  427. }
  428. return false
  429. }
  430. // Send join requests to peer.
  431. func (s *PeerServer) joinByPeer(server raft.Server, peer string, scheme string) error {
  432. // t must be ok
  433. t, _ := server.Transporter().(*transporter)
  434. // Our version must match the leaders version
  435. versionURL := url.URL{Host: peer, Scheme: scheme, Path: "/version"}
  436. version, err := getVersion(t, versionURL)
  437. if err != nil {
  438. return fmt.Errorf("Error during join version check: %v", err)
  439. }
  440. if version < store.MinVersion() || version > store.MaxVersion() {
  441. return fmt.Errorf("Unable to join: cluster version is %d; version compatibility is %d - %d", version, store.MinVersion(), store.MaxVersion())
  442. }
  443. var b bytes.Buffer
  444. c := &JoinCommandV2{
  445. MinVersion: store.MinVersion(),
  446. MaxVersion: store.MaxVersion(),
  447. Name: server.Name(),
  448. PeerURL: s.Config.URL,
  449. ClientURL: s.server.URL(),
  450. }
  451. json.NewEncoder(&b).Encode(c)
  452. joinURL := url.URL{Host: peer, Scheme: scheme, Path: "/v2/admin/machines/" + server.Name()}
  453. log.Infof("Send Join Request to %s", joinURL.String())
  454. req, _ := http.NewRequest("PUT", joinURL.String(), &b)
  455. resp, err := t.client.Do(req)
  456. for {
  457. if err != nil {
  458. return fmt.Errorf("Unable to join: %v", err)
  459. }
  460. if resp != nil {
  461. defer resp.Body.Close()
  462. log.Infof("»»»» %d", resp.StatusCode)
  463. if resp.StatusCode == http.StatusOK {
  464. var msg joinMessageV2
  465. if err := json.NewDecoder(resp.Body).Decode(&msg); err != nil {
  466. log.Debugf("Error reading join response: %v", err)
  467. return err
  468. }
  469. s.joinIndex = msg.CommitIndex
  470. s.setMode(msg.Mode)
  471. if msg.Mode == StandbyMode {
  472. s.standbyClientURL = resp.Header.Get("X-Leader-Client-URL")
  473. s.standbyPeerURL = resp.Header.Get("X-Leader-Peer-URL")
  474. }
  475. return nil
  476. }
  477. if resp.StatusCode == http.StatusTemporaryRedirect {
  478. address := resp.Header.Get("Location")
  479. log.Debugf("Send Join Request to %s", address)
  480. c := &JoinCommandV2{
  481. MinVersion: store.MinVersion(),
  482. MaxVersion: store.MaxVersion(),
  483. Name: server.Name(),
  484. PeerURL: s.Config.URL,
  485. ClientURL: s.server.URL(),
  486. }
  487. json.NewEncoder(&b).Encode(c)
  488. resp, _, err = t.Put(address, &b)
  489. } else if resp.StatusCode == http.StatusBadRequest {
  490. log.Debug("Reach max number peers in the cluster")
  491. decoder := json.NewDecoder(resp.Body)
  492. err := &etcdErr.Error{}
  493. decoder.Decode(err)
  494. return *err
  495. } else {
  496. return fmt.Errorf("Unable to join")
  497. }
  498. }
  499. }
  500. }
  501. func (s *PeerServer) Stats() []byte {
  502. s.serverStats.LeaderInfo.Uptime = time.Now().Sub(s.serverStats.LeaderInfo.startTime).String()
  503. // TODO: register state listener to raft to change this field
  504. // rather than compare the state each time Stats() is called.
  505. if s.RaftServer().State() == raft.Leader {
  506. s.serverStats.LeaderInfo.Name = s.RaftServer().Name()
  507. }
  508. queue := s.serverStats.sendRateQueue
  509. s.serverStats.SendingPkgRate, s.serverStats.SendingBandwidthRate = queue.Rate()
  510. queue = s.serverStats.recvRateQueue
  511. s.serverStats.RecvingPkgRate, s.serverStats.RecvingBandwidthRate = queue.Rate()
  512. b, _ := json.Marshal(s.serverStats)
  513. return b
  514. }
  515. func (s *PeerServer) PeerStats() []byte {
  516. if s.raftServer.State() == raft.Leader {
  517. b, _ := json.Marshal(s.followersStats)
  518. return b
  519. }
  520. return nil
  521. }
  522. // raftEventLogger converts events from the Raft server into log messages.
  523. func (s *PeerServer) raftEventLogger(event raft.Event) {
  524. value := event.Value()
  525. prevValue := event.PrevValue()
  526. if value == nil {
  527. value = "<nil>"
  528. }
  529. if prevValue == nil {
  530. prevValue = "<nil>"
  531. }
  532. switch event.Type() {
  533. case raft.StateChangeEventType:
  534. log.Infof("%s: state changed from '%v' to '%v'.", s.Config.Name, prevValue, value)
  535. case raft.TermChangeEventType:
  536. log.Infof("%s: term #%v started.", s.Config.Name, value)
  537. case raft.LeaderChangeEventType:
  538. log.Infof("%s: leader changed from '%v' to '%v'.", s.Config.Name, prevValue, value)
  539. case raft.AddPeerEventType:
  540. log.Infof("%s: peer added: '%v'", s.Config.Name, value)
  541. case raft.RemovePeerEventType:
  542. log.Infof("%s: peer removed: '%v'", s.Config.Name, value)
  543. case raft.HeartbeatIntervalEventType:
  544. var name = "<unknown>"
  545. if peer, ok := value.(*raft.Peer); ok {
  546. name = peer.Name
  547. }
  548. log.Infof("%s: warning: heartbeat timed out: '%v'", s.Config.Name, name)
  549. case raft.ElectionTimeoutThresholdEventType:
  550. select {
  551. case s.timeoutThresholdChan <- value:
  552. default:
  553. }
  554. }
  555. }
  556. func (s *PeerServer) recordMetricEvent(event raft.Event) {
  557. name := fmt.Sprintf("raft.event.%s", event.Type())
  558. value := event.Value().(time.Duration)
  559. (*s.metrics).Timer(name).Update(value)
  560. }
  561. // logSnapshot logs about the snapshot that was taken.
  562. func (s *PeerServer) logSnapshot(err error, currentIndex, count uint64) {
  563. info := fmt.Sprintf("%s: snapshot of %d events at index %d", s.Config.Name, count, currentIndex)
  564. if err != nil {
  565. log.Infof("%s attempted and failed: %v", info, err)
  566. } else {
  567. log.Infof("%s completed", info)
  568. }
  569. }
  570. func (s *PeerServer) daemon(f func()) {
  571. s.routineGroup.Add(1)
  572. go func() {
  573. defer s.routineGroup.Done()
  574. f()
  575. }()
  576. }
  577. func (s *PeerServer) monitorSnapshot() {
  578. for {
  579. timer := time.NewTimer(s.snapConf.checkingInterval)
  580. defer timer.Stop()
  581. select {
  582. case <-s.closeChan:
  583. return
  584. case <-timer.C:
  585. }
  586. currentIndex := s.RaftServer().CommitIndex()
  587. count := currentIndex - s.snapConf.lastIndex
  588. if uint64(count) > s.snapConf.snapshotThr {
  589. err := s.raftServer.TakeSnapshot()
  590. s.logSnapshot(err, currentIndex, count)
  591. s.snapConf.lastIndex = currentIndex
  592. }
  593. }
  594. }
  595. func (s *PeerServer) monitorSync() {
  596. ticker := time.NewTicker(time.Millisecond * 500)
  597. defer ticker.Stop()
  598. for {
  599. select {
  600. case <-s.closeChan:
  601. return
  602. case now := <-ticker.C:
  603. if s.raftServer.State() == raft.Leader {
  604. s.raftServer.Do(s.store.CommandFactory().CreateSyncCommand(now))
  605. }
  606. }
  607. }
  608. }
  609. // monitorTimeoutThreshold groups timeout threshold events together and prints
  610. // them as a single log line.
  611. func (s *PeerServer) monitorTimeoutThreshold() {
  612. for {
  613. select {
  614. case <-s.closeChan:
  615. return
  616. case value := <-s.timeoutThresholdChan:
  617. log.Infof("%s: warning: heartbeat near election timeout: %v", s.Config.Name, value)
  618. }
  619. timer := time.NewTimer(ThresholdMonitorTimeout)
  620. defer timer.Stop()
  621. select {
  622. case <-s.closeChan:
  623. return
  624. case <-timer.C:
  625. }
  626. }
  627. }
  628. // monitorActiveSize has the leader periodically check the status of cluster
  629. // nodes and swaps them out for standbys as needed.
  630. func (s *PeerServer) monitorActiveSize() {
  631. for {
  632. timer := time.NewTimer(ActiveMonitorTimeout)
  633. defer timer.Stop()
  634. select {
  635. case <-s.closeChan:
  636. return
  637. case <-timer.C:
  638. }
  639. // Ignore while this peer is not a leader.
  640. if s.raftServer.State() != raft.Leader {
  641. continue
  642. }
  643. // Retrieve target active size and actual active size.
  644. activeSize := s.ClusterConfig().ActiveSize
  645. peerCount := s.registry.PeerCount()
  646. standbys := s.registry.Standbys()
  647. peers := s.registry.Peers()
  648. if index := sort.SearchStrings(peers, s.Config.Name); index < len(peers) && peers[index] == s.Config.Name {
  649. peers = append(peers[:index], peers[index+1:]...)
  650. }
  651. // If we have more active nodes than we should then demote.
  652. if peerCount > activeSize {
  653. peer := peers[rand.Intn(len(peers))]
  654. log.Infof("%s: demoting: %v", s.Config.Name, peer)
  655. if _, err := s.raftServer.Do(&DemoteCommand{Name: peer}); err != nil {
  656. log.Infof("%s: warning: demotion error: %v", s.Config.Name, err)
  657. }
  658. continue
  659. }
  660. // If we don't have enough active nodes then try to promote a standby.
  661. if peerCount < activeSize && len(standbys) > 0 {
  662. loop:
  663. for _, i := range rand.Perm(len(standbys)) {
  664. standby := standbys[i]
  665. standbyPeerURL, _ := s.registry.StandbyPeerURL(standby)
  666. log.Infof("%s: attempting to promote: %v (%s)", s.Config.Name, standby, standbyPeerURL)
  667. // Notify standby to promote itself.
  668. client := &http.Client{
  669. Transport: &http.Transport{
  670. DisableKeepAlives: false,
  671. ResponseHeaderTimeout: ActiveMonitorTimeout,
  672. },
  673. }
  674. resp, err := client.Post(fmt.Sprintf("%s/promote", standbyPeerURL), "application/json", nil)
  675. if err != nil {
  676. log.Infof("%s: warning: promotion error: %v", s.Config.Name, err)
  677. continue
  678. } else if resp.StatusCode != http.StatusOK {
  679. log.Infof("%s: warning: promotion failure: %v", s.Config.Name, resp.StatusCode)
  680. continue
  681. }
  682. break loop
  683. }
  684. }
  685. }
  686. }
  687. // monitorPeerActivity has the leader periodically for dead nodes and demotes them.
  688. func (s *PeerServer) monitorPeerActivity() {
  689. for {
  690. timer := time.NewTimer(PeerActivityMonitorTimeout)
  691. defer timer.Stop()
  692. select {
  693. case <-s.closeChan:
  694. return
  695. case <-timer.C:
  696. }
  697. // Ignore while this peer is not a leader.
  698. if s.raftServer.State() != raft.Leader {
  699. continue
  700. }
  701. // Check last activity for all peers.
  702. now := time.Now()
  703. promoteDelay := time.Duration(s.ClusterConfig().PromoteDelay) * time.Second
  704. peers := s.raftServer.Peers()
  705. for _, peer := range peers {
  706. // If the last response from the peer is longer than the promote delay
  707. // then automatically demote the peer.
  708. if !peer.LastActivity().IsZero() && now.Sub(peer.LastActivity()) > promoteDelay {
  709. log.Infof("%s: demoting node: %v; last activity %v ago", s.Config.Name, peer.Name, now.Sub(peer.LastActivity()))
  710. if _, err := s.raftServer.Do(&DemoteCommand{Name: peer.Name}); err != nil {
  711. log.Infof("%s: warning: autodemotion error: %v", s.Config.Name, err)
  712. }
  713. continue
  714. }
  715. }
  716. }
  717. }
  718. // Mode represents whether the server is an active peer or if the server is
  719. // simply acting as a standby.
  720. type Mode string
  721. const (
  722. // PeerMode is when the server is an active node in Raft.
  723. PeerMode = Mode("peer")
  724. // StandbyMode is when the server is an inactive, request-forwarding node.
  725. StandbyMode = Mode("standby")
  726. )