Fault Tolerance & Recovery

On this page

Warning:

As of June 5, 2024, CockroachDB v22.2 is no longer supported. For more details, refer to the Release Support Policy.

This page guides you through a simple demonstration of how CockroachDB remains available during, and recovers after, failure. Starting with a 6-node local cluster with the default 3-way replication, you'll run a sample workload, terminate a node to simulate failure, and see how the cluster continues uninterrupted. You'll then leave that node offline for long enough to watch the cluster repair itself by re-replicating missing data to other nodes. You'll then prepare the cluster for 2 simultaneous node failures by increasing to 5-way replication, then take two nodes offline at the same time, and again see how the cluster continues uninterrupted.

Before you begin

Make sure you have already installed CockroachDB.

Step 1. Start a 6-node cluster

Use the cockroach start command to start 6 nodes:

$ cockroach start \
--insecure \
--store=fault-node1 \
--listen-addr=localhost:26257 \
--http-addr=localhost:8080 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

$ cockroach start \
--insecure \
--store=fault-node2 \
--listen-addr=localhost:26258 \
--http-addr=localhost:8081 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

$ cockroach start \
--insecure \
--store=fault-node3 \
--listen-addr=localhost:26259 \
--http-addr=localhost:8082 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

$ cockroach start \
--insecure \
--store=fault-node4 \
--listen-addr=localhost:26260 \
--http-addr=localhost:8083 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

$ cockroach start \
--insecure \
--store=fault-node5 \
--listen-addr=localhost:26261 \
--http-addr=localhost:8084 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

$ cockroach start \
--insecure \
--store=fault-node6 \
--listen-addr=localhost:26262 \
--http-addr=localhost:8085 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

Use the cockroach init command to perform a one-time initialization of the cluster:
```
$ cockroach init --insecure --host=localhost:26257
```

Step 2. Set up load balancing

In this tutorial, you run a sample workload to simulate multiple client connections. Each node is an equally suitable SQL gateway for the load, but it's always recommended to spread requests evenly across nodes. This section shows how to set up the open-source HAProxy load balancer.

Install HAProxy.
If you're on a Mac and use Homebrew, run:
```
$ brew install haproxy
```
If you're using Linux and use apt-get, run:
```
$ sudo apt-get install haproxy
```
Run the cockroach gen haproxy command, specifying the port of any node:
```
$ cockroach gen haproxy --insecure --host=localhost --port=26257
```
This command generates an haproxy.cfg file automatically configured to work with the nodes of your running cluster.
In haproxy.cfg, change bind :26257 to bind :26000. This changes the port on which HAProxy accepts requests to a port that is not already in use by a node.
```
sed -i.saved 's/^    bind :26257/    bind :26000/' haproxy.cfg
```
Start HAProxy, with the -f flag pointing to the haproxy.cfg file:
```
$ haproxy -f haproxy.cfg &
```

Step 3. Run a sample workload

Use the cockroach workload command to run CockroachDB's built-in version of the YCSB benchmark, simulating multiple client connections, each performing mixed read/write operations.

Load the initial ycsb schema and data, pointing it at HAProxy's port:
```
$ cockroach workload init ycsb --splits=50 'postgresql://root@localhost:26000?sslmode=disable'
```
The --splits flag tells the workload to manually split ranges a number of times. This is not something you'd normally do, but for the purpose of this tutorial, it makes it easier to visualize the movement of data in the cluster.

Run the ycsb workload, pointing it at HAProxy's port:

$ cockroach workload run ycsb \
--duration=20m \
--concurrency=3 \
--max-rate=1000 \
--tolerate-errors \
'postgresql://root@localhost:26000?sslmode=disable'

This command initiates 3 concurrent client workloads for 20 minutes, but limits the total load to 1000 operations per second (since you're running everything on a single machine).

You'll see per-operation statistics print to standard output every second:

_elapsed___errors__ops/sec(inst)___ops/sec(cum)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)
    1.0s        0          902.8          930.9      1.1      2.1      4.1     62.9 read
    1.0s        0           46.5           48.0      3.4      4.7      6.0      6.0 update
    2.0s        0          923.3          926.9      1.0      2.9      5.5      8.9 read
    2.0s        0           38.0           43.0      3.0      6.0      7.6      7.6 update
    3.0s        0          901.1          918.3      1.1      2.5      5.0      6.6 read
    3.0s        0           55.0           47.0      3.4      7.9      9.4     11.5 update
    4.0s        0          948.9          926.0      1.0      1.6      2.6      5.0 read
    4.0s        0           46.0           46.7      3.1      5.2     16.8     16.8 update
    5.0s        0          932.0          927.2      1.1      1.8      2.9     13.6 read
    5.0s        0           56.0           48.6      3.0      4.2      5.2      5.5 update
...

After the specified duration (20 minutes in this case), the workload will stop and you'll see totals printed to standard output.

Step 4. Check the workload

Initially, the workload creates a new database called ycsb, creates the table public.usertable in that database, and inserts rows into the table. Soon, the load generator starts executing approximately 95% reads and 5% writes.

Go to the DB Console at http://localhost:8080.
To check the SQL queries getting executed, click Metrics on the left, and hover over the SQL Statements graph at the top:
To check the client connections from the load generator, select the SQL dashboard and hover over the Open SQL Sessions graph:

You'll notice 3 client connections from the load generator. If you want to check that HAProxy balanced each connection to a different node, you can change the Graph dropdown from Cluster to specific nodes.
To see more details about the ycsb database and the public.usertable table, click Databases in the upper left and click ycsb:

You can also view the schema and other table details of public.usertable by clicking the table name:
By default, CockroachDB replicates all data 3 times and balances it across all nodes. To see this balance, click Overview and check the replica count across all nodes:

Step 5. Simulate a single node failure

When a node fails, the cluster waits for the node to remain offline for 5 minutes by default before considering it dead, at which point the cluster automatically repairs itself by re-replicating any of the replicas on the down nodes to other available nodes.

In a new terminal, edit the default replication zone to reduce the amount of time the cluster waits before considering a node dead to the minimum allowed of 1 minute and 15 seconds:
```
$ cockroach sql --insecure --host=localhost:26000 \
--execute="SET CLUSTER SETTING server.time_until_store_dead = '1m15s';"
```

Get the process IDs of the nodes:

ps -ef | grep cockroach | grep -v grep

503 53645     1   0 10:18AM ttys013    0:44.80 cockroach start --insecure --store=fault-node1 --listen-addr=localhost:26257 --http-addr=localhost:8080 --join=localhost:26257,localhost:26258,localhost:26259
503 53651     1   0 10:18AM ttys013    0:38.81 cockroach start --insecure --store=fault-node2 --listen-addr=localhost:26258 --http-addr=localhost:8081 --join=localhost:26257,localhost:26258,localhost:26259
503 53671     1   0 10:18AM ttys013    0:35.40 cockroach start --insecure --store=fault-node3 --listen-addr=localhost:26259 --http-addr=localhost:8082 --join=localhost:26257,localhost:26258,localhost:26259
503 53684     1   0 10:18AM ttys013    0:38.44 cockroach start --insecure --store=fault-node4 --listen-addr=localhost:26260 --http-addr=localhost:8083 --join=localhost:26257,localhost:26258,localhost:26259
503 53708     1   0 10:18AM ttys013    0:39.49 cockroach start --insecure --store=fault-node5 --listen-addr=localhost:26261 --http-addr=localhost:8084 --join=localhost:26257,localhost:26258,localhost:26259
503 53730     1   0 10:18AM ttys013    0:33.37 cockroach start --insecure --store=fault-node6 --listen-addr=localhost:26262 --http-addr=localhost:8085 --join=localhost:26257,localhost:26258,localhost:26259

Gracefully shut down the node stored in fault-node5, specifying its process ID (in this example, 53708):
```
kill -TERM 53708
```

Step 6. Check load continuity and cluster health

Go back to the DB Console, click Metrics on the left, and verify that the cluster as a whole continues serving data, despite one of the nodes being unavailable and marked as Suspect:

DB Console Suspect Node

This shows that when all ranges are replicated 3 times (the default), the cluster can tolerate a single node failure because the surviving nodes have a majority of each range's replicas (2/3).

Step 7. Watch the cluster repair itself

Click Overview on the left:

DB Console Cluster Repair

Because you reduced the time it takes for the cluster to consider the down node dead, after 1 minute or so, the cluster will consider the down node "dead", and you'll see the replica count on the remaining nodes increase and the number of under-replicated ranges decrease to 0. This shows the cluster repairing itself by re-replicating missing replicas.

Step 8. Prepare for two simultaneous node failures

At this point, the cluster has recovered and is ready to handle another failure. However, the cluster cannot handle two near-simultaneous failures in this configuration. Failures are "near-simultaneous" if they are closer together than the server.time_until_store_dead cluster setting plus the time taken for the number of replicas on the dead node to drop to zero. If two failures occurred in this configuration, some ranges would become unavailable until one of the nodes recovers.

To be able to tolerate 2 of 5 nodes failing simultaneously without any service interruption, ranges must be replicated 5 times.

Restart the node stored in fault-node5, using the same command you used to start the node initially:

$ cockroach start \
--insecure \
--store=fault-node5 \
--listen-addr=localhost:26261 \
--http-addr=localhost:8084 \
--join=localhost:26257,localhost:26258,localhost:26259 \
--background

Use the ALTER RANGE ... CONFIGURE ZONE command to change the cluster's default replication factor to 5:
```
$ cockroach sql --insecure --host=localhost:26000 \
--execute="ALTER RANGE default CONFIGURE ZONE USING num_replicas=5;"
```
In the DB Console Overview dashboard, watch the replica count increase and even out across all 6 nodes:

This shows the cluster up-replicating so that each range has 5 replicas, one on each node.

Step 9. Simulate two simultaneous node failures

Gracefully shut down 2 nodes, specifying the process IDs you retrieved earlier:

kill -TERM {process IDs}

Step 10. Check cluster status and service continuity

Click Overview on the left, and verify the state of the cluster:
To verify that the cluster still serves data, use the cockroach sql command to interact with the cluster.

Count the number of rows in the ycsb.public.usertable table to see that it serves reads:
```
$ cockroach sql --insecure --host=localhost:26257 \
--execute="SELECT count(*) FROM ycsb.public.usertable;"
```
```
  count
+-------+
  10000
(1 row)
```
Insert data to see that it serves writes:
```
$ cockroach sql --insecure --host=localhost:26257 \
--execute="INSERT INTO ycsb.public.usertable VALUES ('asdf', NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);"
```
```
$ cockroach sql --insecure --host=localhost:26257 \
--execute="SELECT count(*) FROM ycsb.public.usertable;"
```
```
  count
+-------+
  10001
(1 row)
```
This shows that when all ranges are replicated 5 times, the cluster can tolerate 2 simultaneous node outages because the surviving nodes have a majority of each range's replicas (3/5).

Step 11. Clean up

In the terminal where the YCSB workload is running, press CTRL + c.
Terminate HAProxy:
```
$ pkill haproxy
```
Gracefully shut down the remaining 4 nodes, specifying the process IDs you retrieved earlier and the new process ID for the node stored in fault-node5:
```
kill -TERM {process IDs}
```
Note:

For the final 2 nodes, the shutdown process will take longer (about a minute each) and will eventually force the nodes to stop. This is because, with only 2 of 5 nodes left, a majority of replicas are not available, and so the cluster is no longer operational.
To restart the cluster at a later time, run the same cockroach start commands as in Step 1. Start a 6-node cluster from the directory containing the nodes' data stores.

If you do not plan to restart the cluster, you may want to remove the nodes' data stores and the HAProxy config files:
```
$ rm -rf fault-node1 fault-node2 fault-node3 fault-node4 fault-node5 fault-node6 haproxy.cfg haproxy.cfg.saved
```

What's next?

Explore other core CockroachDB benefits and features:

Was this helpful?

Cockroach
University

Docs Hub

Fault Tolerance & Recovery

Before you begin

Step 1. Start a 6-node cluster

Step 2. Set up load balancing

Step 3. Run a sample workload

Step 4. Check the workload

Step 5. Simulate a single node failure

Step 6. Check load continuity and cluster health

Step 7. Watch the cluster repair itself

Step 8. Prepare for two simultaneous node failures

Step 9. Simulate two simultaneous node failures

Step 10. Check cluster status and service continuity

Step 11. Clean up

What's next?

Cockroach University

Docs Hub

Cockroach University

Docs Hub

Fault Tolerance & Recovery

Before you begin

Step 1. Start a 6-node cluster

Step 2. Set up load balancing

Step 3. Run a sample workload

Step 4. Check the workload

Step 5. Simulate a single node failure

Step 6. Check load continuity and cluster health

Step 7. Watch the cluster repair itself

Step 8. Prepare for two simultaneous node failures

Step 9. Simulate two simultaneous node failures

Step 10. Check cluster status and service continuity

Step 11. Clean up

What's next?

Cockroach
University

Cockroach
University