feat: Configure GORM log level settings (#652)

* feat : gorm log level config

* feat : gorm log level config

Author: shootercheng

.env.example

@@ -132,6 +132,13 @@ DB_CONN_MAX_LIFETIME=3600
 # DB_EXTRAS in GORM format
 DB_EXTRAS=
 DB_CHARSET=
+# The DB_GORM_LOG_LEVEL environment variable controls the logging verbosity of GORM
+# with a default value of empty string. 
+# Possible values are "info", "warn", "error", and "silent".
+# "warn" is the default level, showing only error and warning logs
+# "info" level displays SQL statements
+# Refer to gorm.io/gorm/logger#LogLevel for detailed information.
+DB_GORM_LOG_LEVEL=
 
 DIFY_INVOCATION_CONNECTION_IDLE_TIMEOUT=120
 

go.mod

@@ -23,6 +23,7 @@ require (
 	go.opentelemetry.io/otel v1.41.0
 	go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp v1.41.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.41.0
+	go.opentelemetry.io/otel/metric v1.41.0
 	go.opentelemetry.io/otel/sdk v1.41.0
 	go.opentelemetry.io/otel/sdk/metric v1.41.0
 	go.opentelemetry.io/otel/trace v1.41.0
@@ -146,7 +147,6 @@ require (
 	go.opentelemetry.io/contrib/detectors/gcp v1.39.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.41.0 // indirect
-	go.opentelemetry.io/otel/metric v1.41.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.9.0 // indirect
 	golang.org/x/mod v0.32.0 // indirect
 	golang.org/x/oauth2 v0.35.0 // indirect

internal/db/config/config.go

@@ -0,0 +1,22 @@
+package config
+
+import (
+	"gorm.io/gorm/logger"
+)
+
+// GORM_LOG_LEVEL_MAP
+var gormLogLevelMap = map[string]logger.LogLevel{
+	"silent": logger.Silent,
+	"error":  logger.Error,
+	"warn":   logger.Warn,
+	"info":   logger.Info,
+}
+
+func ValidateGormLogLevel(level string) bool {
+	_, ok := gormLogLevelMap[level]
+	return ok
+}
+
+func GetGormLogLevel(level string) logger.LogLevel {
+	return gormLogLevelMap[level]
+}

internal/db/init.go

@@ -80,6 +80,7 @@ func Init(config *app.Config) {
 			// enable prepared statements only for native PostgreSQL, disable for PgBouncer
 			// as it's not supported on transaction pooling mode
 			PreparedStatements: config.DBType == app.DB_TYPE_POSTGRESQL,
+			LogLevel:           config.DBGormLogLevel,
 		})
 	} else if config.DBType == app.DB_TYPE_MYSQL {
 		DifyPluginDB, err = mysql.InitPluginDB(&mysql.MySQLConfig{
@@ -95,6 +96,7 @@ func Init(config *app.Config) {
 			ConnMaxLifetime: config.DBConnMaxLifetime,
 			Charset:         config.DBCharset,
 			Extras:          config.DBExtras,
+			LogLevel:        config.DBGormLogLevel,
 		})
 	} else {
 		log.Panic("unsupported database type", "type", config.DBType)

internal/db/mysql/mysql.go

@@ -4,8 +4,10 @@ import (
 	"fmt"
 	"time"
 
+	gormConfig "github.com/langgenius/dify-plugin-daemon/internal/db/config"
 	"gorm.io/driver/mysql"
 	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
 )
 
 type MySQLConfig struct {
@@ -21,6 +23,7 @@ type MySQLConfig struct {
 	ConnMaxLifetime int
 	Charset         string
 	Extras          string
+	LogLevel        string
 }
 
 func InitPluginDB(config *MySQLConfig) (*gorm.DB, error) {
@@ -31,6 +34,7 @@ func InitPluginDB(config *MySQLConfig) (*gorm.DB, error) {
 		user:     config.User,
 		password: config.Pass,
 		sslMode:  config.SSLMode,
+		logLevel: config.LogLevel,
 	}
 
 	// first try to connect to target database
@@ -74,11 +78,17 @@ type mysqlDbInitializer struct {
 	user     string
 	password string
 	sslMode  string
+	logLevel string
 }
 
 func (m *mysqlDbInitializer) connect(dbName string) (*gorm.DB, error) {
 	dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=utf8mb4&parseTime=true&tls=%v", m.user, m.password, m.host, m.port, dbName, m.sslMode == "require")
-	return gorm.Open(myDialector{Dialector: mysql.Open(dsn).(*mysql.Dialector)}, &gorm.Config{})
+
+	config := &gorm.Config{}
+	if m.logLevel != "" {
+		config.Logger = logger.Default.LogMode(gormConfig.GetGormLogLevel(m.logLevel))
+	}
+	return gorm.Open(myDialector{Dialector: mysql.Open(dsn).(*mysql.Dialector)}, config)
 }
 
 func (m *mysqlDbInitializer) createDatabaseIfNotExists(db *gorm.DB, dbName string) error {

internal/db/pg/pg.go

@@ -5,8 +5,10 @@ import (
 	"strings"
 	"time"
 
+	appDbConfig "github.com/langgenius/dify-plugin-daemon/internal/db/config"
 	"gorm.io/driver/postgres"
 	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
 )
 
 type PGConfig struct {
@@ -23,6 +25,7 @@ type PGConfig struct {
 	Charset            string
 	Extras             string
 	PreparedStatements bool
+	LogLevel           string
 }
 
 func InitPluginDB(config *PGConfig) (*gorm.DB, error) {
@@ -31,6 +34,9 @@ func InitPluginDB(config *PGConfig) (*gorm.DB, error) {
 	gormConfig := &gorm.Config{
 		PrepareStmt: config.PreparedStatements,
 	}
+	if config.LogLevel != "" {
+		gormConfig.Logger = logger.Default.LogMode(appDbConfig.GetGormLogLevel(config.LogLevel))
+	}
 	db, err := gorm.Open(postgres.Open(dsn), gormConfig)
 	if err != nil {
 		// if connection fails, try to create database

internal/types/app/config.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 
 	"github.com/go-playground/validator/v10"
+	gormConfig "github.com/langgenius/dify-plugin-daemon/internal/db/config"
 	"github.com/langgenius/dify-plugin-daemon/pkg/entities/plugin_entities"
 )
 
@@ -151,6 +152,7 @@ type Config struct {
 	DBConnMaxLifetime int    `envconfig:"DB_CONN_MAX_LIFETIME" default:"3600"`
 	DBExtras          string `envconfig:"DB_EXTRAS"`
 	DBCharset         string `envconfig:"DB_CHARSET"`
+	DBGormLogLevel    string `envconfig:"DB_GORM_LOG_LEVEL"`
 
 	// persistence storage
 	PersistenceStoragePath    string `envconfig:"PERSISTENCE_STORAGE_PATH"`
@@ -291,6 +293,11 @@ func (c *Config) Validate() error {
 		return fmt.Errorf("plugin package cache path is empty")
 	}
 
+	if c.DBGormLogLevel != "" {
+		if !gormConfig.ValidateGormLogLevel(c.DBGormLogLevel) {
+			return fmt.Errorf("invalid gorm log level: '%s'. Valid levels are: silent, error, warn, info", c.DBGormLogLevel)
+		}
+	}
 	return nil
 }