Monitor xCluster
Metrics
The list of xCluster metrics is available in the xCluster metrics.
Console
Use the xcluster status sub command to display information about the specified xCluster replication. You can run the command on either the source or target cluster.
./bin/yugabyted xcluster status \
[--replication_id <replication_id>]
Example output:
Outbound xCluster Replications:
+------------------------------------------------------------------------------------------+
| yugabyted |
+------------------------------------------------------------------------------------------+
| Replication 1 : |
| Replication ID : rg1 |
| State : REPLICATING |
| Target Universe UUID : 2e3ff9c4-2c5a-4dc6-a6bc-20e2548b9f09 |
| Databases : Following are the databases included in this replication |
| : Database 1: |
| : Name: yugabyte |
| : State: READY |
+------------------------------------------------------------------------------------------+
No Inbound xCluster replications found for this cluster.
To list outgoing groups on the Primary universe, use the list_xcluster_outbound_replication_groups command:
./bin/yb-admin \
-master_addresses <primary_master_addresses> \
list_xcluster_outbound_replication_groups \
[namespace_id]
To list inbound groups on the Standby universe, use the list_universe_replications command:
./bin/yb-admin \
-master_addresses <standby_master_addresses> \
list_universe_replications \
[namespace_id]
To get the status of the replication group, use get_replication_status:
yb-admin \
-master_addresses <target-master-addresses> \
get_replication_status \
[<replication_id>]
xCluster safe time
In transactional xCluster replication setups, the current xCluster safe time is the safe time as of which consistent reads are performed on the target universe. You can use the following commands to see the current xCluster safe time:
./bin/yugabyted xcluster status \
[--replication_id <replication_id>]
Example output:
No Outbound xCluster replications found for this cluster.
Inbound xCluster Replications:
+------------------------------------------------------------------------------------------+
| yugabyted |
+------------------------------------------------------------------------------------------+
| Replication 1 : |
| Replication ID : rg1 |
| State : ACTIVE |
| Source cluster nodes : 127.0.0.1,127.0.0.2,127.0.0.3 |
| Databases : Following are the databases included in this replication |
| : Database 1: |
| : Name: yugabyte |
| : Safe Time: 2025-03-14 20:43:49.723305 |
| : Safe Time Lag(micro secs): 0.88 |
| : Safe Time Skew(micro secs): 0.81 |
+------------------------------------------------------------------------------------------+
yb-admin \
-master_addresses <standby_master_addresses> \
get_xcluster_safe_time \
[include_lag_and_skew]
Example output:
[
{
"namespace_id": "000034cb000030008000000000000000",
"namespace_name": "yugabyte",
"safe_time": "2025-03-14 20:51:25.915918",
"safe_time_epoch": "1742010685915918",
"safe_time_lag_sec": "0.50",
"safe_time_skew_sec": "0.02"
}
]
YB-Master and YB-Tserver UI
You can access the YB-Master and YB-Tserver UIs to monitor the health of xCluster replication at /xcluster
.
YB-Master source
http://127.0.0.1:7000/xcluster
YB-Master target
http://127.0.0.1:7000/xcluster:
YB-Tserver source
http://127.0.0.1:9000/xcluster:
Advanced troubleshooting
For advanced troubleshooting, refer to the Troubleshooting xCluster Replication guide.