cluster.go 21 KB

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