Currently, patchwork code has to be modified to debug SQL issues.
This is not very convenient.
Add bun query logger. It is disabled by default and can be enabled
in configuration.

Signed-off-by: Franciszek Stachura <[email protected]>
---
 docs/deployment/configuration.rst |  6 ++++++
 go.mod                            |  1 +
 go.sum                            |  2 ++
 pkg/config/config.go              |  1 +
 pkg/db/db.go                      | 11 ++++++++++-
 5 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/docs/deployment/configuration.rst 
b/docs/deployment/configuration.rst
index 9152a56..d7a4464 100644
--- a/docs/deployment/configuration.rst
+++ b/docs/deployment/configuration.rst
@@ -73,6 +73,12 @@ Settings Reference
    running :program:`pw admin gc`. Accepts duration suffixes: `s`, `m`, `h`,
    `d` (days) and `w` (weeks). Set to `0s` to disable event purging.
 
+.. confval:: [database].log-queries
+   :type: bool
+   :default: `false`
+
+   Log all queries. Useful for debugging.
+
 .. confval:: [http].listen
    :type: string
    :default: `"127.0.0.1:8080"`
diff --git a/go.mod b/go.mod
index c09dbdc..a2f82c8 100644
--- a/go.mod
+++ b/go.mod
@@ -46,6 +46,7 @@ require (
        github.com/puzpuzpuz/xsync/v3 v3.5.1 // indirect
        github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // 
indirect
        github.com/tmthrgd/go-hex v0.0.0-20190904060850-447a3041c3bc // indirect
+       github.com/uptrace/bun/extra/bundebug v1.3.0 // indirect
        github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
        github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
        go.yaml.in/yaml/v3 v3.0.5 // indirect
diff --git a/go.sum b/go.sum
index af35a34..ecad15d 100644
--- a/go.sum
+++ b/go.sum
@@ -91,6 +91,8 @@ github.com/uptrace/bun/dialect/pgdialect v1.3.0 
h1:0ZkGqGugxaPCxko4DV2f4d7i+FnM2
 github.com/uptrace/bun/dialect/pgdialect v1.3.0/go.mod 
h1:kP5HGEpAX8iJCqj3WHm04XnoeBPacdCN1P2HiwMtHpg=
 github.com/uptrace/bun/dialect/sqlitedialect v1.3.0 
h1:XzxkORYksxkLsIQLJHFYUb3yDvqSQHzTungyKpJhHTw=
 github.com/uptrace/bun/dialect/sqlitedialect v1.3.0/go.mod 
h1:x2D1sY50Itio0I/FVdNe30oMUT2ObiAS+oILcMR+Wys=
+github.com/uptrace/bun/extra/bundebug v1.3.0 
h1:mqO0OdoTz0uV9+gFTJ04v/9HzPhV498R0HmvCtar9u8=
+github.com/uptrace/bun/extra/bundebug v1.3.0/go.mod 
h1:bkqioiH6Jdpz3NmR5mDekK5mOG+v81qpQnzAaRtERc4=
 github.com/vmihailenco/msgpack/v5 v5.4.1 
h1:cQriyiUvjTwOHg8QZaPihLWeRAAVoCpE00IUPn0Bjt8=
 github.com/vmihailenco/msgpack/v5 v5.4.1/go.mod 
h1:GaZTsDaehaPpQVyxrf5mtQlH+pc21PIudVV/E3rRQok=
 github.com/vmihailenco/tagparser/v2 v2.0.0 
h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
diff --git a/pkg/config/config.go b/pkg/config/config.go
index 8589398..e14d0cf 100644
--- a/pkg/config/config.go
+++ b/pkg/config/config.go
@@ -26,6 +26,7 @@ type DatabaseConfig struct {
        URL         string   `help:"Database connection URL." 
completion:"sqlite://,postgres://,mysql://"`
        AutoSync    bool     `help:"Automatically run pending migrations at 
startup."`
        EventMaxAge Duration `help:"Maximum age of events. Used by pw admin 
gc." default:"30d"`
+       LogQueries  bool     `help:"Log all queries. Useful for debugging." 
default:"false"`
 }
 
 type IngressConfig struct {
diff --git a/pkg/db/db.go b/pkg/db/db.go
index f61d4aa..4617e31 100644
--- a/pkg/db/db.go
+++ b/pkg/db/db.go
@@ -22,6 +22,7 @@ import (
        "github.com/uptrace/bun/dialect/mysqldialect"
        "github.com/uptrace/bun/dialect/pgdialect"
        "github.com/uptrace/bun/dialect/sqlitedialect"
+       "github.com/uptrace/bun/extra/bundebug"
        "github.com/uptrace/bun/schema"
        _ "modernc.org/sqlite" // register sqlite driver
 
@@ -126,7 +127,15 @@ func Open(cfg *config.Config) (*bun.DB, error) {
                return nil, fmt.Errorf("sql.Open(%s): %w", driver, err)
        }
 
-       return bun.NewDB(conn, dialect), nil
+       db := bun.NewDB(conn, dialect)
+       if cfg.Database.LogQueries {
+               db = db.WithQueryHook(
+                       bundebug.NewQueryHook(
+                               bundebug.WithVerbose(true),
+                       ),
+               )
+       }
+       return db, nil
 }
 
 // parseSqliteURL rebuilds a URL for sqlite DSNs that url.Parse rejects,
-- 
2.56.0

_______________________________________________
Patchwork mailing list
[email protected]
https://lists.ozlabs.org/listinfo/patchwork

Reply via email to