feitianbubu
c3db41407d
* fix: parameterize slow/error SQL logs to avoid leaking credentials * fix: validate SQL_SLOW_THRESHOLD_MS range * fix: sanitize database driver error messages in SQL logs * refactor: sanitize at gorm log writer seam to keep caller attribution
87 lines
2.7 KiB
Go
87 lines
2.7 KiB
Go
package model
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"log"
|
|
"os"
|
|
"time"
|
|
|
|
"github.com/ClickHouse/clickhouse-go/v2/lib/proto"
|
|
"github.com/QuantumNous/new-api/common"
|
|
sqlitedriver "github.com/glebarez/go-sqlite"
|
|
"github.com/go-sql-driver/mysql"
|
|
"github.com/jackc/pgx/v5/pgconn"
|
|
"gorm.io/gorm"
|
|
"gorm.io/gorm/logger"
|
|
)
|
|
|
|
const (
|
|
defaultSlowThresholdMs = 200
|
|
maxSlowThresholdMs = 60 * 60 * 1000
|
|
)
|
|
|
|
func newGormConfig(prepareStmt bool) *gorm.Config {
|
|
return &gorm.Config{
|
|
PrepareStmt: prepareStmt,
|
|
Logger: newGormLogger(os.Stdout),
|
|
}
|
|
}
|
|
|
|
func newGormLogger(w io.Writer) logger.Interface {
|
|
slowThresholdMs := common.GetEnvOrDefault("SQL_SLOW_THRESHOLD_MS", defaultSlowThresholdMs)
|
|
if slowThresholdMs < 0 || slowThresholdMs > maxSlowThresholdMs {
|
|
common.SysError(fmt.Sprintf("invalid SQL_SLOW_THRESHOLD_MS %d (allowed 0-%d, 0 disables slow query log), using default %d", slowThresholdMs, maxSlowThresholdMs, defaultSlowThresholdMs))
|
|
slowThresholdMs = defaultSlowThresholdMs
|
|
}
|
|
// 在 Writer 层脱敏而非包装 logger.Interface:后者会让 gorm 的 FileWithLineNum
|
|
// 把所有 SQL 日志的调用点归因到包装层自身,且需转发 ParamsFilter 类型断言。
|
|
return logger.New(&sanitizedLogWriter{delegate: log.New(w, "\r\n", log.LstdFlags)}, logger.Config{
|
|
SlowThreshold: time.Duration(slowThresholdMs) * time.Millisecond,
|
|
LogLevel: logger.Warn,
|
|
IgnoreRecordNotFoundError: true,
|
|
ParameterizedQueries: !common.DebugEnabled,
|
|
Colorful: true,
|
|
})
|
|
}
|
|
|
|
// ParameterizedQueries 只过滤 SQL 字符串,驱动错误消息(如 MySQL 1062)同样会
|
|
// 内联数据值,在这里收敛为错误码;DEBUG=true 保留原文。
|
|
type sanitizedLogWriter struct {
|
|
delegate *log.Logger
|
|
}
|
|
|
|
func (s *sanitizedLogWriter) Printf(format string, args ...interface{}) {
|
|
if !common.DebugEnabled {
|
|
for i, arg := range args {
|
|
if err, ok := arg.(error); ok {
|
|
args[i] = sanitizeDBError(err)
|
|
}
|
|
}
|
|
}
|
|
s.delegate.Printf(format, args...)
|
|
}
|
|
|
|
// 只收敛数据库服务端生成的驱动错误(消息可能内联数据值);网络/上下文等
|
|
// 其它错误不含查询数据,原样保留以便排障。
|
|
func sanitizeDBError(err error) error {
|
|
var mysqlErr *mysql.MySQLError
|
|
if errors.As(err, &mysqlErr) {
|
|
return fmt.Errorf("mysql error %d", mysqlErr.Number)
|
|
}
|
|
var pgErr *pgconn.PgError
|
|
if errors.As(err, &pgErr) {
|
|
return fmt.Errorf("postgres error SQLSTATE %s", pgErr.Code)
|
|
}
|
|
var chErr *proto.Exception
|
|
if errors.As(err, &chErr) {
|
|
return fmt.Errorf("clickhouse error %d", chErr.Code)
|
|
}
|
|
var sqliteErr *sqlitedriver.Error
|
|
if errors.As(err, &sqliteErr) {
|
|
return fmt.Errorf("sqlite error %d", sqliteErr.Code())
|
|
}
|
|
return err
|
|
}
|