Merge #152548

152548: log,*: require explicit channel selection for logging API r=kyle-a-wong a=kyle-a-wong

Updated the deprecation comment on the generated logging
APIS to adhere to the golang documentation. As a result,
usage of these APIs will now cause lint failures due to
lint check: SA1019.

Epic: [CRDB-53410](https://cockroachlabs.atlassian.net/browse/CRDB-53410)
Release note: None

Co-authored-by: Kyle Wong <[email protected]>

Author: craig[bot]

pkg/acceptance/cluster/docker.go

@@ -317,10 +317,10 @@ func (c *Container) WaitUntilNotRunning(ctx context.Context) error {
 			// NB: TEST_UNDECLARED_OUTPUTS_DIR is set for remote Bazel tests.
 			undeclaredOutsDir := os.Getenv("TEST_UNDECLARED_OUTPUTS_DIR")
 			if undeclaredOutsDir != "" {
-				log.Shoutf(ctx, severity.INFO, "command left-over files in %s",
+				log.Dev.Shoutf(ctx, severity.INFO, "command left-over files in %s",
 					strings.Replace(volumesDir, undeclaredOutsDir, "outputs.zip", 1))
 			} else {
-				log.Shoutf(ctx, severity.INFO, "command left-over files in %s", volumesDir)
+				log.Dev.Shoutf(ctx, severity.INFO, "command left-over files in %s", volumesDir)
 			}
 		}
 

pkg/backup/restore_job.go

@@ -259,7 +259,7 @@ func restoreWithRetry(
 					ctx, txn, "error", fmt.Sprintf("restore encountered error: %v", err),
 				)
 			}); err != nil {
-				log.Warningf(ctx, "failed to record job error message: %v", err)
+				log.Dev.Warningf(ctx, "failed to record job error message: %v", err)
 			}
 		}
 
@@ -330,7 +330,7 @@ func maybeResetRetry(
 		// If the previous persisted spans are different than the current, it
 		// implies that further progress has been persisted.
 		rt.Reset()
-		log.Infof(ctx, "restored frontier has advanced since last retry, resetting retry counter")
+		log.Dev.Infof(ctx, "restored frontier has advanced since last retry, resetting retry counter")
 	}
 	return currProgress
 }

pkg/ccl/changefeedccl/schemafeed/table_event_filter.go

@@ -128,9 +128,9 @@ func (filter tableEventFilter) shouldFilter(
 	et := classifyTableEvent(e)
 
 	if log.V(2) {
-		log.Infof(ctx, "table event %v classified as %v", e, et)
+		log.Dev.Infof(ctx, "table event %v classified as %v", e, et)
 		defer func() {
-			log.Infof(ctx, "should filter table event %v: %t", e, ok)
+			log.Dev.Infof(ctx, "should filter table event %v: %t", e, ok)
 		}()
 	}
 

pkg/cli/cli.go

@@ -356,7 +356,7 @@ func debugSignalSetup() func() {
 				case <-exit:
 					return
 				case <-debugSignalCh:
-					log.Shout(ctx, severity.INFO, "setting up localhost debugging endpoint...")
+					log.Dev.Shout(ctx, severity.INFO, "setting up localhost debugging endpoint...")
 					mux := http.NewServeMux()
 					mux.HandleFunc("/debug/pprof/", pprof.Index)
 					mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
@@ -367,7 +367,7 @@ func debugSignalSetup() func() {
 					listenAddr := "localhost:0"
 					listener, err := net.Listen("tcp", listenAddr)
 					if err != nil {
-						log.Shoutf(ctx, severity.WARNING, "debug server could not start listening on %s: %v", listenAddr, err)
+						log.Dev.Shoutf(ctx, severity.WARNING, "debug server could not start listening on %s: %v", listenAddr, err)
 						continue
 					}
 
@@ -377,7 +377,7 @@ func debugSignalSetup() func() {
 							log.Dev.Warningf(ctx, "debug server: %v", err)
 						}
 					}()
-					log.Shoutf(ctx, severity.INFO, "debug server listening on %s", listener.Addr())
+					log.Dev.Shoutf(ctx, severity.INFO, "debug server listening on %s", listener.Addr())
 					<-exit
 					if err := server.Shutdown(ctx); err != nil {
 						log.Dev.Warningf(ctx, "error shutting down debug server: %s", err)

pkg/cli/start.go

@@ -1472,7 +1472,7 @@ func setupAndInitializeLoggingAndProfiling(
 				"to databases, the --locality flag must contain a \"region\" tier.\n" +
 				"For more information, see:\n\n" +
 				"- %s"
-			log.Shoutf(ctx, severity.WARNING, warningString,
+			log.Dev.Shoutf(ctx, severity.WARNING, warningString,
 				redact.Safe(docs.URL("cockroach-start.html#locality")))
 		}
 	}

pkg/crosscluster/logical/logical_replication_job.go

@@ -348,7 +348,7 @@ func (r *logicalReplicationResumer) ingest(
 			case <-t.C:
 				newDest, err := reloadDest(ctx, ingestionJob.ID(), jobExecCtx.ExecCfg())
 				if err != nil {
-					log.Warningf(ctx, "failed to check for updated configuration: %v", err)
+					log.Dev.Warningf(ctx, "failed to check for updated configuration: %v", err)
 				} else if newDest != resolvedDest {
 					return errors.Mark(errors.Newf("replan due to detail change: old=%s, new=%s", resolvedDest, newDest), sql.ErrPlanChanged)
 				}

pkg/kv/kvclient/rangefeed/rangefeedcache/watcher.go

@@ -312,7 +312,7 @@ func (s *Watcher[E]) Run(ctx context.Context) error {
 		rangefeed.WithDiff(s.withPrevValue),
 		rangefeed.WithRowTimestampInInitialScan(s.withRowTSInInitialScan),
 		rangefeed.WithOnInitialScanError(func(ctx context.Context, err error) (shouldFail bool) {
-			log.VInfof(ctx, 1, "initial scan error: %s", err)
+			log.Dev.VInfof(ctx, 1, "initial scan error: %s", err)
 			// TODO(irfansharif): Consider if there are other errors which we
 			// want to treat as permanent. This was cargo culted from the
 			// settings watcher.

pkg/kv/kvserver/allocator/allocatorimpl/allocator.go

@@ -966,9 +966,9 @@ func (a *Allocator) ComputeAction(
 	// priority inversion. If the priority is not -1, the range might be re-queued
 	// to be processed with the correct priority.
 	if priority == -1 && buildutil.CrdbTestBuild {
-		log.Fatalf(ctx, "allocator returned -1 priority for range %s: %v", desc, action)
+		log.Dev.Fatalf(ctx, "allocator returned -1 priority for range %s: %v", desc, action)
 	} else {
-		log.Warningf(ctx, "allocator returned -1 priority for range %s: %v", desc, action)
+		log.Dev.Warningf(ctx, "allocator returned -1 priority for range %s: %v", desc, action)
 	}
 	return action, priority
 }

pkg/kv/kvserver/batcheval/cmd_add_sstable.go

@@ -475,7 +475,7 @@ func computeSSTStatsDiffWithFallback(
 	stats, err := storage.ComputeSSTStatsDiff(
 		ctx, sst, readWriter, nowNanos, start, end)
 	if errors.IsAny(err, storage.ComputeSSTStatsDiffReaderHasRangeKeys, storage.ComputeStatsDiffViolation) {
-		log.Warningf(ctx, "computing SST stats as estimates because of ComputeSSTStatsDiff error: %s", err)
+		log.Dev.Warningf(ctx, "computing SST stats as estimates because of ComputeSSTStatsDiff error: %s", err)
 		sstStats, err := computeSSTStats(ctx, sst, nowNanos)
 		if err != nil {
 			return enginepb.MVCCStats{}, errors.Wrap(err, "error computing SST stats during fallback")

pkg/server/import_ts.go

@@ -128,15 +128,15 @@ func maybeImportTS(ctx context.Context, s *topLevelServer) (returnErr error) {
 			}
 			storeToNode[roachpb.StoreID(si)] = roachpb.NodeID(ni)
 		}
-		log.Infof(ctx, "Using embedded store-to-node mapping from the tsdump file itself. "+
+		log.Dev.Infof(ctx, "Using embedded store-to-node mapping from the tsdump file itself. "+
 			"Skipped check for explicit store-to-node mapping file.")
 	} else {
 		// Reset file to beginning for subsequent decoding.
 		if _, err := f.Seek(0, io.SeekStart); err != nil {
 			return err
 		}
 		dec = gob.NewDecoder(f)
-		log.Infof(ctx, "Embedded metadata not found in the tsdump file. "+
+		log.Dev.Infof(ctx, "Embedded metadata not found in the tsdump file. "+
 			"Reading from the store-to-node mapping file.")
 
 		// Fallback to explicit YAML mapping file.