server-info command

Author: splittingred

CHANGELOG.md

@@ -2,6 +2,7 @@ The changelog for Bonvoy
 
 ## Pending Release
 
+* Add `server-info` command to display information about the Envoy sidecar
 * Add `log-level` command to set Envoy's log level
 * Restructure for better memory usage and a more closed API
 

commands/certificates.go

@@ -37,7 +37,10 @@ func (g *ExpiredCertificatesCommand) Run() error {
 		name = g.fs.Arg(0)
 	}
 
-	e := envoy.NewFromServiceName(name)
+	e, err := envoy.NewFromServiceName(name)
+	if err != nil {
+		return err
+	}
 	data := e.Certificates().Get()
 
 	for _, certs := range data.Certificates {

commands/listeners.go

@@ -35,7 +35,10 @@ func (g *ListenersCommand) Run() error {
 		name = g.fs.Arg(0)
 	}
 
-	e := envoy.NewFromServiceName(name)
+	e, err := envoy.NewFromServiceName(name)
+	if err != nil {
+		return err
+	}
 	listeners := e.Listeners().Get()
 
 	fmt.Println("LISTENERS:")

commands/logging.go

@@ -44,7 +44,10 @@ func (g *SetLogLevelCommand) Run() error {
 		}
 	}
 
-	e := envoy.NewFromServiceName(name)
+	e, err := envoy.NewFromServiceName(name)
+	if err != nil {
+		return err
+	}
 	e.Logging().SetLevel(level)
 	return nil
 }

commands/registry.go

@@ -12,5 +12,6 @@ func All() []Runner {
 		BuildVersion(),
 		BuildExpiredCertificatesCommand(),
 		BuildSetLogLevelCommand(),
+		BuildServerInfoCommand(),
 	}
 }

commands/server_info.go

@@ -0,0 +1,103 @@
+package commands
+
+import (
+	"bonvoy/envoy"
+	"flag"
+	"fmt"
+	"github.com/olekukonko/tablewriter"
+	"os"
+)
+
+type ServerInfoCommand struct {
+	fs *flag.FlagSet
+	name string
+}
+
+// ListenersCommand
+func BuildServerInfoCommand() *ServerInfoCommand {
+	gc := &ServerInfoCommand{
+		fs: flag.NewFlagSet("server-info", flag.ContinueOnError),
+	}
+	gc.fs.StringVar(&gc.name, "service", "", "name of the service sidecar to see server information for")
+	return gc
+}
+
+func (g *ServerInfoCommand) Name() string {
+	return g.fs.Name()
+}
+
+func (g *ServerInfoCommand) Init(args []string) error {
+	return g.fs.Parse(args)
+}
+
+func (g *ServerInfoCommand) Run() error {
+	var name = g.name
+	if name == "" {
+		name = g.fs.Arg(0)
+	}
+	e, err := envoy.NewFromServiceName(name)
+	if err != nil {
+		return err
+	}
+	response := e.Server().Info()
+	g.DisplayOutput(response)
+	return nil
+}
+
+func (g *ServerInfoCommand) DisplayOutput(data envoy.ServerInfoJson) {
+	fmt.Println("----------------------")
+	fmt.Println("- Server Information -")
+	fmt.Println("----------------------")
+	d := [][]string{
+		{"Version", data.Version},
+		{"Hot Restart Version", data.HotRestartVersion},
+		{"State", data.State},
+		{"Uptime", data.UptimeCurrentEpoch},
+	}
+	table := tablewriter.NewWriter(os.Stdout)
+	table.SetBorder(false)
+	table.SetTablePadding("\t")
+	table.AppendBulk(d)
+	table.SetAlignment(tablewriter.ALIGN_LEFT)
+	table.Render()
+
+	fmt.Println("")
+	fmt.Println("--------------------")
+	fmt.Println("- Node Information -")
+	fmt.Println("--------------------")
+	d = [][]string{
+		{"Node ID", data.Node.ID},
+		{"Node Cluster", data.Node.Cluster},
+		{"User Agent", data.Node.UserAgentName},
+		{"Envoy Version", data.Node.Metadata.EnvoyVersion},
+		{"Namespace", data.Node.Metadata.Namespace},
+	}
+	table = tablewriter.NewWriter(os.Stdout)
+	table.SetBorder(false)
+	table.SetTablePadding("\t")
+	table.AppendBulk(d)
+	table.SetAlignment(tablewriter.ALIGN_LEFT)
+	table.Render()
+
+	fmt.Println("")
+	fmt.Println("------------------------")
+	fmt.Println("- Command Line Options -")
+	fmt.Println("------------------------")
+	d = [][]string{
+		{"Concurrency", fmt.Sprintf("%d", data.ServerCommandLineOptions.Concurrency)},
+		{"Mode", data.ServerCommandLineOptions.Mode},
+		{"Log Level", data.ServerCommandLineOptions.LogLevel},
+		{"Component Log Level", data.ServerCommandLineOptions.ComponentLogLevel},
+		{"Log Format", data.ServerCommandLineOptions.LogFormat},
+		{"Drain Strategy", data.ServerCommandLineOptions.DrainStrategy},
+		{"Drain Time", data.ServerCommandLineOptions.DrainTime},
+		{"Config Path", data.ServerCommandLineOptions.ConfigPath},
+		{"Parent Shutdown Time", data.ServerCommandLineOptions.ParentShutdownTime},
+	}
+	table = tablewriter.NewWriter(os.Stdout)
+	table.SetBorder(false)
+	table.SetTablePadding("\t")
+	table.AppendBulk(d)
+	table.SetAlignment(tablewriter.ALIGN_LEFT)
+	table.Render()
+}

docker/client.go

@@ -24,7 +24,7 @@ func NewClient() Client {
 	}
 }
 
-func (c *Client) GetEnvoyPid(name string) int {
+func (c *Client) GetEnvoyPid(name string) (int, error) {
 	filter := filters.NewArgs()
 	filter.Add("name", "connect-proxy-" + name)
 
@@ -33,7 +33,7 @@ func (c *Client) GetEnvoyPid(name string) int {
 		Filters: filter,
 	})
 	if err != nil {
-		panic(err)
+		return 0, err
 	}
 	var containerNames []string
 	for _, container := range containers {
@@ -43,8 +43,10 @@ func (c *Client) GetEnvoyPid(name string) int {
 	desiredName := ""
 	if len(containerNames) > 1 {
 		desiredName = c.SelectDesiredContainer(containerNames)
-	} else {
+	} else if len(containerNames) == 1 {
 		desiredName = containerNames[0]
+	} else {
+		return 0, fmt.Errorf("No sidecar found for name: " + name)
 	}
 
 	fmt.Printf("Entering %s\n\n", strings.TrimLeft(desiredName, "/"))
@@ -57,10 +59,9 @@ func (c *Client) GetEnvoyPid(name string) int {
 	}
 	container, err := c.cli.ContainerInspect(context.Background(), desiredId)
 	if err != nil {
-		fmt.Printf("Failed to inspect container %v\n", err)
-		panic(err)
+		return 0, err
 	}
-	return container.State.Pid
+	return container.State.Pid, nil
 }
 
 func (c *Client) SelectDesiredContainer(names []string) string {

envoy/instance.go

@@ -17,13 +17,17 @@ func GetDefaultHost() string {
 	return viper.GetString("ENVOY_HOST")
 }
 
-func NewFromServiceName(name string) Instance {
+func NewFromServiceName(name string) (Instance, error) {
 	dci := docker.NewClient()
-	pid := dci.GetEnvoyPid(name)
-	return Instance{
-		Address: GetDefaultHost(),
-		Pid: pid,
-		docker: dci,
-		nsenter: nsenter.NewClient(pid),
+	pid, err := dci.GetEnvoyPid(name)
+	if err != nil {
+		return Instance{}, err
+	} else {
+		return Instance{
+			Address: GetDefaultHost(),
+			Pid: pid,
+			docker: dci,
+			nsenter: nsenter.NewClient(pid),
+		}, nil
 	}
 }

envoy/server.go

@@ -0,0 +1,72 @@
+package envoy
+
+import (
+	"encoding/json"
+	"fmt"
+	"strings"
+)
+
+type Server struct {
+	i *Instance
+	endpoints ServerEndpoints
+}
+
+type ServerEndpoints struct {
+	info string
+}
+func (i *Instance) Server() *Server {
+	return &Server{
+		i: i,
+		endpoints: ServerEndpoints{
+			info: i.Address + "/server_info",
+		},
+	}
+}
+
+func (l *Server) Info() ServerInfoJson {
+	rawJson := l.i.nsenter.Curl("-s", l.endpoints.info)
+	jsonData := []byte(strings.Trim(rawJson, " "))
+
+	var response ServerInfoJson
+	err := json.Unmarshal(jsonData, &response)
+	if err != nil {
+		fmt.Println(err)
+		panic(err)
+	}
+	return response
+}
+
+type ServerInfoJson struct {
+	Version string 				`json:"version"`
+	State string 				`json:"state"`
+	HotRestartVersion string	`json:"hot_restart_version"`
+	ServerCommandLineOptions ServerCommandLineOptionsJson `json:"command_line_options"`
+	Node ServerNode				`json:"node"`
+	UptimeCurrentEpoch string   `json:"uptime_current_epoch"`
+	UptimeAllEpochs string		`json:"uptime_all_epochs"`
+}
+
+type ServerCommandLineOptionsJson struct {
+	Concurrency int             `json:"concurrency"`
+	ConfigPath string			`json:"config_path"`
+	LogLevel string				`json:"log_level"`
+	ComponentLogLevel string    `json:"component_log_level"`
+	LogFormat string            `json:"log_format"`
+	LogFormatEscaped bool       `json:"log_format_escaped"`
+	Mode string					`json:"mode"`
+	DrainStrategy string        `json:"drain_strategy"`
+	DrainTime string            `json:"drain_time"`
+	ParentShutdownTime string   `json:"parent_shutdown_time"`
+}
+
+type ServerNode struct {
+	ID string				`json:"id"`
+	Cluster string			`json:"cluster"`
+	Metadata ServerMetadata `json:"metadata"`
+	UserAgentName string	`json:"user_agent_name"`
+}
+
+type ServerMetadata struct {
+	Namespace string    `json:"namespace"`
+	EnvoyVersion string `json:"envoy_version"`
+}

go.mod

@@ -14,11 +14,12 @@ require (
 	github.com/mattn/go-isatty v0.0.13 // indirect
 	github.com/moby/term v0.0.0-20201216013528-df9cb8a40635 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/rakyll/gotest v0.0.6 // indirect
 	github.com/sirupsen/logrus v1.8.1 // indirect
 	github.com/spf13/viper v1.7.1
+	github.com/stretchr/testify v1.6.1
 	golang.org/x/sys v0.0.0-20210608053332-aa57babbf139 // indirect
 	golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba // indirect
 	google.golang.org/grpc v1.38.0 // indirect
-	github.com/stretchr/testify v1.6.1
 )