peer_server.go 25 KB

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