log: remove global log functions

Removes global functions from the log package. These functions
were wrappers around log.Dev.<func> and  were previously
deprecated.

Also replaces and remaining uses with log.Dev.<func>

Epic: CRDB-53410
Resolves: CRDB-53943
Release note: None

Author: kyle-a-wong

pkg/util/log/channels_test.go

@@ -170,7 +170,7 @@ func TestRepro81025(t *testing.T) {
 	// log line.
 	wg.Add(1)
 	go func() {
-		Fatalf(context.Background(), "uh oh")
+		Dev.Fatalf(context.Background(), "uh oh")
 		wg.Done()
 	}()
 

pkg/util/log/clog.go

@@ -438,7 +438,7 @@ func (l *loggerT) outputLogEntry(entry logEntry) {
 func DumpStacks(ctx context.Context, reason redact.RedactableString) {
 	allStacks := allstacks.Get()
 	// TODO(knz): This should really be a "debug" level, not "info".
-	Shoutf(ctx, severity.INFO, "%s. stack traces:\n%s", reason, allStacks)
+	Dev.Shoutf(ctx, severity.INFO, "%s. stack traces:\n%s", reason, allStacks)
 }
 
 func setActive() {

pkg/util/log/clog_test.go

@@ -130,7 +130,7 @@ func TestInfo(t *testing.T) {
 	defer ScopeWithoutShowLogs(t).Close(t)
 
 	defer capture()()
-	Info(context.Background(), "test")
+	Dev.Info(context.Background(), "test")
 	if !contains("I", t) {
 		t.Errorf("Info has wrong character: %q", contents())
 	}
@@ -146,7 +146,7 @@ func TestUnstructuredEntryEmbedsErrorHints(t *testing.T) {
 
 	defer capture()()
 	err := errors.WithHint(errors.New("hello"), "world")
-	Infof(context.Background(), "hello %v", err)
+	Dev.Infof(context.Background(), "hello %v", err)
 	t.Logf("log contents:\n%s", contents())
 	if !contains("HINT: "+startRedactable+"world"+endRedactable, t) {
 		t.Error("hint failed")
@@ -190,7 +190,7 @@ func TestError(t *testing.T) {
 
 	defer capture()()
 
-	Error(context.Background(), "test")
+	Dev.Error(context.Background(), "test")
 	if !contains("E", t) {
 		t.Errorf("Error has wrong character: %q", contents())
 	}
@@ -208,7 +208,7 @@ func TestWarning(t *testing.T) {
 
 	defer capture()()
 
-	Warning(context.Background(), "test")
+	Dev.Warning(context.Background(), "test")
 	if !contains("W", t) {
 		t.Errorf("Warning has wrong character: %q", contents())
 	}
@@ -326,7 +326,7 @@ func TestListLogFiles(t *testing.T) {
 	defer leaktest.AfterTest(t)()
 	defer ScopeWithoutShowLogs(t).Close(t)
 
-	Info(context.Background(), "x")
+	Dev.Info(context.Background(), "x")
 
 	fileName := getDebugLogFileName(t)
 
@@ -358,7 +358,7 @@ func TestFilePermissions(t *testing.T) {
 	defer func(p os.FileMode) { fs.filePermissions = p }(fs.filePermissions)
 	fs.filePermissions = fileMode
 
-	Info(context.Background(), "x")
+	Dev.Info(context.Background(), "x")
 
 	fileName := fs.getFileName(t)
 
@@ -413,7 +413,7 @@ func TestGetLogReader(t *testing.T) {
 		strings.TrimSpace(strings.ReplaceAll(DescribeAppliedConfig(), "\n", "\n  ")))
 
 	// Force creation of a file on the default sink.
-	Info(context.Background(), "x")
+	Dev.Info(context.Background(), "x")
 	fileName := getDebugLogFileName(t)
 	infoName := filepath.Base(fileName)
 
@@ -523,20 +523,20 @@ func TestRollover(t *testing.T) {
 	defer func(previous int64) { debugFileSink.logFileMaxSize = previous }(debugFileSink.logFileMaxSize)
 	debugFileSink.logFileMaxSize = 2048
 
-	Info(context.Background(), "x") // Be sure we have a file.
+	Dev.Info(context.Background(), "x") // Be sure we have a file.
 	if err != nil {
 		t.Fatalf("info has initial error: %v", err)
 	}
 	fname0 := debugFileSink.getFileName(t)
-	Infof(context.Background(), "%s", strings.Repeat("x", int(debugFileSink.logFileMaxSize))) // force a rollover
+	Dev.Infof(context.Background(), "%s", strings.Repeat("x", int(debugFileSink.logFileMaxSize))) // force a rollover
 	if err != nil {
 		t.Fatalf("info has error after big write: %v", err)
 	}
 
 	// Make sure the next log file gets a file name with a different
 	// time stamp.
 
-	Info(context.Background(), "x") // create a new file
+	Dev.Info(context.Background(), "x") // create a new file
 	if err != nil {
 		t.Fatalf("error after rotation: %v", err)
 	}
@@ -573,7 +573,7 @@ func TestFatalStacktraceStderr(t *testing.T) {
 			defer capture()()
 
 			traceback = level
-			Fatalf(context.Background(), "cinap")
+			Dev.Fatalf(context.Background(), "cinap")
 			cont := contents()
 			if !strings.Contains(cont, " cinap") {
 				t.Fatalf("panic output does not contain cinap:\n%s", cont)
@@ -623,7 +623,7 @@ func TestFd2Capture(t *testing.T) {
 	}
 	defer cleanupFn()
 
-	Infof(context.Background(), "test")
+	Dev.Infof(context.Background(), "test")
 
 	const stderrText = "hello stderr"
 	fmt.Fprint(os.Stderr, stderrText)
@@ -649,8 +649,8 @@ func TestFileSeverityFilter(t *testing.T) {
 		}
 	}
 
-	Infof(context.Background(), "test1")
-	Errorf(context.Background(), "test2")
+	Dev.Infof(context.Background(), "test1")
+	Dev.Errorf(context.Background(), "test2")
 
 	FlushFiles()
 
@@ -766,7 +766,7 @@ func TestLogEntryPropagation(t *testing.T) {
 	// failure to write on stderr is graceful and the message gets
 	// printed on the file output (and can be picked up by the contains
 	// function). If it is not, the test runner will stop abruptly.
-	Error(context.Background(), specialMessage)
+	Dev.Error(context.Background(), specialMessage)
 
 	if !contains(specialMessage, t) {
 		t.Fatalf("expected special message in file, got:\n%s", contents())

pkg/util/log/event_log.go

@@ -53,7 +53,7 @@ func RegisterEventLogWriter(
 		if buildutil.CrdbTestBuild {
 			panic("Structured event writer registry not set, cannot register writer")
 		}
-		Errorf(ctx, "Structured event writer registry not set, cannot register writer for serverId: %v", serverId.GetServerIdentificationPayload())
+		Dev.Errorf(ctx, "Structured event writer registry not set, cannot register writer for serverId: %v", serverId.GetServerIdentificationPayload())
 		return
 	}
 
@@ -67,7 +67,7 @@ func RemoveEventLogWriter(serverId serverident.ServerIdentifier) {
 		if buildutil.CrdbTestBuild {
 			panic("Structured event writer registry not set, cannot remove writer")
 		}
-		Errorf(context.Background(), "Structured event writer registry not set, cannot remove writer for serverId: %v", serverId.GetServerIdentificationPayload())
+		Dev.Errorf(context.Background(), "Structured event writer registry not set, cannot remove writer for serverId: %v", serverId.GetServerIdentificationPayload())
 		return
 	}
 
@@ -116,7 +116,7 @@ func EventLog(
 		if buildutil.CrdbTestBuild {
 			panic(fmt.Sprintf("couldn't find a registered writer for serverId: %+v", id.GetServerIdentificationPayload()))
 		}
-		VWarningf(context.Background(), 2, "couldn't find a registered writer for serverId: %+v", id.GetServerIdentificationPayload())
+		Dev.VWarningf(context.Background(), 2, "couldn't find a registered writer for serverId: %+v", id.GetServerIdentificationPayload())
 	}
 	options := defaultSEventOptions
 	for _, opt := range o {

pkg/util/log/file_log_gc_test.go

@@ -33,7 +33,7 @@ func TestGC(t *testing.T) {
 		t.Fatal("no file sink")
 	}
 
-	testLogGC(t, fs, Info)
+	testLogGC(t, fs, Dev.Info)
 }
 
 func TestSecondaryGC(t *testing.T) {
@@ -189,7 +189,7 @@ func succeedsSoon(t *testing.T, fn func() error) {
 			wait = time.Second
 		}
 		if timeutil.Since(tBegin) > 3*time.Second {
-			InfofDepth(context.Background(), 2, "SucceedsSoon: %+v", lastErr)
+			Dev.InfofDepth(context.Background(), 2, "SucceedsSoon: %+v", lastErr)
 		}
 		time.Sleep(wait)
 	}

pkg/util/log/formats_test.go

@@ -65,7 +65,7 @@ func TestFormatRedaction(t *testing.T) {
 							require.NoError(t, err)
 							defer cleanupFn()
 
-							Infof(ctx, "safe2 %s", "secret3")
+							Dev.Infof(ctx, "safe2 %s", "secret3")
 							FlushFiles()
 
 							contents, err := os.ReadFile(getDebugLogFileName(t))

pkg/util/log/gen/main.go

@@ -342,64 +342,6 @@ func (logger{{.Name}}) {{with $sev}}{{.Name}}{{end}}fDepth(ctx context.Context,
   logfDepth(ctx, depth+1, severity.{{with $sev}}{{.NAME}}{{end}}, channel.{{.NAME}}, format, args...)
 }
 
-{{if .NAME|eq "DEV"}}
-// {{with $sev}}{{.Name}}{{end}}f logs to the {{.NAME}} channel with severity {{with $sev}}{{.NAME}}{{end}},
-// if logging has been enabled for the source file where the call is
-// performed at the provided verbosity level, via the vmodule setting.
-// It extracts log tags from the context and logs them along with the given
-// message. Arguments are handled in the manner of fmt.Printf.
-//
-{{.Comment -}}
-//
-{{with $sev}}{{.Comment}}{{end -}}
-//
-// Deprecated: use log.Dev.{{with $sev}}{{.Name}}{{end}}f instead
-func {{with $sev}}{{.Name}}{{end}}f(ctx context.Context, format string, args ...interface{}) {
-  logfDepth(ctx, 1, severity.{{with $sev}}{{.NAME}}{{end}}, channel.{{.NAME}}, format, args...)
-}
-
-// V{{with $sev}}{{.Name}}{{end}}f logs to the {{.NAME}} channel with severity {{with $sev}}{{.NAME}}{{end}}.
-// It extracts log tags from the context and logs them along with the given
-// message. Arguments are handled in the manner of fmt.Printf.
-//
-{{.Comment -}}
-//
-{{with $sev}}{{.Comment}}{{end -}}
-//
-// Deprecated: use log.Dev.V{{with $sev}}{{.Name}}{{end}}f instead
-func V{{with $sev}}{{.Name}}{{end}}f(ctx context.Context, level Level, format string, args ...interface{}) {
-  if VDepth(level, 1) {
-    logfDepth(ctx, 1, severity.{{with $sev}}{{.NAME}}{{end}}, channel.{{.NAME}}, format, args...)
-  }
-}
-
-// {{with $sev}}{{.Name}}{{end}} logs to the {{.NAME}} channel with severity {{with $sev}}{{.NAME}}{{end}}.
-// It extracts log tags from the context and logs them along with the given
-// message.
-//
-{{.Comment -}}
-//
-{{with $sev}}{{.Comment}}{{end -}}
-//
-// Deprecated: use log.Dev.{{with $sev}}{{.Name}}{{end}} instead
-func {{with $sev}}{{.Name}}{{end}}(ctx context.Context, msg string) {
-  logfDepth(ctx, 1, severity.{{with $sev}}{{.NAME}}{{end}}, channel.{{.NAME}}, msg)
-}
-
-// {{with $sev}}{{.Name}}{{end}}fDepth logs to the {{.NAME}} channel with severity {{with $sev}}{{.NAME}}{{end}},
-// offsetting the caller's stack frame by 'depth'.
-// It extracts log tags from the context and logs them along with the given
-// message. Arguments are handled in the manner of fmt.Printf.
-//
-{{.Comment -}}
-//
-{{with $sev}}{{.Comment}}{{end -}}
-//
-// Deprecated: use log.Dev.{{with $sev}}{{.Name}}{{end}}fDepth instead
-func {{with $sev}}{{.Name}}{{end}}fDepth(ctx context.Context, depth int, format string, args ...interface{}) {
-  logfDepth(ctx, depth+1, severity.{{with $sev}}{{.NAME}}{{end}}, channel.{{.NAME}}, format, args...)
-}
-{{end}}{{- /* end channel name = DEV */ -}}
 
 {{end}}{{end}}{{end}}{{- /* end range severities */ -}}
 
@@ -443,30 +385,6 @@ func (logger{{.Name}}) VEventfDepth(ctx context.Context, depth int, level Level,
 	vEventf(ctx, false /* isErr */, 1+depth, level, channel.{{.NAME}}, format, args...)
 }
 
-{{if .NAME|eq "DEV"}}
-
-// Shout logs to channel {{.NAME}}, and also to the real stderr if logging
-// is currently redirected to a file.
-//
-{{.Comment -}}
-//
-// Deprecated: use log.Dev.Shout instead
-func Shout(ctx context.Context, sev Severity, msg string) {
-  shoutfDepth(ctx, 1, sev, channel.{{.NAME}}, msg)
-}
-
-// Shoutf logs to channel {{.NAME}}, and also to the real stderr if
-// logging is currently redirected to a file. Arguments are handled in
-// the manner of fmt.Printf.
-//
-{{.Comment -}}
-//
-// Deprecated: use log.Dev.Shoutf instead
-func Shoutf(ctx context.Context, sev Severity, format string, args ...interface{}) {
-  shoutfDepth(ctx, 1, sev, channel.{{.NAME}}, format, args...)
-}
-
-{{end}}{{- /* end channel name = DEV */ -}}
 
 {{end}}{{- /* end range channels */ -}}
 `,

pkg/util/log/intercept.go

@@ -29,11 +29,11 @@ import (
 // When multiple interceptors are configured, each of them
 // are served each log entry.
 func InterceptWith(ctx context.Context, fn Interceptor) func() {
-	InfofDepth(ctx, 1, "starting log interception")
+	Dev.InfofDepth(ctx, 1, "starting log interception")
 	logging.interceptor.add(fn)
 	return func() {
 		logging.interceptor.del(fn)
-		InfofDepth(ctx, 1, "stopping log interception")
+		Dev.InfofDepth(ctx, 1, "stopping log interception")
 	}
 }
 

pkg/util/log/intercept_test.go

@@ -37,7 +37,7 @@ func TestManyInterceptors(t *testing.T) {
 		ctxgroup.GroupWorkers(context.Background(), 100, func(ctx context.Context, worker int) error {
 			defer addInterceptor(t, &devnull{})()
 			for i := 0; i < 10; i++ {
-				Infof(ctx, "hello worker %d: %d", worker, i)
+				Dev.Infof(ctx, "hello worker %d: %d", worker, i)
 			}
 			return nil
 		}))
@@ -83,7 +83,7 @@ func (c *captureInterceptor) verifyCaptures(t *testing.T) {
 }
 
 func infoWithCapture(msg string, interceptors ...*captureInterceptor) {
-	InfofDepth(context.Background(), 1, "%s", msg)
+	Dev.InfofDepth(context.Background(), 1, "%s", msg)
 	file, line, _ := caller.Lookup(1)
 	expectedRe := regexp.MustCompile(fmt.Sprintf(`.*"file":"%s","line":%d.*%s`, file, line, msg))
 

pkg/util/log/log.go

@@ -16,7 +16,7 @@ import (
 
 func init() {
 	// Inject logging functions into the errors package.
-	errors.SetWarningFn(Warningf)
+	errors.SetWarningFn(Dev.Warningf)
 	// Inject logging functions into the syncutil package.
 	syncutil.LogExpensiveLogEnabled = untypedExpensiveLogEnabled
 	syncutil.LogVEventfDepth = untypedVEventfDepth