open-consul/website/content/commands/rtt.mdx

73 lines
2.5 KiB
Plaintext
Raw Normal View History

2015-10-16 07:03:16 +00:00
---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: RTT'
description: |
The rtt command estimates the network round trip time between two nodes.
2015-10-16 07:03:16 +00:00
---
# Consul RTT
Command: `consul rtt`
2022-01-11 13:26:58 +00:00
Corresponding HTTP API Endpoints: [\[GET\] /v1/coordinate/datacenters](/api-docs/coordinate#read-wan-coordinates), [\[GET\] /v1/coordinate/nodes](/api-docs/coordinate#read-lan-coordinates-for-all-nodes)
2015-10-22 00:29:43 +00:00
The `rtt` command estimates the network round trip time between two nodes using
Consul's network coordinate model of the cluster.
2020-04-09 23:46:54 +00:00
See the [Network Coordinates](/docs/internals/coordinates) internals guide
2015-10-22 00:29:43 +00:00
for more information on how these coordinates are computed.
2015-10-16 07:03:16 +00:00
The table below shows this command's [required ACLs](/api#authentication). Configuration of
[blocking queries](/api/features/blocking) and [agent caching](/api/features/caching)
are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
| ----------------------- |
| `node:read`<sup>1</sup> |
<p>
<sup>1</sup> When referencing WAN coordinates, no ACL permission is needed.
</p>
2015-10-16 07:03:16 +00:00
## Usage
Usage: `consul rtt [options] node1 [node2]`
2015-10-16 07:03:16 +00:00
At least one node name is required. If the second node name isn't given, it
is set to the agent's node name. These are the node names as known to
Consul as the `consul members` command would show, not IP addresses.
2015-10-16 07:03:16 +00:00
#### API Options
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
#### Command Options
2015-10-16 07:03:16 +00:00
2020-04-07 18:55:19 +00:00
- `-wan` - Instructs the command to use WAN coordinates instead of LAN
coordinates. By default, the two nodes are assumed to be nodes in the local
datacenter and the LAN coordinates are used. If the -wan option is given,
then the WAN coordinates are used, and the node names must be suffixed by a period
2015-10-22 00:29:43 +00:00
and the datacenter (eg. "myserver.dc1"). It is not possible to measure between
LAN coordinates and WAN coordinates, so both nodes must be in the same area.
2015-10-22 00:29:43 +00:00
2015-12-21 23:16:48 +00:00
The following environment variables control accessing the HTTP server via SSL:
2020-04-07 18:55:19 +00:00
- `CONSUL_HTTP_SSL` Set this to enable SSL
- `CONSUL_HTTP_SSL_VERIFY` Set this to disable certificate checking (not recommended)
2015-10-16 07:03:16 +00:00
## Output
If coordinates are available, the command will print the estimated round trip
time between the given nodes:
2015-10-16 07:03:16 +00:00
2020-05-19 18:32:38 +00:00
```shell-session
2015-10-16 07:03:16 +00:00
$ consul rtt n1 n2
Estimated n1 <-> n2 rtt: 0.610 ms (using LAN coordinates)
2015-10-16 07:03:16 +00:00
$ consul rtt n2 # Running from n1
Estimated n1 <-> n2 rtt: 0.610 ms (using LAN coordinates)
$ consul rtt -wan n1.dc1 n2.dc2
Estimated n1.dc1 <-> n2.dc2 rtt: 1.275 ms (using WAN coordinates)
2015-10-16 07:03:16 +00:00
```