peer_server.go 24 KB

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