Skip to content
This repository was archived by the owner on Nov 7, 2025. It is now read-only.

Commit d7ac5fa

Browse files
authored
Disable logging of SQL queries (#981)
Logging every SQL query that is executed or transformer has some performance penalty. This PR adds a flag to enable it. We should not log queries by default. Tracing can be enabled via conf: ``` logging: enableSQLTracing: true ```
1 parent c250a90 commit d7ac5fa

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

quesma/ingest/processor.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -820,8 +820,10 @@ func (ip *IngestProcessor) execute(ctx context.Context, query string) error {
820820
span := ip.phoneHomeAgent.ClickHouseInsertDuration().Begin()
821821

822822
// We log every DDL query
823-
if strings.HasPrefix(query, "ALTER") || strings.HasPrefix(query, "CREATE") {
824-
logger.InfoWithCtx(ctx).Msgf("DDL query execution: %s", query)
823+
if ip.cfg.Logging.EnableSQLTracing {
824+
if strings.HasPrefix(query, "ALTER") || strings.HasPrefix(query, "CREATE") {
825+
logger.InfoWithCtx(ctx).Msgf("DDL query execution: %s", query)
826+
}
825827
}
826828

827829
_, err := ip.chDb.ExecContext(ctx, query)
@@ -831,9 +833,7 @@ func (ip *IngestProcessor) execute(ctx context.Context, query string) error {
831833

832834
func (ip *IngestProcessor) executeStatements(ctx context.Context, queries []string) error {
833835
for _, q := range queries {
834-
if strings.HasPrefix("ALTER", q) || strings.HasPrefix("CREATE", q) {
835-
logger.InfoWithCtx(ctx).Msgf("DDL query execution: %s", q)
836-
}
836+
837837
err := ip.execute(ctx, q)
838838
if err != nil {
839839
logger.ErrorWithCtx(ctx).Msgf("error executing query: %v", err)

quesma/quesma/config/config_v2.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ type LoggingConfiguration struct {
5555
Level *zerolog.Level `koanf:"level"`
5656
FileLogging bool `koanf:"fileLogging"`
5757
RemoteLogDrainUrl *Url
58+
EnableSQLTracing bool `koanf:"enableSQLTracing"`
5859
}
5960

6061
type Pipeline struct {

quesma/quesma/schema_transformer.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -770,8 +770,10 @@ func (s *SchemaCheckPass) Transform(queries []*model.Query) ([]*model.Query, err
770770

771771
query.TransformationHistory.SchemaTransformers = append(query.TransformationHistory.SchemaTransformers, transformation.TransformationName)
772772

773-
logger.Info().Msgf(transformation.TransformationName+" triggered, input query: %s", inputQuery)
774-
logger.Info().Msgf(transformation.TransformationName+" triggered, output query: %s", query.SelectCommand.String())
773+
if s.cfg.Logging.EnableSQLTracing {
774+
logger.Info().Msgf(transformation.TransformationName+" triggered, input query: %s", inputQuery)
775+
logger.Info().Msgf(transformation.TransformationName+" triggered, output query: %s", query.SelectCommand.String())
776+
}
775777
}
776778

777779
}

quesma/quesma/search.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,7 +718,11 @@ func (q *QueryRunner) searchWorkerCommon(
718718

719719
for i, query := range queries {
720720
sql := query.SelectCommand.String()
721-
logger.InfoWithCtx(ctx).Msgf("SQL: %s", sql)
721+
722+
if q.cfg.Logging.EnableSQLTracing {
723+
logger.InfoWithCtx(ctx).Msgf("SQL: %s", sql)
724+
}
725+
722726
translatedQueryBody[i].Query = []byte(sql)
723727
if query.OptimizeHints != nil {
724728
translatedQueryBody[i].PerformedOptimizations = query.OptimizeHints.OptimizationsPerformed

0 commit comments

Comments
 (0)