roachtest: deprecate the cluster monitor

Now that we have the global test monitor and goroutine
management through task.Tasker, we should direct test
writers away from the old monitor.

This changes the name of newMonitor to newDeprecated
monitor as well as adding a deprecated comment.

Author: DarrylWong

pkg/cmd/roachtest/cluster.go

@@ -3027,13 +3027,15 @@ func (c *clusterImpl) Extend(ctx context.Context, d time.Duration, l *logger.Log
 	return nil
 }
 
-// NewMonitor creates a monitor that can watch for unexpected crdb node deaths on m.Wait()
+// NewDeprecatedMonitor creates a monitor that can watch for unexpected crdb node deaths on m.Wait()
 // and provide roachtest safe goroutines.
 //
 // As a general rule, if the user has a workload node, do not monitor it. A
 // monitor's semantics around handling expected node deaths breaks down if it's
 // monitoring a workload node.
-func (c *clusterImpl) NewMonitor(ctx context.Context, opts ...option.Option) cluster.Monitor {
+func (c *clusterImpl) NewDeprecatedMonitor(
+	ctx context.Context, opts ...option.Option,
+) cluster.Monitor {
 	return newMonitor(ctx, c.t, c, false /* expectExactProcessDeath */, opts...)
 }
 

pkg/cmd/roachtest/cluster/cluster_interface.go

@@ -66,7 +66,11 @@ type Cluster interface {
 	Stop(ctx context.Context, l *logger.Logger, stopOpts option.StopOpts, opts ...option.Option)
 	SignalE(ctx context.Context, l *logger.Logger, sig int, opts ...option.Option) error
 	Signal(ctx context.Context, l *logger.Logger, sig int, opts ...option.Option)
-	NewMonitor(context.Context, ...option.Option) Monitor
+
+	// NewDeprecatedMonitor is deprecated: See #118214
+	// Instead, use task.Tasker for goroutine management (e.g. test.Go) and test.Monitor
+	// for monitoring unexpected process deaths (e.g. through the test spec Monitor option)
+	NewDeprecatedMonitor(context.Context, ...option.Option) Monitor
 
 	// Starting virtual clusters.
 

pkg/cmd/roachtest/clusterstats/mock_cluster_generated_test.go

@@ -191,7 +191,7 @@ type TestSpec struct {
 	Randomized bool
 
 	// Monitor specifies whether the test initiates a process monitor. Eventually,
-	// this should replace all instances of `cluster.NewMonitor`. To make this
+	// this should replace all instances of `cluster.NewDeprecatedMonitor`. To make this
 	// transition, tests should be modified to utilize the `test.Monitor` and
 	// `roachtestutil.Task` interfaces provided with each test.
 	Monitor bool

pkg/cmd/roachtest/registry/test_spec.go

@@ -95,7 +95,7 @@ func registerDiskBandwidthOverload(r registry.Registry) {
 
 			// Run foreground kv workload, QoS="regular".
 			duration := 90 * time.Minute
-			m := c.NewMonitor(ctx, c.CRDBNodes())
+			m := c.NewDeprecatedMonitor(ctx, c.CRDBNodes())
 			m.Go(func(ctx context.Context) error {
 				t.Status(fmt.Sprintf("starting foreground kv workload thread (<%s)", time.Minute))
 				dur := " --duration=" + duration.String()

pkg/cmd/roachtest/tests/admission_control_disk_bandwidth_overload.go

@@ -90,7 +90,7 @@ func registerDiskIOPSOverload(r registry.Registry) {
 
 			// Run foreground kv workload, QoS="regular".
 			duration := 90 * time.Minute
-			m := c.NewMonitor(ctx, c.CRDBNodes())
+			m := c.NewDeprecatedMonitor(ctx, c.CRDBNodes())
 			m.Go(func(ctx context.Context) error {
 				t.Status(fmt.Sprintf("starting foreground kv workload thread (<%s)", time.Minute))
 				dur := " --duration=" + duration.String()

pkg/cmd/roachtest/tests/admission_control_disk_iops_overload.go

@@ -80,7 +80,7 @@ func registerElasticControlForBackups(r registry.Registry) {
 					t.Status(fmt.Sprintf("during: enabling admission control (<%s)", 30*time.Second))
 					roachtestutil.SetAdmissionControl(ctx, t, c, true)
 
-					m := c.NewMonitor(ctx, c.CRDBNodes())
+					m := c.NewDeprecatedMonitor(ctx, c.CRDBNodes())
 					m.Go(func(ctx context.Context) error {
 						t.Status(fmt.Sprintf("during: creating full backup schedule to run every 20m (<%s)", time.Minute))
 						bucketPrefix := "gs"

pkg/cmd/roachtest/tests/admission_control_elastic_backup.go

@@ -105,7 +105,7 @@ func registerElasticControlForCDC(r registry.Registry) {
 					stopFeeds(db) // stop stray feeds (from repeated runs against the same cluster for ex.)
 					defer stopFeeds(db)
 
-					m := c.NewMonitor(ctx, c.CRDBNodes())
+					m := c.NewDeprecatedMonitor(ctx, c.CRDBNodes())
 					m.Go(func(ctx context.Context) error {
 						const iters, changefeeds = 5, 10
 						for i := 0; i < iters; i++ {

pkg/cmd/roachtest/tests/admission_control_elastic_cdc.go

@@ -69,7 +69,7 @@ func registerElasticIO(r registry.Registry) {
 			roachtestutil.SetAdmissionControl(ctx, t, c, true)
 			duration := 30 * time.Minute
 			t.Status("running workload")
-			m := c.NewMonitor(ctx, c.CRDBNodes())
+			m := c.NewDeprecatedMonitor(ctx, c.CRDBNodes())
 			labels := map[string]string{
 				"duration":    fmt.Sprintf("%d", duration.Milliseconds()),
 				"concurrency": "512",

pkg/cmd/roachtest/tests/admission_control_elastic_io.go

@@ -110,7 +110,7 @@ func registerElasticWorkloadMixedVersion(r registry.Registry) {
 			}
 			runWorkloads := func(ctx2 context.Context) error {
 				const duration = 5 * time.Minute
-				m := c.NewMonitor(ctx, c.CRDBNodes())
+				m := c.NewDeprecatedMonitor(ctx, c.CRDBNodes())
 				m.Go(func(ctx context.Context) error { return runForeground(ctx, duration) })
 				m.Go(func(ctx context.Context) error { return runBackground(ctx, duration) })
 				return m.WaitE()