Add debug logging

Author: ibuildthecloud

builder.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"fmt"
 	"log"
 	"os"
 	"reflect"
@@ -117,6 +118,10 @@ func Command(obj Runnable, cmd cobra.Command) *cobra.Command {
 			defInt = 0
 		}
 
+		if len(env) > 0 {
+			usage += fmt.Sprintf(" (%s)", strings.Join(env, ","))
+		}
+
 		flags := c.PersistentFlags()
 		if fieldType.Tag.Get("local") == "true" {
 			flags = c.Flags()
@@ -177,8 +182,8 @@ func Command(obj Runnable, cmd cobra.Command) *cobra.Command {
 			envs = append(envs, func() {
 				v := os.Getenv(env)
 				if v != "" {
-					fv, err := flags.GetString(name)
-					if err == nil && (fv == "" || fv == defValue) {
+					fv := flags.Lookup(name)
+					if fv != nil && !fv.Changed {
 						_ = flags.Set(name, v)
 					}
 				}

debug.go

@@ -0,0 +1,53 @@
+package cmd
+
+import (
+	"flag"
+	"fmt"
+	"log"
+	"os"
+
+	// Enable logrus logging in baaah
+	_ "github.com/acorn-io/baaah/pkg/logrus"
+
+	"github.com/acorn-io/cmd/pkg/logserver"
+	"github.com/google/go-containerregistry/pkg/logs"
+	"github.com/sirupsen/logrus"
+	"k8s.io/klog/v2"
+)
+
+type DebugLogging struct {
+	Debug                 bool `usage:"Enable debug logging"`
+	DebugLevel            int  `usage:"Debug log level (valid 0-9) (default 7)"`
+	EnableDynamicLogLevel bool `usage:"Enable loglevel server to enable changing the log level at runtime"`
+}
+
+func (d DebugLogging) InitLogging() error {
+	if d.Debug || d.DebugLevel > 0 {
+		logging := flag.NewFlagSet("", flag.PanicOnError)
+		klog.InitFlags(logging)
+
+		level := d.DebugLevel
+		if level == 0 {
+			level = 6
+		}
+		if level > 7 {
+			logrus.SetLevel(logrus.TraceLevel)
+			logs.Debug = log.New(os.Stderr, "ggcr: ", log.LstdFlags)
+		} else {
+			logrus.SetLevel(logrus.DebugLevel)
+		}
+		if err := logging.Parse([]string{
+			fmt.Sprintf("-v=%d", level),
+		}); err != nil {
+			return err
+		}
+		logrus.Debug("Debug logging enabled")
+	}
+
+	if d.EnableDynamicLogLevel {
+		logrus.Debug("Log server enabled")
+		go logserver.StartServerWithDefaults()
+	}
+
+	return nil
+}

go.mod

@@ -2,9 +2,19 @@ module github.com/acorn-io/cmd
 
 go 1.21.0
 
-require github.com/spf13/cobra v1.7.0
+require (
+	github.com/acorn-io/baaah v0.0.0-20231009165317-af2b68361b8a
+	github.com/google/go-containerregistry v0.16.1
+	github.com/sirupsen/logrus v1.9.3
+	github.com/spf13/cobra v1.7.0
+	k8s.io/klog/v2 v2.100.1
+)
 
 require (
+	github.com/bombsimon/logrusr/v4 v4.0.0 // indirect
+	github.com/go-logr/logr v1.2.4 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/sys v0.8.0 // indirect
+	sigs.k8s.io/controller-runtime v0.15.0-beta.0 // indirect
 )

go.sum

@@ -1,10 +1,55 @@
+github.com/acorn-io/baaah v0.0.0-20231009165317-af2b68361b8a h1:0bHfiYUw4ojXCUfGHUPmRewrgJ/EpLQ4BaR4yEy8BC4=
+github.com/acorn-io/baaah v0.0.0-20231009165317-af2b68361b8a/go.mod h1:1KSGxZt0E2MDedJESKUUYtxCwsJ3A+xZiw2QD8cVbjU=
+github.com/bombsimon/logrusr/v4 v4.0.0 h1:Pm0InGphX0wMhPqC02t31onlq9OVyJ98eP/Vh63t1Oo=
+github.com/bombsimon/logrusr/v4 v4.0.0/go.mod h1:pjfHC5e59CvjTBIU3V3sGhFWFAnsnhOR03TRc6im0l8=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-logr/logr v1.2.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ=
+github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI=
+github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-containerregistry v0.16.1 h1:rUEt426sR6nyrL3gt+18ibRcvYpKYdpsa5ZW7MA08dQ=
+github.com/google/go-containerregistry v0.16.1/go.mod h1:u0qB2l7mvtWVR5kNcbFIhFY1hLbf8eeGapA+vbFDCtQ=
+github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1 h1:K6RDEckDVWvDI9JAJYCmNdQXq6neHJOYx3V6jnqNEec=
+github.com/google/pprof v0.0.0-20210720184732-4bb14d4b1be1/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/onsi/ginkgo/v2 v2.9.5 h1:+6Hr4uxzP4XIUyAkg61dWBw8lb/gc4/X5luuxN/EC+Q=
+github.com/onsi/ginkgo/v2 v2.9.5/go.mod h1:tvAoo1QUJwNEU2ITftXTpR7R1RbCzoZUOs3RonqW57k=
+github.com/onsi/gomega v1.27.6 h1:ENqfyGeS5AX/rlXDd/ETokDz93u0YufY1Pgxuy/PvWE=
+github.com/onsi/gomega v1.27.6/go.mod h1:PIQNjfQwkP3aQAH7lf7j87O/5FiNr+ZR8+ipb+qQlhg=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
+github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I=
 github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M=
+golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU=
+golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
+golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/tools v0.9.1 h1:8WMNJAz3zrtPmnYC7ISf5dEn3MT0gY7jBJfw27yrrLo=
+golang.org/x/tools v0.9.1/go.mod h1:owI94Op576fPu3cIGQeHs3joujW/2Oc6MtlxbF5dfNc=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+k8s.io/klog/v2 v2.100.1 h1:7WCHKK6K8fNhTqfBhISHQ97KrnJNFZMcQvKp7gP/tmg=
+k8s.io/klog/v2 v2.100.1/go.mod h1:y1WjHnz7Dj687irZUWR/WLkLc5N1YHtjLdmgWjndZn0=
+sigs.k8s.io/controller-runtime v0.15.0-beta.0 h1:pkhYMops8jZrVuI0kBHeF6q9UVu1JljIGGG4Ox5ZJmk=
+sigs.k8s.io/controller-runtime v0.15.0-beta.0/go.mod h1:YUTa+du31rqOu4mJaijiuhGFax9ecCJgO/v0/yW09gE=

pkg/logserver/init/init.go

@@ -0,0 +1,7 @@
+package init
+
+import "github.com/acorn-io/cmd/pkg/logserver"
+
+func init() {
+	go logserver.StartServerWithDefaults()
+}

pkg/logserver/logserver.go

@@ -0,0 +1,84 @@
+// Adapted from https://github.com/rancher/log/blob/52031d45f5fdb71cecb9a314865624b42514dbed/server/server.go
+// The only real differences here are that we are using logrus directly instead of a wrapper around it,
+// and that we are using an abstract namespace (non-file) socket.
+// This is only compatible with our fork of the client: https://github.com/acorn-io/loglevel
+
+package logserver
+
+import (
+	"fmt"
+	"net"
+	"net/http"
+	"os"
+
+	"github.com/sirupsen/logrus"
+)
+
+var (
+	DefaultSocketLocation = "\x00logserver"
+)
+
+// Server structure is used to the store backend information
+type Server struct {
+	SocketLocation string
+	Debug          bool
+}
+
+// StartServerWithDefaults starts the server with default values. If the ACORN_LOG_LEVEL environment variable is set,
+// it will be parsed and used to set the log level.
+func StartServerWithDefaults() {
+	if level, err := logrus.ParseLevel(os.Getenv("ACORN_LOG_LEVEL")); err == nil {
+		logrus.SetLevel(level)
+	} else {
+		logrus.SetLevel(logrus.InfoLevel)
+	}
+	s := Server{
+		SocketLocation: DefaultSocketLocation,
+	}
+	s.Start()
+}
+
+// Start the server
+func (s *Server) Start() {
+	_ = os.Remove(s.SocketLocation)
+	go func() {
+		_ = s.ListenAndServe()
+	}()
+}
+
+// ListenAndServe is used to setup handlers and
+// start listening on the specified location
+func (s *Server) ListenAndServe() error {
+	server := http.Server{}
+	http.HandleFunc("/v1/loglevel", s.loglevel)
+	socketListener, err := net.Listen("unix", s.SocketLocation)
+	if err != nil {
+		logrus.Errorf("Failed to start logserver: %v", err)
+		return err
+	}
+	return server.Serve(socketListener)
+}
+
+func (s *Server) loglevel(rw http.ResponseWriter, req *http.Request) {
+	// curl -X POST -d "level=debug" localhost:12345/v1/loglevel
+	logrus.Debugf("Received loglevel request")
+	if req.Method == http.MethodGet {
+		level := logrus.GetLevel().String()
+		_, _ = rw.Write([]byte(fmt.Sprintf("%s\n", level)))
+	}
+
+	if req.Method == http.MethodPost {
+		if err := req.ParseForm(); err != nil {
+			rw.WriteHeader(http.StatusInternalServerError)
+			_, _ = rw.Write([]byte(fmt.Sprintf("Failed to parse form: %v\n", err)))
+		}
+		level, err := logrus.ParseLevel(req.Form.Get("level"))
+		if err != nil {
+			rw.WriteHeader(http.StatusInternalServerError)
+			_, _ = rw.Write([]byte(fmt.Sprintf("Failed to parse loglevel: %v\n", err)))
+		} else {
+			logrus.SetLevel(level)
+			_, _ = rw.Write([]byte("OK\n"))
+		}
+	}
+}