Default ports
Client APIs
Application clients connect to the following addresses:
API | Port | Server | Flag (default) |
---|---|---|---|
YSQL | 5433 | YB-TServer | --pgsql_proxy_bind_address 0.0.0.0:5433 |
YCQL | 9042 | YB-TServer | --cql_proxy_bind_address 0.0.0.0:9042 |
YEDIS | 6379 | YB-TServer | --redis_proxy_bind_address 0.0.0.0:6379 |
Internode RPC communication
Internode (server-to-server or node-to-node) communication, including xCluster, is managed using RPC calls on the following addresses:
Server | Port | Flag (default) |
---|---|---|
YB-Master | 7100 | --rpc_bind_addresses 0.0.0.0:7100 |
YB-TServer | 9100 | --rpc_bind_addresses 0.0.0.0:9100 --tserver_master_addrs 0.0.0.0:7100 --server_broadcast_addresses 0.0.0.0:9100 |
To enable login to the machines running these servers, the SSH port 22 should be opened.
xCluster uses the YB-Master port 7100 for the initial communication, and then uses the YB-TServer port 9100 to get data changes. Note that YugabyteDB Anywhere obtains the replication lag information using Prometheus metrics from YB-TServer at port 9000. If this port is closed, the xCluster replication is not affected, but YugabyteDB Anywhere would not be able to display the replication lag.
Before installing YugabyteDB or YugabyteDB Anywhere, or upgrading the YugabyteDB software on YugabyteDB Anywhere, the YB Controller port 18018 must be open on all YugabyteDB nodes and be reachable from YugabyteDB Anywhere nodes:
Service | Port |
---|---|
YB Controller | 18018 |
Admin web server
Admin web server UI can be viewed at the following addresses:
Server | Port | Flag (default) |
---|---|---|
YB-Master | 7000 | --webserver_interface 0.0.0.0 --webserver_port 7000 |
YB-TServer | 9000 | --webserver_interface 0.0.0.0 --webserver_port 9000 |
Firewall rules
The following common ports are required for firewall rules:
Service | Port |
---|---|
SSH | 22 |
HTTP for YugabyteDB Anywhere | 80 |
HTTP for YugabyteDB Anywhere (alternate) | 8080 |
HTTPS for YugabyteDB Anywhere | 443 |
HTTP for Replicated | 8800 |
SSH ** | 54422 |
** 54422 is a custom SSH port for universe nodes.
Prometheus monitoring
YugabyteDB servers expose time-series performance metrics in the Prometheus exposition format on multiple HTTP endpoints that have the following structure:
<target>/prometheus-metrics
You can access the Prometheus server on port 9090
of the YugabyteDB Anywhere node, and you can see the list of targets at the http://<yugaware-ip>:9090/targets
. In particular, note port 9300
for node-level metrics:
Service | Port |
---|---|
Node metrics | 9300 |
Servers
Use the following targets to monitor YB-TServer and YB-Master server metrics:
Server | Target |
---|---|
YB-Master | <yb-master-address>:7000 |
YB-TServer | <yb-tserver-address>:9000 |
APIs
Use the following YB-TServer targets for the various API metrics:
API | Target |
---|---|
YSQL | <yb-tserver-address>:13000 |
YCQL | <yb-tserver-address>:12000 |
YEDIS | <yb-tserver-address>:11000 |
For information on using Prometheus with YugabyteDB, see Observability with Prometheus.