Merge pull request #66 from coreruleset/add-debugging

feat: add `--debug` flag and additional information

Author: fzipi

README.md

@@ -19,6 +19,7 @@ Flags:
   -b, --bind string   address to bind to (default "0.0.0.0")
   -h, --help          help for albedo
   -p, --port int      port to listen on (default 8080)
+      --debug         log debug information
 ```
 
 ## Usage as a library
@@ -87,4 +88,9 @@ endpoints:
         - response status codes must lie in the range of [100,599]
         - the names and values of headers must be valid according to the HTTP specification;
           invalid headers will be dropped
+  - path: /inspect
+    methods: [any]
+    contentType: any
+    description: |
+      Logs debug information about the received request, such as headers and body size.
 ```

cmd/root.go

@@ -2,6 +2,8 @@ package cmd
 
 import (
 	"context"
+	"log/slog"
+	"os"
 
 	"github.com/coreruleset/albedo/server"
 	"github.com/spf13/cobra"
@@ -18,19 +20,23 @@ func NewRootCommand() *cobra.Command {
 		Short: "HTTP reflector and black hole",
 		RunE:  runE,
 	}
-	port := new(int)
-	binding := new(string)
-	rootCmd.PersistentFlags().IntVarP(port, "port", "p", 8080, "port to listen on")
-	rootCmd.PersistentFlags().StringVarP(binding, "bind", "b", "0.0.0.0", "address to bind to")
+	rootCmd.PersistentFlags().IntP("port", "p", 8080, "port to listen on")
+	rootCmd.PersistentFlags().StringP("bind", "b", "0.0.0.0", "address to bind to")
+	rootCmd.PersistentFlags().Bool("debug", false, "Log debugging information")
 
 	return rootCmd
 }
 
 func runE(cmd *cobra.Command, _ []string) error {
 	port, _ := cmd.Flags().GetInt("port")
 	binding, _ := cmd.Flags().GetString("bind")
+	debug, _ := cmd.Flags().GetBool("debug")
+	if debug {
+		handler := slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelDebug})
+		logger := slog.New(handler)
+		slog.SetDefault(logger)
+	}
 
-	_ = server.Start(binding, port)
-
+	server.Start(binding, port)
 	return nil
 }

go.sum

@@ -1,5 +1,3 @@
-github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
-github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
@@ -16,18 +14,10 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
-github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
-github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
-github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
 github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
 github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
-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/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
 github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
-github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
-github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

server/capabilities.yaml

@@ -48,4 +48,9 @@ endpoints:
     methods: [PUT]
     contentType: any
     description: |
-      Discards endpoint configurations previously created via "/configure_reflection"
+      Discards endpoint configurations previously created via "/configure_reflection"
+  - path: /inspect
+    methods: [any]
+    contentType: any
+    description: |
+      Logs debug information about the received request, such as headers and body size.