Adds option for omitting db log args, groups under db attr key (#2136)

nucleuscloud · Jun 13, 2024 · 24746ad · 24746ad
1 parent 82373e4
commit 24746ad
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 68 deletions.
diff --git a/backend/internal/nucleusdb/db.go b/backend/internal/nucleusdb/db.go
@@ -62,7 +62,7 @@ func NewFromConfig(config *ConnectConfig) (*NucleusDb, error) {
 		return nil, err
 	}
 	pgxconfig.ConnConfig.Tracer = &tracelog.TraceLog{
-		Logger:   pgxslog.NewLogger(slog.Default()),
+		Logger:   pgxslog.NewLogger(slog.Default(), pgxslog.GetShouldOmitArgs()),
 		LogLevel: pgxslog.GetDatabaseLogLevel(),
 	}
 

diff --git a/backend/internal/pgx-slog/adapter.go b/backend/internal/pgx-slog/adapter.go
@@ -13,11 +13,12 @@ import (
 // Copied to avoid adding another go mod dependency which also allows us to ensure this is always compatible with our version of pgx
 
 type Logger struct {
-	l *slog.Logger
+	l        *slog.Logger
+	omitArgs bool
 }
 
-func NewLogger(l *slog.Logger) *Logger {
-	return &Logger{l: l}
+func NewLogger(l *slog.Logger, omitArgs bool) *Logger {
+	return &Logger{l: l, omitArgs: omitArgs}
 }
 
 func (l *Logger) Log(ctx context.Context, level tracelog.LogLevel, msg string, data map[string]any) {
@@ -27,6 +28,9 @@ func (l *Logger) Log(ctx context.Context, level tracelog.LogLevel, msg string, d
 
 	attrs := make([]slog.Attr, 0, len(data))
 	for k, v := range data {
+		if k == "args" && l.omitArgs {
+			continue
+		}
 		attrs = append(attrs, slog.Any(k, v))
 	}
 
@@ -47,7 +51,14 @@ func (l *Logger) Log(ctx context.Context, level tracelog.LogLevel, msg string, d
 		lvl = slog.LevelError
 		attrs = append(attrs, slog.Any("INVALID_PGX_LOG_LEVEL", level))
 	}
-	l.l.LogAttrs(ctx, lvl, msg, attrs...)
+
+	attrAny := make([]any, len(attrs))
+	for i, attr := range attrs {
+		attrAny[i] = attr
+	}
+	dbGroup := slog.Group("db", attrAny...)
+
+	l.l.LogAttrs(ctx, lvl, msg, dbGroup)
 }
 
 // Returns a tracelog.LogLevel as configured by the environment
@@ -59,3 +70,7 @@ func GetDatabaseLogLevel() tracelog.LogLevel {
 	}
 	return ll
 }
+
+func GetShouldOmitArgs() bool {
+	return viper.GetBool("DB_OMIT_ARGS")
+}
diff --git a/backend/pkg/sqlconnect/pgpool.go b/backend/pkg/sqlconnect/pgpool.go
@@ -61,7 +61,7 @@ func (s *PgPool) Open(ctx context.Context) (pg_queries.DBTX, error) {
 			return nil, fmt.Errorf("unable to parse dsn into pg config: %w", err)
 		}
 		config.ConnConfig.Tracer = &tracelog.TraceLog{
-			Logger:   pgxslog.NewLogger(s.logger),
+			Logger:   pgxslog.NewLogger(s.logger, pgxslog.GetShouldOmitArgs()),
 			LogLevel: pgxslog.GetDatabaseLogLevel(),
 		}
 		config.ConnConfig.DefaultQueryExecMode = pgx.QueryExecModeExec
@@ -88,7 +88,7 @@ func (s *PgPool) Open(ctx context.Context) (pg_queries.DBTX, error) {
 		return nil, err
 	}
 	config.ConnConfig.Tracer = &tracelog.TraceLog{
-		Logger:   pgxslog.NewLogger(s.logger),
+		Logger:   pgxslog.NewLogger(s.logger, pgxslog.GetShouldOmitArgs()),
 		LogLevel: pgxslog.GetDatabaseLogLevel(),
 	}
 	config.ConnConfig.DefaultQueryExecMode = pgx.QueryExecModeExec

diff --git a/backend/pkg/sqlmanager/sql-manager.go b/backend/pkg/sqlmanager/sql-manager.go
@@ -258,7 +258,7 @@ func (s *SqlManager) NewSqlDbFromUrl(
 			return nil, err
 		}
 		pgxconfig.ConnConfig.Tracer = &tracelog.TraceLog{
-			Logger:   pgxslog.NewLogger(slog.Default()),
+			Logger:   pgxslog.NewLogger(slog.Default(), pgxslog.GetShouldOmitArgs()),
 			LogLevel: pgxslog.GetDatabaseLogLevel(),
 		}
 		pgxconfig.ConnConfig.DefaultQueryExecMode = pgx.QueryExecModeExec

diff --git a/compose.dev.yml b/compose.dev.yml
@@ -88,6 +88,8 @@ services:
       - DB_MIGRATIONS_TABLE=neosync_api_schema_migrations
       - DB_MIGRATIONS_TABLE_QUOTED=false
 
+      - DB_LOG_LEVEL=ERROR
+
       - AUTH_ENABLED=false
 
     networks:

diff --git a/docs/docs/deploy/environment-variables.md b/docs/docs/deploy/environment-variables.md
diff --git a/docs/docs/guides/troubleshooting.md b/docs/docs/guides/troubleshooting.md
@@ -98,4 +98,10 @@ Valid options for `DB_LOG_LEVEL` are (not case sensitive):
 - error
 - none
 
-**Note** - When turning on database logging, the statements **include arguments**. So if planning to run this in any production environment, you may leak PII or other sensitive information. Work is in progress to allow omitting the arguments from the logging to include only statements.
+**Note** - When turning on database logging, the statements **include arguments** default.
+
+So if planning to run this in any production environment, you may leak PII or other sensitive information.
+
+To disable arguments from being listed in the query, enable the `DB_OMIT_ARGS=true` environment variable.
+
+All database logs will be grouped under the `db` attribute key.