Provider does not log anything unless Verbose=true

[geertjanvdk]

I am setting the logger for the provider (either goose.Logger or slog.Logger), however nothing is logged. Using WithVerbose set to true, we do get entries.

Verbose is verbose though, and we get all statements. What I am after is the successfully migrated database with current_version=19. This should be logged regardless of Verbose?

[geertjanvdk]

func (p *Provider) logf(ctx context.Context, legacyMsg string, slogMsg string, attrs ...slog.Attr) {
	if !p.cfg.verbose {
		return
	}

I do believe that certain things should get logged. If people don't want to get logs, they would add a null-logger or?

If we would accept certain log entries, what about refactoring logf as logVerbosef, and then the loggings that would be always good, use logf (which is used by logVerbosef then)?

[mfridman]

Would decoupling the SQL statement output from the rest of the log output suffice?

Something like this? #1040

[geertjanvdk]

@mfridman that would mean we would need to WithVerbose(true) right? That could work, it's a bit weird though :) I mean, WithLoggingEnabled(true) would then be a more clearer option.

But as long as statments are not showing, then the Verbose is a workaround. The problem is that later, if you add more logging, then suddenly production might have more verbosity than needed.

[mfridman]

I've always considered SQL statement output more of a "debugging" option and a separate opt-in than just the verbose flag. But the code as written today couples those together.

But iirc in #768 and #989 I lumped the SQL statements in the log output:

goose/provider_run.go

Lines 521 to 529 in e3235f7

	p.logf(ctx,
	fmt.Sprintf("Executing statement: %s", stmt),
	"executing statement",
	slog.String("statement", stmt),
	slog.String("source", filepath.Base(m.Source)),
	slog.Int64("version", m.Version),
	slog.String("type", string(m.Type)),
	slog.String("direction", string(sqlparser.FromBool(direction))),
	)

I believe you should be able to filter those logs out with slog though, e.g., check if there is a statement key and ignore those?

ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
	// ignore key=statement
	if a.Key == "statement" {
		return slog.Attr{}
	}
	return a
},

[geertjanvdk]

Filtering is a good idea, will do that when nothing is changed. I would need to do that now, because right now I am not logging anything.

Though, I would elevate safe-log entries rather, like I mentioned in my earlier post (logVerbosef and maybe even logDebugf, so it is clear in the code?). Like the "success" can be logged at any time, the rest on-demand (verbose or debugging).