cluster.go 21 KB

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