feat(bundebug): allow to configure the hook using env var, for exampl…

…e, BUNDEBUG={0,1,2}

example/basic/README.md

@@ -6,4 +6,10 @@ To run this example:
 go run .
 ```
 
+To disable query logging:
+
+```shell
+BUNDEBUG=0 go run .
+```
+
 See [docs](https://bun.uptrace.dev/) for details.

example/basic/main.go

@@ -23,7 +23,10 @@ func main() {
 	sqlite.SetMaxOpenConns(1)
 
 	db := bun.NewDB(sqlite, sqlitedialect.New())
-	db.AddQueryHook(bundebug.NewQueryHook(bundebug.WithVerbose(true)))
+	db.AddQueryHook(bundebug.NewQueryHook(
+		bundebug.WithVerbose(true),
+		bundebug.FromEnv("BUNDEBUG"),
+	))
 
 	// Register models for the fixture.
 	db.RegisterModel((*User)(nil), (*Story)(nil))

extra/bundebug/debug.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"database/sql"
 	"fmt"
+	"os"
 	"reflect"
 	"time"
 
@@ -14,20 +15,49 @@ import (
 
 type ConfigOption func(*QueryHook)
 
+// WithEnabled enables/disables the hook.
+func WithEnabled(on bool) ConfigOption {
+	return func(h *QueryHook) {
+		h.enabled = on
+	}
+}
+
+// WithVerbose configures the hook to log all queries
+// (by default, only failed queries are logged).
 func WithVerbose(on bool) ConfigOption {
 	return func(h *QueryHook) {
 		h.verbose = on
 	}
 }
 
+// WithEnv configures the hook using then environment variable value.
+// For example, WithEnv("BUNDEBUG"):
+//    - BUNDEBUG=0 - disables the hook.
+//    - BUNDEBUG=1 - enables the hook.
+//    - BUNDEBUG=2 - enables the hook and verbose mode.
+func FromEnv(key string) ConfigOption {
+	if key == "" {
+		key = "BUNDEBUG"
+	}
+	return func(h *QueryHook) {
+		if env, ok := os.LookupEnv(key); ok {
+			h.enabled = env != "" && env != "0"
+			h.verbose = env == "2"
+		}
+	}
+}
+
 type QueryHook struct {
+	enabled bool
 	verbose bool
 }
 
 var _ bun.QueryHook = (*QueryHook)(nil)
 
 func NewQueryHook(opts ...ConfigOption) *QueryHook {
-	h := new(QueryHook)
+	h := &QueryHook{
+		enabled: true,
+	}
 	for _, opt := range opts {
 		opt(h)
 	}
@@ -41,6 +71,10 @@ func (h *QueryHook) BeforeQuery(
 }
 
 func (h *QueryHook) AfterQuery(ctx context.Context, event *bun.QueryEvent) {
+	if !h.enabled {
+		return
+	}
+
 	if !h.verbose {
 		switch event.Err {
 		case nil, sql.ErrNoRows: