Enable the Node Map

On this page

The Node Map is useful for:

• Visualizing the geographic configuration of a multi-region cluster on a world map.
• Viewing real-time cluster metrics.
• Drilling down to individual nodes for monitoring health and performance.

This page guides you through the process of setting up and enabling the Node Map.

Set up and enable the Node Map

To enable the Node Map, you need to start the cluster with the correct --locality flags and assign the latitude and longitude for each locality.

Consider a four-node geo-distributed cluster with the following configuration:

Step 1. Start the nodes with the correct --locality flags

To start a new cluster with the correct --locality flags:

Start Node 1:

$ cockroach start \
--insecure \
--locality=region=us-east-1,datacenter=us-east-1a  \
--advertise-addr=<node1 address> \
--cache=.25 \
--max-sql-memory=.25 \
--join=<node1 address>,<node2 address>,<node3 address>,<node4 address>

Start Node 2:

$ cockroach start \
--insecure \
--locality=region=us-east-1,datacenter=us-east-1b \
--advertise-addr=<node2 address> \
--cache=.25 \
--max-sql-memory=.25 \
--join=<node1 address>,<node2 address>,<node3 address>,<node4 address>

Start Node 3:

$ cockroach start \
--insecure \
--locality=region=us-west-1,datacenter=us-west-1a \
--advertise-addr=<node3 address> \
--cache=.25 \
--max-sql-memory=.25 \
--join=<node1 address>,<node2 address>,<node3 address>,<node4 address>

Start Node 4:

$ cockroach start \
--insecure \
--locality=region=eu-west-1,datacenter=eu-west-1a \
--advertise-addr=<node4 address> \
--cache=.25 \
--max-sql-memory=.25 \
--join=<node1 address>,<node2 address>,<node3 address>,<node4 address>

Use the cockroach init command to perform a one-time initialization of the cluster:

$ cockroach init --insecure --host=<address of any node>

Access the DB Console. The following page is displayed:

Step 2. Set the Enterprise license and refresh the DB Console

After setting the Enterprise license, the Node Map should now be displaying the highest-level localities you defined:

Step 3. Set the latitudes and longitudes for the localities

Launch the built-in SQL client:

$ cockroach sql --insecure --host=<address of any node>

Insert the approximate latitude and longitude of each region into the system.locations table:

> INSERT INTO system.locations VALUES
  ('region', 'us-east-1', 37.478397, -76.453077),
  ('region', 'us-west-1', 38.837522, -120.895824),
  ('region', 'eu-west-1', 53.142367, -7.692054);

For the latitudes and longitudes of AWS, Azure, and Google Cloud regions, see Location Coordinates for Reference.

Step 4. Refresh the Node Map

Refresh the DB Console to see the updated Node Map:

Step 5. Navigate the Node Map

Let's say you want to navigate to Node 2, which is in datacenter us-east-1a in the us-east-1 region:

1. Click on the map component marked as region=us-east-1 on the Node Map. The locality component for the datacenter is displayed.

   

2. Click on the datacenter component marked as datacenter=us-east-1a. The individual node components are displayed.

   

3. To navigate back to the cluster view, either click on Cluster in the breadcrumb trail at the top of the Node Map, or click Up to REGION=US-EAST-1 and then click Up to CLUSTER in the lower left-hand side of the Node Map.

Troubleshoot the Node Map

Node Map not displayed

The Node Map requires an Enterprise license.

All nodes in the cluster must be assigned localities. To be displayed on the world map, localities must be assigned a corresponding latitude and longitude.

To verify both of the above, navigate to the Localities debug page (https://<address of any node>:8080/#/reports/localities) in the DB Console.

The Localities debug page displays the following:

• Localities configuration that you set up while starting the nodes with the --locality flags.
• Nodes corresponding to each locality.
• Latitude and longitude coordinates for each locality/node.

World Map not displayed for all locality levels

The world map is displayed only when localities are assigned latitude/longitude coordinates.

If a locality (e.g., region) is not assigned latitude/longitude coordinates, it is displayed using the latitude/longitude of any lower-level localities it contains (e.g., datacenter). If no coordinates are available, localities are plotted in a circular layout.

Displayed Used Capacity value is more than configured capacity

If you are testing your deployment locally with multiple CockroachDB nodes running on a single machine (this is not recommended in production), you must explicitly set the store size per node in order to display the correct capacity. Otherwise, the machine's actual disk capacity will be counted as a separate store for each node, thus inflating the computed capacity.

Location coordinates

AWS locations

Azure locations

Google Cloud locations

Was this helpful?