open-consul/command/rtt.go

185 lines
4.8 KiB
Go
Raw Normal View History

2015-10-16 07:03:16 +00:00
package command
import (
"fmt"
"strings"
"github.com/hashicorp/consul/command/base"
2015-10-16 07:03:16 +00:00
"github.com/hashicorp/serf/coordinate"
)
2015-10-22 00:21:08 +00:00
// RTTCommand is a Command implementation that allows users to query the
2015-10-16 07:03:16 +00:00
// estimated round trip time between nodes using network coordinates.
2015-10-22 00:21:08 +00:00
type RTTCommand struct {
base.Command
2015-10-16 07:03:16 +00:00
}
2015-10-22 00:21:08 +00:00
func (c *RTTCommand) Help() string {
2015-10-16 07:03:16 +00:00
helpText := `
Usage: consul rtt [options] node1 [node2]
2015-10-16 07:03:16 +00:00
Estimates the round trip time between two nodes using Consul's network
coordinate model of the cluster.
At least one node name is required. If the second node name isn't given, it
is set to the agent's node name. Note that these are node names as known to
Consul as "consul members" would show, not IP addresses.
2015-10-16 07:03:16 +00:00
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 and
the datacenter (eg. "myserver.dc1").
2015-10-16 07:03:16 +00:00
It is not possible to measure between LAN coordinates and WAN coordinates
because they are maintained by independent Serf gossip areas, so they are
2015-10-16 07:03:16 +00:00
not compatible.
` + c.Command.Help()
2015-10-16 07:03:16 +00:00
return strings.TrimSpace(helpText)
}
2015-10-22 00:21:08 +00:00
func (c *RTTCommand) Run(args []string) int {
2015-10-16 07:03:16 +00:00
var wan bool
f := c.Command.NewFlagSet(c)
2015-10-16 07:03:16 +00:00
f.BoolVar(&wan, "wan", false, "Use WAN coordinates instead of LAN coordinates.")
if err := c.Command.Parse(args); err != nil {
2015-10-16 07:03:16 +00:00
return 1
}
2015-10-22 00:21:08 +00:00
// They must provide at least one node.
nodes := f.Args()
if len(nodes) < 1 || len(nodes) > 2 {
2017-04-21 00:02:42 +00:00
c.UI.Error("One or two node names must be specified")
c.UI.Error("")
c.UI.Error(c.Help())
2015-10-16 07:03:16 +00:00
return 1
}
// Create and test the HTTP client.
client, err := c.Command.HTTPClient()
2015-10-16 07:03:16 +00:00
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
2015-10-16 07:03:16 +00:00
return 1
}
coordClient := client.Coordinate()
var source string
var coord1, coord2 *coordinate.Coordinate
if wan {
source = "WAN"
// Default the second node to the agent if none was given.
if len(nodes) < 2 {
agent := client.Agent()
self, err := agent.Self()
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Unable to look up agent info: %s", err))
return 1
}
node, dc := self["Config"]["NodeName"], self["Config"]["Datacenter"]
nodes = append(nodes, fmt.Sprintf("%s.%s", node, dc))
}
2015-10-16 07:03:16 +00:00
// Parse the input nodes.
parts1 := strings.Split(nodes[0], ".")
parts2 := strings.Split(nodes[1], ".")
if len(parts1) != 2 || len(parts2) != 2 {
2017-04-21 00:02:42 +00:00
c.UI.Error("Node names must be specified as <node name>.<datacenter> with -wan")
2015-10-16 07:03:16 +00:00
return 1
}
node1, dc1 := parts1[0], parts1[1]
node2, dc2 := parts2[0], parts2[1]
2015-10-16 07:03:16 +00:00
// Pull all the WAN coordinates.
dcs, err := coordClient.Datacenters()
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error getting coordinates: %s", err))
2015-10-16 07:03:16 +00:00
return 1
}
// See if the requested nodes are in there. We only compare
// coordinates in the same areas.
var area1, area2 string
2015-10-16 07:03:16 +00:00
for _, dc := range dcs {
for _, entry := range dc.Coordinates {
if dc.Datacenter == dc1 && entry.Node == node1 {
area1 = dc.AreaID
2015-10-16 07:03:16 +00:00
coord1 = entry.Coord
}
if dc.Datacenter == dc2 && entry.Node == node2 {
area2 = dc.AreaID
2015-10-16 07:03:16 +00:00
coord2 = entry.Coord
}
if area1 == area2 && coord1 != nil && coord2 != nil {
goto SHOW_RTT
}
2015-10-16 07:03:16 +00:00
}
}
// Nil out the coordinates so we don't display across areas if
// we didn't find anything.
coord1, coord2 = nil, nil
2015-10-16 07:03:16 +00:00
} else {
source = "LAN"
// Default the second node to the agent if none was given.
if len(nodes) < 2 {
agent := client.Agent()
node, err := agent.NodeName()
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Unable to look up agent info: %s", err))
return 1
}
nodes = append(nodes, node)
}
2015-10-16 07:03:16 +00:00
// Pull all the LAN coordinates.
entries, _, err := coordClient.Nodes(nil)
if err != nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Error getting coordinates: %s", err))
2015-10-16 07:03:16 +00:00
return 1
}
// See if the requested nodes are in there.
for _, entry := range entries {
if entry.Node == nodes[0] {
coord1 = entry.Coord
}
if entry.Node == nodes[1] {
coord2 = entry.Coord
}
if coord1 != nil && coord2 != nil {
goto SHOW_RTT
}
2015-10-16 07:03:16 +00:00
}
}
// Make sure we found both coordinates.
if coord1 == nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Could not find a coordinate for node %q", nodes[0]))
2015-10-16 07:03:16 +00:00
return 1
}
if coord2 == nil {
2017-04-21 00:02:42 +00:00
c.UI.Error(fmt.Sprintf("Could not find a coordinate for node %q", nodes[1]))
2015-10-16 07:03:16 +00:00
return 1
}
SHOW_RTT:
2015-10-16 07:03:16 +00:00
// Report the round trip time.
dist := fmt.Sprintf("%.3f ms", coord1.DistanceTo(coord2).Seconds()*1000.0)
2017-04-21 00:02:42 +00:00
c.UI.Output(fmt.Sprintf("Estimated %s <-> %s rtt: %s (using %s coordinates)", nodes[0], nodes[1], dist, source))
2015-10-16 07:03:16 +00:00
return 0
}
2015-10-22 00:21:08 +00:00
func (c *RTTCommand) Synopsis() string {
return "Estimates network round trip time between nodes"
2015-10-16 07:03:16 +00:00
}