diff --git a/cmd/hetty/main.go b/cmd/hetty/main.go index fb3f72c..81d9630 100644 --- a/cmd/hetty/main.go +++ b/cmd/hetty/main.go @@ -7,7 +7,7 @@ import ( "flag" "fmt" "io/fs" - "log" + llog "log" "net" "net/http" "os" @@ -18,9 +18,12 @@ import ( badgerdb "github.com/dgraph-io/badger/v3" "github.com/gorilla/mux" "github.com/mitchellh/go-homedir" + "go.uber.org/zap" + "go.uber.org/zap/zapcore" "github.com/dstotijn/hetty/pkg/api" "github.com/dstotijn/hetty/pkg/db/badger" + "github.com/dstotijn/hetty/pkg/log" "github.com/dstotijn/hetty/pkg/proj" "github.com/dstotijn/hetty/pkg/proxy" "github.com/dstotijn/hetty/pkg/reqlog" @@ -32,10 +35,12 @@ var version = "0.0.0" // Flag variables. var ( - caCertFile string - caKeyFile string - dbPath string - addr string + caCertFile string + caKeyFile string + dbPath string + addr string + debug bool + noPrettyLogs bool ) //go:embed admin @@ -45,46 +50,58 @@ var ( var adminContent embed.FS func main() { - if err := run(); err != nil { - log.Fatalf("[ERROR]: %v", err) - } -} - -func run() error { flag.StringVar(&caCertFile, "cert", "~/.hetty/hetty_cert.pem", "CA certificate filepath. Creates a new CA certificate if file doesn't exist") flag.StringVar(&caKeyFile, "key", "~/.hetty/hetty_key.pem", "CA private key filepath. Creates a new CA private key if file doesn't exist") flag.StringVar(&dbPath, "db", "~/.hetty/db", "Database directory path") flag.StringVar(&addr, "addr", ":8080", "TCP address to listen on, in the form \"host:port\"") + flag.BoolVar(&debug, "debug", false, "Enable debug mode") + flag.BoolVar(&noPrettyLogs, "disable-pretty-logs", false, "Disable human readable console logs and encode with JSON.") flag.Parse() + logger, err := log.NewZapLogger(debug, !noPrettyLogs) + if err != nil { + llog.Fatal(err) + } + defer logger.Sync() + + mainLogger := logger.Named("main") + // Expand `~` in filepaths. caCertFile, err := homedir.Expand(caCertFile) if err != nil { - return fmt.Errorf("could not parse CA certificate filepath: %w", err) + logger.Fatal("Failed to parse CA certificate filepath.", zap.Error(err)) } caKeyFile, err := homedir.Expand(caKeyFile) if err != nil { - return fmt.Errorf("could not parse CA private key filepath: %w", err) + logger.Fatal("Failed to parse CA private key filepath.", zap.Error(err)) } dbPath, err := homedir.Expand(dbPath) if err != nil { - return fmt.Errorf("could not parse projects filepath: %w", err) + logger.Fatal("Failed to parse database path.", zap.Error(err)) } // Load existing CA certificate and key from disk, or generate and write // to disk if no files exist yet. caCert, caKey, err := proxy.LoadOrCreateCA(caKeyFile, caCertFile) if err != nil { - return fmt.Errorf("could not create/load CA key pair: %w", err) + logger.Fatal("Failed to load or create CA key pair.", zap.Error(err)) } - badger, err := badger.OpenDatabase(badgerdb.DefaultOptions(dbPath)) + // BadgerDB logs some verbose entries with `INFO` level, so unless + // we're running in debug mode, bump the minimal level to `WARN`. + dbLogger := logger.Named("badgerdb").WithOptions(zap.IncreaseLevel(zapcore.WarnLevel)) + + dbSugaredLogger := dbLogger.Sugar() + + badger, err := badger.OpenDatabase( + badgerdb.DefaultOptions(dbPath).WithLogger(badger.NewLogger(dbSugaredLogger)), + ) if err != nil { - return fmt.Errorf("could not open badger database: %w", err) + logger.Fatal("Failed to open database.", zap.Error(err)) } defer badger.Close() @@ -93,6 +110,7 @@ func run() error { reqLogService := reqlog.NewService(reqlog.Config{ Scope: scope, Repository: badger, + Logger: logger.Named("reqlog").Sugar(), }) senderService := sender.NewService(sender.Config{ @@ -107,12 +125,16 @@ func run() error { Scope: scope, }) if err != nil { - return fmt.Errorf("could not create new project service: %w", err) + logger.Fatal("Failed to create new projects service.", zap.Error(err)) } - p, err := proxy.NewProxy(caCert, caKey) + p, err := proxy.NewProxy(proxy.Config{ + CACert: caCert, + CAKey: caKey, + Logger: logger.Named("proxy").Sugar(), + }) if err != nil { - return fmt.Errorf("could not create proxy: %w", err) + logger.Fatal("Failed to create new proxy.", zap.Error(err)) } p.UseRequestModifier(reqLogService.RequestModifier) @@ -120,7 +142,7 @@ func run() error { fsSub, err := fs.Sub(adminContent, "admin") if err != nil { - return fmt.Errorf("could not prepare subtree file system: %w", err) + logger.Fatal("Failed to construct file system subtree from admin dir.", zap.Error(err)) } adminHandler := http.FileServer(http.FS(fsSub)) @@ -146,18 +168,28 @@ func run() error { // Fallback (default) is the Proxy handler. router.PathPrefix("").Handler(p) - s := &http.Server{ + httpServer := &http.Server{ Addr: addr, Handler: router, TLSNextProto: map[string]func(*http.Server, *tls.Conn, http.Handler){}, // Disable HTTP/2 + ErrorLog: zap.NewStdLog(logger.Named("http")), } - log.Printf("[INFO] Hetty (v%v) is running on %v ...", version, addr) + host, port, err := net.SplitHostPort(addr) + if err != nil { + mainLogger.Fatal("Failed to parse listening address.", zap.Error(err)) + } - err = s.ListenAndServe() + url := fmt.Sprintf("http://%v:%v", host, port) + if host == "" || host == "0.0.0.0" || host == "127.0.0.1" { + url = fmt.Sprintf("http://localhost:%v", port) + } + + mainLogger.Info(fmt.Sprintf("Hetty (v%v) is running on %v ...", version, addr)) + mainLogger.Info(fmt.Sprintf("\x1b[%dm%s\x1b[0m", uint8(32), "Get started at "+url)) + + err = httpServer.ListenAndServe() if err != nil && errors.Is(err, http.ErrServerClosed) { - return fmt.Errorf("http server closed unexpected: %w", err) + mainLogger.Fatal("HTTP server closed unexpected.", zap.Error(err)) } - - return nil } diff --git a/go.mod b/go.mod index c7b4b51..445c373 100644 --- a/go.mod +++ b/go.mod @@ -11,6 +11,7 @@ require ( github.com/mitchellh/go-homedir v1.1.0 github.com/oklog/ulid v1.3.1 github.com/vektah/gqlparser/v2 v2.2.0 + go.uber.org/zap v1.21.0 ) require ( @@ -36,10 +37,12 @@ require ( github.com/urfave/cli/v2 v2.1.1 // indirect github.com/vektah/dataloaden v0.2.1-0.20190515034641-a19b9a6e7c9e // indirect go.opencensus.io v0.22.5 // indirect - golang.org/x/mod v0.3.0 // indirect - golang.org/x/net v0.0.0-20201021035429-f5854403a974 // indirect - golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c // indirect - golang.org/x/tools v0.0.0-20210106214847-113979e3529a // indirect + go.uber.org/atomic v1.7.0 // indirect + go.uber.org/multierr v1.6.0 // indirect + golang.org/x/mod v0.4.2 // indirect + golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect + golang.org/x/sys v0.0.0-20210510120138-977fb7262007 // indirect + golang.org/x/tools v0.1.5 // indirect golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect - gopkg.in/yaml.v2 v2.2.4 // indirect + gopkg.in/yaml.v2 v2.2.8 // indirect ) diff --git a/go.sum b/go.sum index 7ae54b8..2d2edb6 100644 --- a/go.sum +++ b/go.sum @@ -12,6 +12,8 @@ github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883/go.mod h1:rCTlJbsFo github.com/arbovm/levenshtein v0.0.0-20160628152529-48b4e1c0c4d0 h1:jfIu9sQUG6Ig+0+Ap1h4unLjW6YQJpKZVmUzxsD4E/Q= github.com/arbovm/levenshtein v0.0.0-20160628152529-48b4e1c0c4d0/go.mod h1:t2tdKJDJF9BV14lnkjHmOQgcvEKgtqs5a1N3LNdJhGE= github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= +github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8= +github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/cespare/xxhash v1.1.0 h1:a6HrQnmkObjyL+Gs60czilIUGqrzKutQD6XZog3p+ko= github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= github.com/cespare/xxhash/v2 v2.1.1 h1:6MnRN8NT7+YBpUIWxHtefFZOKTAPgGjpQSxqLNn0+qY= @@ -122,8 +124,10 @@ github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DM github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.2.1/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= -github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0= github.com/urfave/cli/v2 v2.1.1 h1:Qt8FeAtxE/vfdrLmR3rxR6JRE0RoVmbXu8+6kZtYU4k= github.com/urfave/cli/v2 v2.1.1/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ= @@ -135,8 +139,17 @@ github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1: github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= go.opencensus.io v0.22.5 h1:dntmOdLpSpHlVqbW5Eay97DelsZHe+55D+xC6i0dDS0= go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk= +go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw= +go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI= +go.uber.org/goleak v1.1.11/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ= +go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4= +go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU= +go.uber.org/zap v1.21.0 h1:WefMeulhovoZ2sYXz7st6K0sLj7bBhpiFaud4r4zST8= +go.uber.org/zap v1.21.0/go.mod h1:wjWOCqI0f2ZZrJF/UufIOkiC8ii6tm1iqIsLo76RfJw= golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= @@ -145,9 +158,11 @@ golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= -golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -156,8 +171,9 @@ golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= -golang.org/x/net v0.0.0-20201021035429-f5854403a974 h1:IX6qOQeG5uLjB/hjjwjedwfjND0hgjPMMyO1RoIXQNI= golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 h1:4nGaVu0QrbjT/AK2PRLuQfQuh6DJve+pELhqTdAj3x0= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -166,6 +182,7 @@ golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -175,8 +192,12 @@ golang.org/x/sys v0.0.0-20190502145724-3ef323f4f1fd/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c h1:VwygUrnw9jn88c4u8GD3rZQbqrP/tgas88tPUbBxQrk= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007 h1:gG67DSER+11cZvqIMb8S8bt0vZtiN6xWYARwirrOSfE= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= @@ -188,8 +209,9 @@ golang.org/x/tools v0.0.0-20190515012406-7d7faa4812bd/go.mod h1:RgjU9mgBXZiqYHBn golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200815165600-90abf76919f3/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= -golang.org/x/tools v0.0.0-20210106214847-113979e3529a h1:CB3a9Nez8M13wwlr/E2YtwoU+qYHKfC+JrDa45RXXoQ= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/tools v0.1.5 h1:ouewzE6p+/VEB31YYnTbEJdi8pFqKp4P4n85vwo3DHA= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -202,11 +224,16 @@ google.golang.org/genproto v0.0.0-20190425155659-357c62f0e4bb/go.mod h1:VzzqZJRn google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.2.4 h1:/eiJrUcujPVeJ3xlSWaiNi3uSVmDGBK1pDHUHAnao1I= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= sourcegraph.com/sourcegraph/appdash v0.0.0-20190731080439-ebfcffb1b5c0/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU= sourcegraph.com/sourcegraph/appdash-data v0.0.0-20151005221446-73f23eafcf67/go.mod h1:L5q+DGLGOQFpo1snNEkLOJT2d1YTW66rWNzatr3He1k= diff --git a/pkg/db/badger/logger.go b/pkg/db/badger/logger.go new file mode 100644 index 0000000..46b78ef --- /dev/null +++ b/pkg/db/badger/logger.go @@ -0,0 +1,21 @@ +package badger + +import ( + "github.com/dgraph-io/badger/v3" + "go.uber.org/zap" +) + +// Interface guard. +var _ badger.Logger = (*Logger)(nil) + +type Logger struct { + *zap.SugaredLogger +} + +func NewLogger(l *zap.SugaredLogger) *Logger { + return &Logger{l} +} + +func (l *Logger) Warningf(template string, args ...interface{}) { + l.Warnf(template, args) +} diff --git a/pkg/log/log.go b/pkg/log/log.go new file mode 100644 index 0000000..b428a92 --- /dev/null +++ b/pkg/log/log.go @@ -0,0 +1,87 @@ +package log + +import ( + "fmt" + "time" + + "go.uber.org/zap" + "go.uber.org/zap/zapcore" +) + +type Logger interface { + Debugw(msg string, v ...interface{}) + Infow(msg string, v ...interface{}) + Errorw(msg string, v ...interface{}) +} + +func NewZapLogger(debug, pretty bool) (*zap.Logger, error) { + var config zap.Config + + if debug { + config = zap.Config{ + Level: zap.NewAtomicLevelAt(zap.DebugLevel), + Development: debug, + Encoding: "json", + EncoderConfig: zapcore.EncoderConfig{ + TimeKey: "ts", + LevelKey: "level", + NameKey: "logger", + CallerKey: "caller", + FunctionKey: zapcore.OmitKey, + MessageKey: "message", + StacktraceKey: "stacktrace", + LineEnding: zapcore.DefaultLineEnding, + EncodeLevel: zapcore.LowercaseLevelEncoder, + EncodeTime: zapcore.RFC3339TimeEncoder, + EncodeDuration: zapcore.SecondsDurationEncoder, + EncodeCaller: zapcore.ShortCallerEncoder, + }, + OutputPaths: []string{"stderr"}, + ErrorOutputPaths: []string{"stderr"}, + } + } else { + config = zap.NewProductionConfig() + } + + if pretty { + config.Encoding = "console" + config.EncoderConfig = zapcore.EncoderConfig{ + TimeKey: "T", + LevelKey: "L", + NameKey: "N", + CallerKey: zapcore.OmitKey, + FunctionKey: zapcore.OmitKey, + MessageKey: "M", + StacktraceKey: zapcore.OmitKey, + ConsoleSeparator: " ", + LineEnding: zapcore.DefaultLineEnding, + EncodeLevel: zapcore.CapitalColorLevelEncoder, + EncodeTime: func(t time.Time, enc zapcore.PrimitiveArrayEncoder) { + enc.AppendString(t.Format("2006/01/02 15:04:05")) + }, + EncodeName: func(loggerName string, enc zapcore.PrimitiveArrayEncoder) { + // Print logger name in cyan (ANSI code 36). + enc.AppendString(fmt.Sprintf("\x1b[%dm%s\x1b[0m", uint8(36), "["+loggerName+"]")) + }, + EncodeDuration: zapcore.StringDurationEncoder, + EncodeCaller: zapcore.ShortCallerEncoder, + } + + if debug { + config.EncoderConfig.CallerKey = "C" + config.EncoderConfig.StacktraceKey = "S" + } + } + + return config.Build() +} + +type NopLogger struct{} + +func (nop NopLogger) Debugw(_ string, _ ...interface{}) {} +func (nop NopLogger) Infow(_ string, _ ...interface{}) {} +func (nop NopLogger) Errorw(_ string, _ ...interface{}) {} + +func NewNopLogger() NopLogger { + return NopLogger{} +} diff --git a/pkg/proxy/proxy.go b/pkg/proxy/proxy.go index ae4e6bb..61094ba 100644 --- a/pkg/proxy/proxy.go +++ b/pkg/proxy/proxy.go @@ -7,10 +7,11 @@ import ( "crypto/x509" "errors" "fmt" - "log" "net" "net/http" "net/http/httputil" + + "github.com/dstotijn/hetty/pkg/log" ) type contextKey int @@ -22,15 +23,22 @@ const ReqLogIDKey contextKey = 0 type Proxy struct { certConfig *CertConfig handler http.Handler + logger log.Logger // TODO: Add mutex for modifier funcs. reqModifiers []RequestModifyMiddleware resModifiers []ResponseModifyMiddleware } +type Config struct { + CACert *x509.Certificate + CAKey crypto.PrivateKey + Logger log.Logger +} + // NewProxy returns a new Proxy. -func NewProxy(ca *x509.Certificate, key crypto.PrivateKey) (*Proxy, error) { - certConfig, err := NewCertConfig(ca, key) +func NewProxy(cfg Config) (*Proxy, error) { + certConfig, err := NewCertConfig(cfg.CACert, cfg.CAKey) if err != nil { return nil, err } @@ -39,12 +47,17 @@ func NewProxy(ca *x509.Certificate, key crypto.PrivateKey) (*Proxy, error) { certConfig: certConfig, reqModifiers: make([]RequestModifyMiddleware, 0), resModifiers: make([]ResponseModifyMiddleware, 0), + logger: cfg.Logger, + } + + if p.logger == nil { + p.logger = log.NewNopLogger() } p.handler = &httputil.ReverseProxy{ Director: p.modifyRequest, ModifyResponse: p.modifyResponse, - ErrorHandler: errorHandler, + ErrorHandler: p.errorHandler, } return p, nil @@ -103,7 +116,8 @@ func (p *Proxy) modifyResponse(res *http.Response) error { func (p *Proxy) handleConnect(w http.ResponseWriter) { hj, ok := w.(http.Hijacker) if !ok { - log.Printf("[ERROR] handleConnect: ResponseWriter is not a http.Hijacker (type: %T)", w) + p.logger.Errorw("ResponseWriter is not a http.Hijacker.", + "type", fmt.Sprintf("%T", w)) writeError(w, http.StatusServiceUnavailable) return @@ -113,7 +127,8 @@ func (p *Proxy) handleConnect(w http.ResponseWriter) { clientConn, _, err := hj.Hijack() if err != nil { - log.Printf("[ERROR] Hijacking client connection failed: %v", err) + p.logger.Errorw("Hijacking client connection failed.", + "error", err) writeError(w, http.StatusServiceUnavailable) return @@ -121,18 +136,21 @@ func (p *Proxy) handleConnect(w http.ResponseWriter) { defer clientConn.Close() // Secure connection to client. - clientConn, err = p.clientTLSConn(clientConn) + tlsConn, err := p.clientTLSConn(clientConn) if err != nil { - log.Printf("[ERROR] Securing client connection failed: %v", err) + p.logger.Errorw("Securing client connection failed.", + "error", err, + "remoteAddr", clientConn.RemoteAddr().String()) return } - clientConnNotify := ConnNotify{clientConn, make(chan struct{})} + clientConnNotify := ConnNotify{tlsConn, make(chan struct{})} l := &OnceAcceptListener{clientConnNotify.Conn} err = http.Serve(l, p) if err != nil && !errors.Is(err, ErrAlreadyAccepted) { - log.Printf("[ERROR] Serving HTTP request failed: %v", err) + p.logger.Errorw("Serving HTTP request failed.", + "error", err) } <-clientConnNotify.closed @@ -150,12 +168,13 @@ func (p *Proxy) clientTLSConn(conn net.Conn) (*tls.Conn, error) { return tlsConn, nil } -func errorHandler(w http.ResponseWriter, r *http.Request, err error) { +func (p *Proxy) errorHandler(w http.ResponseWriter, r *http.Request, err error) { if errors.Is(err, context.Canceled) { return } - log.Printf("[ERROR]: Proxy error: %v", err) + p.logger.Errorw("Failed to proxy request.", + "error", err) w.WriteHeader(http.StatusBadGateway) } diff --git a/pkg/reqlog/reqlog.go b/pkg/reqlog/reqlog.go index 9876260..a1af207 100644 --- a/pkg/reqlog/reqlog.go +++ b/pkg/reqlog/reqlog.go @@ -8,7 +8,6 @@ import ( "fmt" "io" "io/ioutil" - "log" "math/rand" "net/http" "net/url" @@ -16,6 +15,7 @@ import ( "github.com/oklog/ulid" + "github.com/dstotijn/hetty/pkg/log" "github.com/dstotijn/hetty/pkg/proxy" "github.com/dstotijn/hetty/pkg/scope" "github.com/dstotijn/hetty/pkg/search" @@ -74,6 +74,7 @@ type service struct { activeProjectID ulid.ULID scope *scope.Scope repo Repository + logger log.Logger } type FindRequestsFilter struct { @@ -85,13 +86,21 @@ type FindRequestsFilter struct { type Config struct { Scope *scope.Scope Repository Repository + Logger log.Logger } func NewService(cfg Config) Service { - return &service{ - repo: cfg.Repository, - scope: cfg.Scope, + s := &service{ + repo: cfg.Repository, + scope: cfg.Scope, + logger: cfg.Logger, } + + if s.logger == nil { + s.logger = log.NewNopLogger() + } + + return s } func (svc *service) FindRequests(ctx context.Context) ([]RequestLog, error) { @@ -129,7 +138,8 @@ func (svc *service) RequestModifier(next proxy.RequestModifyFunc) proxy.RequestM body, err = ioutil.ReadAll(req.Body) if err != nil { - log.Printf("[ERROR] Could not read request body for logging: %v", err) + svc.logger.Errorw("Failed to read request body for logging.", + "error", err) return } @@ -142,6 +152,9 @@ func (svc *service) RequestModifier(next proxy.RequestModifyFunc) proxy.RequestM ctx := context.WithValue(req.Context(), LogBypassedKey, true) *req = *req.WithContext(ctx) + svc.logger.Debugw("Bypassed logging: no active project.", + "url", req.URL.String()) + return } @@ -151,6 +164,9 @@ func (svc *service) RequestModifier(next proxy.RequestModifyFunc) proxy.RequestM ctx := context.WithValue(req.Context(), LogBypassedKey, true) *req = *req.WithContext(ctx) + svc.logger.Debugw("Bypassed logging: request doesn't match any scope rules.", + "url", req.URL.String()) + return } @@ -166,10 +182,15 @@ func (svc *service) RequestModifier(next proxy.RequestModifyFunc) proxy.RequestM err := svc.repo.StoreRequestLog(req.Context(), reqLog) if err != nil { - log.Printf("[ERROR] Could not store request log: %v", err) + svc.logger.Errorw("Failed to store request log.", + "error", err) return } + svc.logger.Debugw("Stored request log.", + "reqLogID", reqLog.ID.String(), + "url", reqLog.URL.String()) + ctx := context.WithValue(req.Context(), proxy.ReqLogIDKey, reqLog.ID) *req = *req.WithContext(ctx) } @@ -203,7 +224,11 @@ func (svc *service) ResponseModifier(next proxy.ResponseModifyFunc) proxy.Respon go func() { if err := svc.storeResponse(context.Background(), reqLogID, &clone); err != nil { - log.Printf("[ERROR] Could not store response log: %v", err) + svc.logger.Errorw("Failed to store response log.", + "error", err) + } else { + svc.logger.Debugw("Stored response log.", + "reqLogID", reqLogID.String()) } }()