cluster.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  1. // Copyright 2018 The etcd Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package tester
  15. import (
  16. "context"
  17. "errors"
  18. "fmt"
  19. "io/ioutil"
  20. "math/rand"
  21. "net/http"
  22. "path/filepath"
  23. "strings"
  24. "time"
  25. "github.com/coreos/etcd/pkg/debugutil"
  26. "github.com/coreos/etcd/tools/functional-tester/rpcpb"
  27. "github.com/prometheus/client_golang/prometheus/promhttp"
  28. "go.uber.org/zap"
  29. "golang.org/x/time/rate"
  30. "google.golang.org/grpc"
  31. yaml "gopkg.in/yaml.v2"
  32. )
  33. // Cluster defines tester cluster.
  34. type Cluster struct {
  35. lg *zap.Logger
  36. agentConns []*grpc.ClientConn
  37. agentClients []rpcpb.TransportClient
  38. agentStreams []rpcpb.Transport_TransportClient
  39. agentRequests []*rpcpb.Request
  40. testerHTTPServer *http.Server
  41. Members []*rpcpb.Member `yaml:"agent-configs"`
  42. Tester *rpcpb.Tester `yaml:"tester-config"`
  43. failures []Failure
  44. rateLimiter *rate.Limiter
  45. stresser Stresser
  46. checker Checker
  47. currentRevision int64
  48. rd int
  49. cs int
  50. }
  51. func newCluster(lg *zap.Logger, fpath string) (*Cluster, error) {
  52. lg.Info("reading configuration file", zap.String("path", fpath))
  53. bts, err := ioutil.ReadFile(fpath)
  54. if err != nil {
  55. return nil, err
  56. }
  57. lg.Info("opened configuration file", zap.String("path", fpath))
  58. clus := &Cluster{lg: lg}
  59. if err = yaml.Unmarshal(bts, clus); err != nil {
  60. return nil, err
  61. }
  62. for i := range clus.Members {
  63. if clus.Members[i].BaseDir == "" {
  64. return nil, fmt.Errorf("Members[i].BaseDir cannot be empty (got %q)", clus.Members[i].BaseDir)
  65. }
  66. if clus.Members[i].EtcdLogPath == "" {
  67. return nil, fmt.Errorf("Members[i].EtcdLogPath cannot be empty (got %q)", clus.Members[i].EtcdLogPath)
  68. }
  69. if clus.Members[i].Etcd.Name == "" {
  70. return nil, fmt.Errorf("'--name' cannot be empty (got %+v)", clus.Members[i])
  71. }
  72. if clus.Members[i].Etcd.DataDir == "" {
  73. return nil, fmt.Errorf("'--data-dir' cannot be empty (got %+v)", clus.Members[i])
  74. }
  75. if clus.Members[i].Etcd.SnapshotCount == 0 {
  76. return nil, fmt.Errorf("'--snapshot-count' cannot be 0 (got %+v)", clus.Members[i].Etcd.SnapshotCount)
  77. }
  78. if clus.Members[i].Etcd.DataDir == "" {
  79. return nil, fmt.Errorf("'--data-dir' cannot be empty (got %q)", clus.Members[i].Etcd.DataDir)
  80. }
  81. if clus.Members[i].Etcd.WALDir == "" {
  82. clus.Members[i].Etcd.WALDir = filepath.Join(clus.Members[i].Etcd.DataDir, "member", "wal")
  83. }
  84. port := ""
  85. listenClientPorts := make([]string, len(clus.Members))
  86. for i, u := range clus.Members[i].Etcd.ListenClientURLs {
  87. if !isValidURL(u) {
  88. return nil, fmt.Errorf("'--listen-client-urls' has valid URL %q", u)
  89. }
  90. listenClientPorts[i], err = getPort(u)
  91. if err != nil {
  92. return nil, fmt.Errorf("'--listen-client-urls' has no port %q", u)
  93. }
  94. }
  95. for i, u := range clus.Members[i].Etcd.AdvertiseClientURLs {
  96. if !isValidURL(u) {
  97. return nil, fmt.Errorf("'--advertise-client-urls' has valid URL %q", u)
  98. }
  99. port, err = getPort(u)
  100. if err != nil {
  101. return nil, fmt.Errorf("'--advertise-client-urls' has no port %q", u)
  102. }
  103. if clus.Members[i].EtcdClientProxy && listenClientPorts[i] == port {
  104. return nil, fmt.Errorf("clus.Members[%d] requires client port proxy, but advertise port %q conflicts with listener port %q", i, port, listenClientPorts[i])
  105. }
  106. }
  107. listenPeerPorts := make([]string, len(clus.Members))
  108. for i, u := range clus.Members[i].Etcd.ListenPeerURLs {
  109. if !isValidURL(u) {
  110. return nil, fmt.Errorf("'--listen-peer-urls' has valid URL %q", u)
  111. }
  112. listenPeerPorts[i], err = getPort(u)
  113. if err != nil {
  114. return nil, fmt.Errorf("'--listen-peer-urls' has no port %q", u)
  115. }
  116. }
  117. for i, u := range clus.Members[i].Etcd.InitialAdvertisePeerURLs {
  118. if !isValidURL(u) {
  119. return nil, fmt.Errorf("'--initial-advertise-peer-urls' has valid URL %q", u)
  120. }
  121. port, err = getPort(u)
  122. if err != nil {
  123. return nil, fmt.Errorf("'--initial-advertise-peer-urls' has no port %q", u)
  124. }
  125. if clus.Members[i].EtcdPeerProxy && listenPeerPorts[i] == port {
  126. return nil, fmt.Errorf("clus.Members[%d] requires peer port proxy, but advertise port %q conflicts with listener port %q", i, port, listenPeerPorts[i])
  127. }
  128. }
  129. if !strings.HasPrefix(clus.Members[i].EtcdLogPath, clus.Members[i].BaseDir) {
  130. return nil, fmt.Errorf("EtcdLogPath must be prefixed with BaseDir (got %q)", clus.Members[i].EtcdLogPath)
  131. }
  132. if !strings.HasPrefix(clus.Members[i].Etcd.DataDir, clus.Members[i].BaseDir) {
  133. return nil, fmt.Errorf("Etcd.DataDir must be prefixed with BaseDir (got %q)", clus.Members[i].Etcd.DataDir)
  134. }
  135. // TODO: support separate WALDir that can be handled via failure-archive
  136. if !strings.HasPrefix(clus.Members[i].Etcd.WALDir, clus.Members[i].BaseDir) {
  137. return nil, fmt.Errorf("Etcd.WALDir must be prefixed with BaseDir (got %q)", clus.Members[i].Etcd.WALDir)
  138. }
  139. if len(clus.Tester.FailureCases) == 0 {
  140. return nil, errors.New("FailureCases not found")
  141. }
  142. }
  143. for _, v := range clus.Tester.FailureCases {
  144. if _, ok := rpcpb.FailureCase_value[v]; !ok {
  145. return nil, fmt.Errorf("%q is not defined in 'rpcpb.FailureCase_value'", v)
  146. }
  147. }
  148. for _, v := range clus.Tester.StressTypes {
  149. if _, ok := rpcpb.StressType_value[v]; !ok {
  150. return nil, fmt.Errorf("StressType is unknown; got %q", v)
  151. }
  152. }
  153. if clus.Tester.StressKeySuffixRangeTxn > 100 {
  154. return nil, fmt.Errorf("StressKeySuffixRangeTxn maximum value is 100, got %v", clus.Tester.StressKeySuffixRangeTxn)
  155. }
  156. if clus.Tester.StressKeyTxnOps > 64 {
  157. return nil, fmt.Errorf("StressKeyTxnOps maximum value is 64, got %v", clus.Tester.StressKeyTxnOps)
  158. }
  159. return clus, err
  160. }
  161. // TODO: status handler
  162. var dialOpts = []grpc.DialOption{
  163. grpc.WithInsecure(),
  164. grpc.WithTimeout(5 * time.Second),
  165. grpc.WithBlock(),
  166. }
  167. // NewCluster creates a client from a tester configuration.
  168. func NewCluster(lg *zap.Logger, fpath string) (*Cluster, error) {
  169. clus, err := newCluster(lg, fpath)
  170. if err != nil {
  171. return nil, err
  172. }
  173. clus.agentConns = make([]*grpc.ClientConn, len(clus.Members))
  174. clus.agentClients = make([]rpcpb.TransportClient, len(clus.Members))
  175. clus.agentStreams = make([]rpcpb.Transport_TransportClient, len(clus.Members))
  176. clus.agentRequests = make([]*rpcpb.Request, len(clus.Members))
  177. clus.failures = make([]Failure, 0)
  178. for i, ap := range clus.Members {
  179. clus.lg.Info("connecting", zap.String("agent-address", ap.AgentAddr))
  180. var err error
  181. clus.agentConns[i], err = grpc.Dial(ap.AgentAddr, dialOpts...)
  182. if err != nil {
  183. return nil, err
  184. }
  185. clus.agentClients[i] = rpcpb.NewTransportClient(clus.agentConns[i])
  186. clus.lg.Info("connected", zap.String("agent-address", ap.AgentAddr))
  187. clus.lg.Info("creating stream", zap.String("agent-address", ap.AgentAddr))
  188. clus.agentStreams[i], err = clus.agentClients[i].Transport(context.Background())
  189. if err != nil {
  190. return nil, err
  191. }
  192. clus.lg.Info("created stream", zap.String("agent-address", ap.AgentAddr))
  193. }
  194. mux := http.NewServeMux()
  195. mux.Handle("/metrics", promhttp.Handler())
  196. if clus.Tester.EnablePprof {
  197. for p, h := range debugutil.PProfHandlers() {
  198. mux.Handle(p, h)
  199. }
  200. }
  201. clus.testerHTTPServer = &http.Server{
  202. Addr: clus.Tester.TesterAddr,
  203. Handler: mux,
  204. }
  205. go clus.serveTesterServer()
  206. clus.updateFailures()
  207. clus.rateLimiter = rate.NewLimiter(
  208. rate.Limit(int(clus.Tester.StressQPS)),
  209. int(clus.Tester.StressQPS),
  210. )
  211. clus.updateStresserChecker()
  212. return clus, nil
  213. }
  214. func (clus *Cluster) serveTesterServer() {
  215. clus.lg.Info(
  216. "started tester HTTP server",
  217. zap.String("tester-address", clus.Tester.TesterAddr),
  218. )
  219. err := clus.testerHTTPServer.ListenAndServe()
  220. clus.lg.Info(
  221. "tester HTTP server returned",
  222. zap.String("tester-address", clus.Tester.TesterAddr),
  223. zap.Error(err),
  224. )
  225. if err != nil && err != http.ErrServerClosed {
  226. clus.lg.Fatal("tester HTTP errored", zap.Error(err))
  227. }
  228. }
  229. func (clus *Cluster) updateFailures() {
  230. for _, cs := range clus.Tester.FailureCases {
  231. switch cs {
  232. case "KILL_ONE_FOLLOWER":
  233. clus.failures = append(clus.failures, newFailureKillOneFollower())
  234. case "KILL_LEADER":
  235. clus.failures = append(clus.failures, newFailureKillLeader())
  236. case "KILL_ONE_FOLLOWER_FOR_LONG":
  237. clus.failures = append(clus.failures, newFailureKillOneFollowerForLongTime())
  238. case "KILL_LEADER_FOR_LONG":
  239. clus.failures = append(clus.failures, newFailureKillLeaderForLongTime())
  240. case "KILL_QUORUM":
  241. clus.failures = append(clus.failures, newFailureKillQuorum())
  242. case "KILL_ALL":
  243. clus.failures = append(clus.failures, newFailureKillAll())
  244. case "BLACKHOLE_PEER_PORT_TX_RX_ONE_FOLLOWER":
  245. clus.failures = append(clus.failures, newFailureBlackholePeerPortTxRxOneFollower())
  246. case "BLACKHOLE_PEER_PORT_TX_RX_LEADER":
  247. clus.failures = append(clus.failures, newFailureBlackholePeerPortTxRxLeader())
  248. case "BLACKHOLE_PEER_PORT_TX_RX_ALL":
  249. clus.failures = append(clus.failures, newFailureBlackholePeerPortTxRxAll())
  250. case "DELAY_PEER_PORT_TX_RX_ONE_FOLLOWER":
  251. clus.failures = append(clus.failures, newFailureDelayPeerPortTxRxOneFollower(clus))
  252. case "DELAY_PEER_PORT_TX_RX_LEADER":
  253. clus.failures = append(clus.failures, newFailureDelayPeerPortTxRxLeader(clus))
  254. case "DELAY_PEER_PORT_TX_RX_ALL":
  255. clus.failures = append(clus.failures, newFailureDelayPeerPortTxRxAll(clus))
  256. case "FAILPOINTS":
  257. fpFailures, fperr := failpointFailures(clus)
  258. if len(fpFailures) == 0 {
  259. clus.lg.Info("no failpoints found!", zap.Error(fperr))
  260. }
  261. clus.failures = append(clus.failures, fpFailures...)
  262. case "NO_FAIL":
  263. clus.failures = append(clus.failures, newFailureNoOp())
  264. case "EXTERNAL":
  265. clus.failures = append(clus.failures, newFailureExternal(clus.Tester.ExternalExecPath))
  266. }
  267. }
  268. }
  269. func (clus *Cluster) failureStrings() (fs []string) {
  270. fs = make([]string, len(clus.failures))
  271. for i := range clus.failures {
  272. fs[i] = clus.failures[i].Desc()
  273. }
  274. return fs
  275. }
  276. func (clus *Cluster) shuffleFailures() {
  277. rand.Seed(time.Now().UnixNano())
  278. offset := rand.Intn(1000)
  279. n := len(clus.failures)
  280. cp := coprime(n)
  281. clus.lg.Info("shuffling test failure cases", zap.Int("total", n))
  282. fs := make([]Failure, n)
  283. for i := 0; i < n; i++ {
  284. fs[i] = clus.failures[(cp*i+offset)%n]
  285. }
  286. clus.failures = fs
  287. clus.lg.Info("shuffled test failure cases", zap.Int("total", n))
  288. }
  289. /*
  290. x and y of GCD 1 are coprime to each other
  291. x1 = ( coprime of n * idx1 + offset ) % n
  292. x2 = ( coprime of n * idx2 + offset ) % n
  293. (x2 - x1) = coprime of n * (idx2 - idx1) % n
  294. = (idx2 - idx1) = 1
  295. Consecutive x's are guaranteed to be distinct
  296. */
  297. func coprime(n int) int {
  298. coprime := 1
  299. for i := n / 2; i < n; i++ {
  300. if gcd(i, n) == 1 {
  301. coprime = i
  302. break
  303. }
  304. }
  305. return coprime
  306. }
  307. func gcd(x, y int) int {
  308. if y == 0 {
  309. return x
  310. }
  311. return gcd(y, x%y)
  312. }
  313. func (clus *Cluster) updateStresserChecker() {
  314. clus.lg.Info(
  315. "updating stressers",
  316. zap.Int("round", clus.rd),
  317. zap.Int("case", clus.cs),
  318. )
  319. cs := &compositeStresser{}
  320. for _, m := range clus.Members {
  321. cs.stressers = append(cs.stressers, newStresser(clus, m))
  322. }
  323. clus.stresser = cs
  324. if clus.Tester.ConsistencyCheck {
  325. clus.checker = newHashChecker(clus.lg, hashAndRevGetter(clus))
  326. if schk := cs.Checker(); schk != nil {
  327. clus.checker = newCompositeChecker([]Checker{clus.checker, schk})
  328. }
  329. } else {
  330. clus.checker = newNoChecker()
  331. }
  332. clus.lg.Info(
  333. "updated stressers",
  334. zap.Int("round", clus.rd),
  335. zap.Int("case", clus.cs),
  336. )
  337. }
  338. func (clus *Cluster) startStresser() (err error) {
  339. clus.lg.Info(
  340. "starting stressers",
  341. zap.Int("round", clus.rd),
  342. zap.Int("case", clus.cs),
  343. )
  344. err = clus.stresser.Stress()
  345. clus.lg.Info(
  346. "started stressers",
  347. zap.Int("round", clus.rd),
  348. zap.Int("case", clus.cs),
  349. )
  350. return err
  351. }
  352. func (clus *Cluster) closeStresser() {
  353. clus.lg.Info(
  354. "closing stressers",
  355. zap.Int("round", clus.rd),
  356. zap.Int("case", clus.cs),
  357. )
  358. clus.stresser.Close()
  359. clus.lg.Info(
  360. "closed stressers",
  361. zap.Int("round", clus.rd),
  362. zap.Int("case", clus.cs),
  363. )
  364. }
  365. func (clus *Cluster) pauseStresser() {
  366. clus.lg.Info(
  367. "pausing stressers",
  368. zap.Int("round", clus.rd),
  369. zap.Int("case", clus.cs),
  370. )
  371. clus.stresser.Pause()
  372. clus.lg.Info(
  373. "paused stressers",
  374. zap.Int("round", clus.rd),
  375. zap.Int("case", clus.cs),
  376. )
  377. }
  378. func (clus *Cluster) checkConsistency() (err error) {
  379. defer func() {
  380. if err != nil {
  381. return
  382. }
  383. if err = clus.updateRevision(); err != nil {
  384. clus.lg.Warn(
  385. "updateRevision failed",
  386. zap.Error(err),
  387. )
  388. return
  389. }
  390. err = clus.startStresser()
  391. }()
  392. clus.lg.Info(
  393. "checking consistency and invariant of cluster",
  394. zap.Int("round", clus.rd),
  395. zap.Int("case", clus.cs),
  396. zap.String("desc", clus.failures[clus.cs].Desc()),
  397. )
  398. if err = clus.checker.Check(); err != nil {
  399. clus.lg.Warn(
  400. "checker.Check failed",
  401. zap.Error(err),
  402. )
  403. return err
  404. }
  405. clus.lg.Info(
  406. "checked consistency and invariant of cluster",
  407. zap.Int("round", clus.rd),
  408. zap.Int("case", clus.cs),
  409. zap.String("desc", clus.failures[clus.cs].Desc()),
  410. )
  411. return err
  412. }
  413. // Bootstrap bootstraps etcd cluster the very first time.
  414. // After this, just continue to call kill/restart.
  415. func (clus *Cluster) Bootstrap() error {
  416. // this is the only time that creates request from scratch
  417. return clus.broadcastOperation(rpcpb.Operation_InitialStartEtcd)
  418. }
  419. // FailArchive sends "FailArchive" operation.
  420. func (clus *Cluster) FailArchive() error {
  421. return clus.broadcastOperation(rpcpb.Operation_FailArchive)
  422. }
  423. // Restart sends "Restart" operation.
  424. func (clus *Cluster) Restart() error {
  425. return clus.broadcastOperation(rpcpb.Operation_RestartEtcd)
  426. }
  427. func (clus *Cluster) broadcastOperation(op rpcpb.Operation) error {
  428. for i := range clus.agentStreams {
  429. err := clus.sendOperation(i, op)
  430. if err != nil {
  431. if op == rpcpb.Operation_DestroyEtcdAgent &&
  432. strings.Contains(err.Error(), "rpc error: code = Unavailable desc = transport is closing") {
  433. // agent server has already closed;
  434. // so this error is expected
  435. clus.lg.Info(
  436. "successfully destroyed",
  437. zap.String("member", clus.Members[i].EtcdClientEndpoint),
  438. )
  439. continue
  440. }
  441. return err
  442. }
  443. }
  444. return nil
  445. }
  446. func (clus *Cluster) sendOperation(idx int, op rpcpb.Operation) error {
  447. if op == rpcpb.Operation_InitialStartEtcd {
  448. clus.agentRequests[idx] = &rpcpb.Request{
  449. Operation: op,
  450. Member: clus.Members[idx],
  451. Tester: clus.Tester,
  452. }
  453. } else {
  454. clus.agentRequests[idx].Operation = op
  455. }
  456. clus.lg.Info(
  457. "sending request",
  458. zap.String("operation", op.String()),
  459. zap.String("to", clus.Members[idx].EtcdClientEndpoint),
  460. )
  461. err := clus.agentStreams[idx].Send(clus.agentRequests[idx])
  462. clus.lg.Info(
  463. "sent request",
  464. zap.String("operation", op.String()),
  465. zap.String("to", clus.Members[idx].EtcdClientEndpoint),
  466. zap.Error(err),
  467. )
  468. if err != nil {
  469. return err
  470. }
  471. clus.lg.Info(
  472. "receiving response",
  473. zap.String("operation", op.String()),
  474. zap.String("from", clus.Members[idx].EtcdClientEndpoint),
  475. )
  476. resp, err := clus.agentStreams[idx].Recv()
  477. if resp != nil {
  478. clus.lg.Info(
  479. "received response",
  480. zap.String("operation", op.String()),
  481. zap.String("from", clus.Members[idx].EtcdClientEndpoint),
  482. zap.Bool("success", resp.Success),
  483. zap.String("status", resp.Status),
  484. zap.Error(err),
  485. )
  486. } else {
  487. clus.lg.Info(
  488. "received empty response",
  489. zap.String("operation", op.String()),
  490. zap.String("from", clus.Members[idx].EtcdClientEndpoint),
  491. zap.Error(err),
  492. )
  493. }
  494. if err != nil {
  495. return err
  496. }
  497. if !resp.Success {
  498. err = errors.New(resp.Status)
  499. }
  500. return err
  501. }
  502. // DestroyEtcdAgents terminates all tester connections to agents and etcd servers.
  503. func (clus *Cluster) DestroyEtcdAgents() {
  504. clus.lg.Info("destroying etcd servers and agents")
  505. err := clus.broadcastOperation(rpcpb.Operation_DestroyEtcdAgent)
  506. if err != nil {
  507. clus.lg.Warn("failed to destroy etcd servers and agents", zap.Error(err))
  508. } else {
  509. clus.lg.Info("destroyed etcd servers and agents")
  510. }
  511. for i, conn := range clus.agentConns {
  512. clus.lg.Info("closing connection to agent", zap.String("agent-address", clus.Members[i].AgentAddr))
  513. err := conn.Close()
  514. clus.lg.Info("closed connection to agent", zap.String("agent-address", clus.Members[i].AgentAddr), zap.Error(err))
  515. }
  516. if clus.testerHTTPServer != nil {
  517. clus.lg.Info("closing tester HTTP server", zap.String("tester-address", clus.Tester.TesterAddr))
  518. ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
  519. err := clus.testerHTTPServer.Shutdown(ctx)
  520. cancel()
  521. clus.lg.Info("closed tester HTTP server", zap.String("tester-address", clus.Tester.TesterAddr), zap.Error(err))
  522. }
  523. }
  524. // WaitHealth ensures all members are healthy
  525. // by writing a test key to etcd cluster.
  526. func (clus *Cluster) WaitHealth() error {
  527. var err error
  528. // wait 60s to check cluster health.
  529. // TODO: set it to a reasonable value. It is set that high because
  530. // follower may use long time to catch up the leader when reboot under
  531. // reasonable workload (https://github.com/coreos/etcd/issues/2698)
  532. for i := 0; i < 60; i++ {
  533. for _, m := range clus.Members {
  534. clus.lg.Info(
  535. "writing health key",
  536. zap.Int("retries", i),
  537. zap.String("endpoint", m.EtcdClientEndpoint),
  538. )
  539. if err = m.WriteHealthKey(); err != nil {
  540. clus.lg.Warn(
  541. "writing health key failed",
  542. zap.Int("retries", i),
  543. zap.String("endpoint", m.EtcdClientEndpoint),
  544. zap.Error(err),
  545. )
  546. break
  547. }
  548. clus.lg.Info(
  549. "wrote health key",
  550. zap.Int("retries", i),
  551. zap.String("endpoint", m.EtcdClientEndpoint),
  552. )
  553. }
  554. if err == nil {
  555. clus.lg.Info(
  556. "writing health key success on all members",
  557. zap.Int("retries", i),
  558. )
  559. return nil
  560. }
  561. time.Sleep(time.Second)
  562. }
  563. return err
  564. }
  565. // GetLeader returns the index of leader and error if any.
  566. func (clus *Cluster) GetLeader() (int, error) {
  567. for i, m := range clus.Members {
  568. isLeader, err := m.IsLeader()
  569. if isLeader || err != nil {
  570. return i, err
  571. }
  572. }
  573. return 0, fmt.Errorf("no leader found")
  574. }
  575. // maxRev returns the maximum revision found on the cluster.
  576. func (clus *Cluster) maxRev() (rev int64, err error) {
  577. ctx, cancel := context.WithTimeout(context.TODO(), time.Second)
  578. defer cancel()
  579. revc, errc := make(chan int64, len(clus.Members)), make(chan error, len(clus.Members))
  580. for i := range clus.Members {
  581. go func(m *rpcpb.Member) {
  582. mrev, merr := m.Rev(ctx)
  583. revc <- mrev
  584. errc <- merr
  585. }(clus.Members[i])
  586. }
  587. for i := 0; i < len(clus.Members); i++ {
  588. if merr := <-errc; merr != nil {
  589. err = merr
  590. }
  591. if mrev := <-revc; mrev > rev {
  592. rev = mrev
  593. }
  594. }
  595. return rev, err
  596. }
  597. func (clus *Cluster) getRevisionHash() (map[string]int64, map[string]int64, error) {
  598. revs := make(map[string]int64)
  599. hashes := make(map[string]int64)
  600. for _, m := range clus.Members {
  601. rev, hash, err := m.RevHash()
  602. if err != nil {
  603. return nil, nil, err
  604. }
  605. revs[m.EtcdClientEndpoint] = rev
  606. hashes[m.EtcdClientEndpoint] = hash
  607. }
  608. return revs, hashes, nil
  609. }
  610. func (clus *Cluster) compactKV(rev int64, timeout time.Duration) (err error) {
  611. if rev <= 0 {
  612. return nil
  613. }
  614. for i, m := range clus.Members {
  615. clus.lg.Info(
  616. "compacting",
  617. zap.String("endpoint", m.EtcdClientEndpoint),
  618. zap.Int64("compact-revision", rev),
  619. zap.Duration("timeout", timeout),
  620. )
  621. now := time.Now()
  622. cerr := m.Compact(rev, timeout)
  623. succeed := true
  624. if cerr != nil {
  625. if strings.Contains(cerr.Error(), "required revision has been compacted") && i > 0 {
  626. clus.lg.Info(
  627. "compact error is ignored",
  628. zap.String("endpoint", m.EtcdClientEndpoint),
  629. zap.Int64("compact-revision", rev),
  630. zap.Error(cerr),
  631. )
  632. } else {
  633. clus.lg.Warn(
  634. "compact failed",
  635. zap.String("endpoint", m.EtcdClientEndpoint),
  636. zap.Int64("compact-revision", rev),
  637. zap.Error(cerr),
  638. )
  639. err = cerr
  640. succeed = false
  641. }
  642. }
  643. if succeed {
  644. clus.lg.Info(
  645. "compacted",
  646. zap.String("endpoint", m.EtcdClientEndpoint),
  647. zap.Int64("compact-revision", rev),
  648. zap.Duration("timeout", timeout),
  649. zap.Duration("took", time.Since(now)),
  650. )
  651. }
  652. }
  653. return err
  654. }
  655. func (clus *Cluster) checkCompact(rev int64) error {
  656. if rev == 0 {
  657. return nil
  658. }
  659. for _, m := range clus.Members {
  660. if err := m.CheckCompact(rev); err != nil {
  661. return err
  662. }
  663. }
  664. return nil
  665. }
  666. func (clus *Cluster) defrag() error {
  667. clus.lg.Info(
  668. "defragmenting",
  669. zap.Int("round", clus.rd),
  670. zap.Int("case", clus.cs),
  671. )
  672. for _, m := range clus.Members {
  673. if err := m.Defrag(); err != nil {
  674. clus.lg.Warn(
  675. "defrag failed",
  676. zap.Int("round", clus.rd),
  677. zap.Int("case", clus.cs),
  678. zap.Error(err),
  679. )
  680. return err
  681. }
  682. }
  683. clus.lg.Info(
  684. "defragmented",
  685. zap.Int("round", clus.rd),
  686. zap.Int("case", clus.cs),
  687. )
  688. return nil
  689. }
  690. func (clus *Cluster) Report() int64 { return clus.stresser.ModifiedKeys() }