cmd/tailscale/cli: add routecheck command (#19641)
Introduce a new `tailscale routecheck` command which prints a report of high-availability routers that are reachable. This command rhymes with the `tailscale netcheck` command and but instead of reporting on local network conditions, `routecheck` reports on remote connectivity. Updates #17366 Updates tailscale/corp#33033 Signed-off-by: Simon Law <sfllaw@tailscale.com>
This commit is contained in:
Simon Law
@@ -20,6 +20,7 @@ tailscale.com/cmd/derper dependencies: (generated by github.com/tailscale/depawa
|
||||
github.com/go-json-experiment/json/internal/jsonopts from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/internal/jsonwire from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/jsontext from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/v1 from tailscale.com/net/routecheck
|
||||
💣 github.com/go4org/hashtriemap from tailscale.com/derp/derpserver
|
||||
github.com/golang/groupcache/lru from tailscale.com/net/dnscache
|
||||
github.com/hdevalence/ed25519consensus from tailscale.com/tka
|
||||
|
||||
@@ -42,6 +42,7 @@ tailscale.com/cmd/k8s-operator dependencies: (generated by github.com/tailscale/
|
||||
github.com/go-json-experiment/json/internal/jsonopts from github.com/go-json-experiment/json/jsontext+
|
||||
github.com/go-json-experiment/json/internal/jsonwire from github.com/go-json-experiment/json/jsontext+
|
||||
github.com/go-json-experiment/json/jsontext from tailscale.com/logtail+
|
||||
github.com/go-json-experiment/json/v1 from tailscale.com/net/routecheck
|
||||
github.com/go-logr/logr from github.com/go-logr/logr/slogr+
|
||||
github.com/go-logr/logr/slogr from github.com/go-logr/zapr
|
||||
github.com/go-logr/zapr from sigs.k8s.io/controller-runtime/pkg/log/zap+
|
||||
|
||||
@@ -239,6 +239,7 @@ func noDupFlagify(c *ffcli.Command, tb testenv.TB) {
|
||||
var (
|
||||
fileCmd,
|
||||
sysPolicyCmd,
|
||||
maybeRoutecheckCmd,
|
||||
maybeWebCmd,
|
||||
maybeDriveCmd,
|
||||
maybeTailnetLockCmd,
|
||||
@@ -280,6 +281,7 @@ change in the future.
|
||||
configureCmd(),
|
||||
nilOrCall(sysPolicyCmd),
|
||||
netcheckCmd,
|
||||
nilOrCall(maybeRoutecheckCmd),
|
||||
ipCmd,
|
||||
dnsCmd,
|
||||
statusCmd,
|
||||
|
||||
@@ -143,7 +143,7 @@ func runNetcheck(ctx context.Context, args []string) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("netcheck: %w", err)
|
||||
}
|
||||
if err := printReport(dm, report); err != nil {
|
||||
if err := printNetCheckReport(dm, report); err != nil {
|
||||
return err
|
||||
}
|
||||
if netcheckArgs.every == 0 {
|
||||
@@ -153,7 +153,7 @@ func runNetcheck(ctx context.Context, args []string) error {
|
||||
}
|
||||
}
|
||||
|
||||
func printReport(dm *tailcfg.DERPMap, report *netcheck.Report) error {
|
||||
func printNetCheckReport(dm *tailcfg.DERPMap, report *netcheck.Report) error {
|
||||
var j []byte
|
||||
var err error
|
||||
switch netcheckArgs.format {
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
// Copyright (c) Tailscale Inc & contributors
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
//go:build !ts_omit_routecheck
|
||||
|
||||
package cli
|
||||
|
||||
import (
|
||||
"cmp"
|
||||
"context"
|
||||
"flag"
|
||||
"fmt"
|
||||
"slices"
|
||||
"strings"
|
||||
"text/tabwriter"
|
||||
"time"
|
||||
|
||||
jsonv2 "github.com/go-json-experiment/json"
|
||||
"github.com/go-json-experiment/json/jsontext"
|
||||
"github.com/peterbourgon/ff/v3/ffcli"
|
||||
"tailscale.com/net/routecheck"
|
||||
)
|
||||
|
||||
func init() {
|
||||
maybeRoutecheckCmd = routecheckCmd
|
||||
}
|
||||
|
||||
var routecheckCmd = func() *ffcli.Command {
|
||||
return &ffcli.Command{
|
||||
Name: "routecheck",
|
||||
ShortUsage: "tailscale routecheck",
|
||||
ShortHelp: "Print a reachability report for routes with multiple paths",
|
||||
LongHelp: hidden + `"tailscale routecheck" is an experimental feature; it is not a stable interface`,
|
||||
Exec: runRoutecheck,
|
||||
FlagSet: routecheckFlagSet,
|
||||
}
|
||||
}
|
||||
|
||||
var routecheckFlagSet = func() *flag.FlagSet {
|
||||
fs := newFlagSet("routecheck")
|
||||
fs.BoolVar(&routecheckArgs.probe, "probe", false, "probe now to generate a new reachability report")
|
||||
fs.StringVar(&routecheckArgs.format, "format", "", `output format: empty (for human-readable), "json" or "json-line"`)
|
||||
return fs
|
||||
}()
|
||||
|
||||
var routecheckArgs struct {
|
||||
probe bool
|
||||
format string
|
||||
}
|
||||
|
||||
func runRoutecheck(ctx context.Context, args []string) error {
|
||||
routeCheck := localClient.RouteCheck
|
||||
if routecheckArgs.probe {
|
||||
routeCheck = localClient.RouteCheckProbe
|
||||
}
|
||||
rp, err := routeCheck(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("routecheck: %w", err)
|
||||
}
|
||||
if err := printRouteCheckReport(rp); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func printRouteCheckReport(rp *routecheck.Report) error {
|
||||
var enc *jsontext.Encoder
|
||||
switch routecheckArgs.format {
|
||||
case "":
|
||||
case "json":
|
||||
enc = jsontext.NewEncoder(Stdout, jsontext.WithIndent("\t"))
|
||||
case "json-line":
|
||||
enc = jsontext.NewEncoder(Stdout, jsontext.Multiline(false))
|
||||
default:
|
||||
return fmt.Errorf("unknown output format %q", routecheckArgs.format)
|
||||
}
|
||||
|
||||
if rp == nil {
|
||||
return fmt.Errorf("routecheck: report unavailable")
|
||||
}
|
||||
routes := rp.RoutablePrefixes()
|
||||
|
||||
// Don’t render prefixes that only have one router:
|
||||
for pfx, nodes := range routes {
|
||||
if len(nodes) <= 1 {
|
||||
delete(routes, pfx)
|
||||
}
|
||||
}
|
||||
|
||||
if enc != nil {
|
||||
out := struct {
|
||||
Done time.Time `json:"done"`
|
||||
Routes routecheck.RoutablePrefixes `json:"routes"`
|
||||
}{
|
||||
Done: rp.Done,
|
||||
Routes: routes,
|
||||
}
|
||||
if err := jsonv2.MarshalEncode(enc, out); err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := Stdout.Write([]byte("\n")); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
w := tabwriter.NewWriter(Stdout, 10, 5, 5, ' ', 0)
|
||||
defer w.Flush()
|
||||
fmt.Fprintf(w, "\nReachable routers at %s:\n", rp.Done.Local().Format(time.DateTime+"Z07:00"))
|
||||
fmt.Fprintf(w, "\n %s\t%s\t%s", "PREFIX", "IP", "HOSTNAME")
|
||||
for prefix, nodes := range routes.Sorted() {
|
||||
slices.SortFunc(nodes, func(a, b routecheck.Node) int {
|
||||
return cmp.Compare(a.Name, b.Name) // order by hostname
|
||||
})
|
||||
for _, n := range nodes {
|
||||
fmt.Fprintf(w, "\n %s\t%s\t%s", prefix, n.Addr, strings.TrimSuffix(n.Name, "."))
|
||||
}
|
||||
}
|
||||
fmt.Fprintln(w)
|
||||
return nil
|
||||
}
|
||||
@@ -109,6 +109,7 @@ tailscale.com/cmd/tailscale dependencies: (generated by github.com/tailscale/dep
|
||||
github.com/go-json-experiment/json/internal/jsonopts from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/internal/jsonwire from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/jsontext from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/v1 from tailscale.com/net/routecheck
|
||||
L 💣 github.com/godbus/dbus/v5 from fyne.io/systray+
|
||||
L github.com/godbus/dbus/v5/introspect from fyne.io/systray+
|
||||
L github.com/godbus/dbus/v5/prop from fyne.io/systray
|
||||
@@ -220,7 +221,7 @@ tailscale.com/cmd/tailscale dependencies: (generated by github.com/tailscale/dep
|
||||
tailscale.com/net/ping from tailscale.com/net/netcheck
|
||||
tailscale.com/net/portmapper from tailscale.com/feature/portmapper
|
||||
tailscale.com/net/portmapper/portmappertype from tailscale.com/net/netcheck+
|
||||
tailscale.com/net/routecheck from tailscale.com/client/local
|
||||
tailscale.com/net/routecheck from tailscale.com/client/local+
|
||||
tailscale.com/net/sockstats from tailscale.com/control/controlhttp+
|
||||
tailscale.com/net/stun from tailscale.com/net/netcheck
|
||||
tailscale.com/net/tlsdial from tailscale.com/cmd/tailscale/cli+
|
||||
|
||||
@@ -112,7 +112,7 @@ tailscale.com/cmd/tailscaled dependencies: (generated by github.com/tailscale/de
|
||||
github.com/go-json-experiment/json/internal/jsonopts from github.com/go-json-experiment/json/jsontext+
|
||||
github.com/go-json-experiment/json/internal/jsonwire from github.com/go-json-experiment/json/jsontext+
|
||||
github.com/go-json-experiment/json/jsontext from tailscale.com/logtail+
|
||||
github.com/go-json-experiment/json/v1 from tailscale.com/feature/routecheck
|
||||
github.com/go-json-experiment/json/v1 from tailscale.com/feature/routecheck+
|
||||
W 💣 github.com/go-ole/go-ole from github.com/go-ole/go-ole/oleutil+
|
||||
W 💣 github.com/go-ole/go-ole/oleutil from tailscale.com/wgengine/winnet
|
||||
L 💣 github.com/godbus/dbus/v5 from tailscale.com/net/dns+
|
||||
|
||||
@@ -31,6 +31,7 @@ tailscale.com/cmd/tsidp dependencies: (generated by github.com/tailscale/depawar
|
||||
github.com/go-json-experiment/json/internal/jsonopts from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/internal/jsonwire from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/jsontext from github.com/go-json-experiment/json+
|
||||
github.com/go-json-experiment/json/v1 from tailscale.com/net/routecheck
|
||||
L 💣 github.com/godbus/dbus/v5 from tailscale.com/net/dns
|
||||
github.com/golang/groupcache/lru from tailscale.com/net/dnscache
|
||||
github.com/google/btree from gvisor.dev/gvisor/pkg/tcpip/transport/tcp
|
||||
|
||||
Reference in New Issue
Block a user