[workloadmeta] create SBOM global scanner in the InitHelper so its av…

…ailable to wm (#21034) [workloadmeta] pass expected context to InitHelper + cleanup
DataDog · Nov 23, 2023 · 8c628de · 8c628de
1 parent f432302
commit 8c628de
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 20 deletions.
diff --git a/cmd/agent/common/loader.go b/cmd/agent/common/loader.go
@@ -46,6 +46,15 @@ func GetWorkloadmetaInit() workloadmeta.InitHelper {
 			t = local.NewTagger(wm)
 		}
 
+		// SBOM scanner needs to be called here as initialization is required prior to the
+		// catalog getting instantiated and initialized.
+		sbomScanner, err := scanner.CreateGlobalScanner(config.Datadog)
+		if err != nil {
+			log.Errorf("failed to create SBOM scanner: %s", err)
+		} else if sbomScanner != nil {
+			sbomScanner.Start(ctx)
+		}
+
 		tagger.SetDefaultTagger(t)
 		if err := tagger.Init(ctx); err != nil {
 			e = fmt.Errorf("failed to start the tagger: %s", err)
@@ -57,7 +66,7 @@ func GetWorkloadmetaInit() workloadmeta.InitHelper {
 
 // LoadComponents configures several common Agent components:
 // tagger, collector, scheduler and autodiscovery
-func LoadComponents(ctx context.Context, senderManager sender.SenderManager, secretResolver secrets.Component, confdPath string) {
+func LoadComponents(senderManager sender.SenderManager, secretResolver secrets.Component, confdPath string) {
 
 	confSearchPaths := []string{
 		confdPath,
@@ -74,13 +83,6 @@ func LoadComponents(ctx context.Context, senderManager sender.SenderManager, sec
 	// because of subscription to metadata store.
 	AC = setupAutoDiscovery(confSearchPaths, scheduler.NewMetaScheduler(), secretResolver)
 
-	sbomScanner, err := scanner.CreateGlobalScanner(config.Datadog)
-	if err != nil {
-		log.Errorf("failed to create SBOM scanner: %s", err)
-	} else if sbomScanner != nil {
-		sbomScanner.Start(ctx)
-	}
-
 	// create the Collector instance and start all the components
 	// NOTICE: this will also setup the Python environment, if available
 	Coll = collector.NewCollector(senderManager, GetPythonPaths()...)

diff --git a/cmd/agent/subcommands/jmx/command.go b/cmd/agent/subcommands/jmx/command.go
@@ -254,7 +254,7 @@ func runJmxCommandConsole(config config.Component, cliParams *cliParams, wmeta w
 	}
 	// The Autoconfig instance setup happens in the workloadmeta start hook
 	// create and setup the Collector and others.
-	common.LoadComponents(context.Background(), senderManager, secretResolver, config.GetString("confd_path"))
+	common.LoadComponents(senderManager, secretResolver, config.GetString("confd_path"))
 	common.AC.LoadAndRun(context.Background())
 
 	// Create the CheckScheduler, but do not attach it to

diff --git a/cmd/agent/subcommands/run/command.go b/cmd/agent/subcommands/run/command.go
@@ -327,11 +327,9 @@ func getSharedFxOption() fx.Option {
 		fx.Invoke(func(lc fx.Lifecycle, demultiplexer demultiplexer.Component, _ workloadmeta.Component, secretResolver secrets.Component) {
 			lc.Append(fx.Hook{
 				OnStart: func(ctx context.Context) error {
-					// Main context passed to components
-					mainCtx, _ := pkgcommon.GetMainCtxCancel()
 
 					// create and setup the Autoconfig instance
-					common.LoadComponents(mainCtx, demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
+					common.LoadComponents(demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
 					return nil
 				},
 				OnStop: func(ctx context.Context) error {

diff --git a/cmd/cluster-agent-cloudfoundry/subcommands/run/command.go b/cmd/cluster-agent-cloudfoundry/subcommands/run/command.go
@@ -133,7 +133,7 @@ func run(log log.Component, demultiplexer demultiplexer.Component, wmeta workloa
 	// create and setup the Autoconfig instance
 	// The Autoconfig instance setup happens in the workloadmeta start hook
 	// create and setup the Collector and others.
-	common.LoadComponents(mainCtx, demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
+	common.LoadComponents(demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
 
 	// Set up check collector
 	common.AC.AddScheduler("check", collector.InitCheckScheduler(common.Coll, demultiplexer), true)

diff --git a/cmd/cluster-agent/subcommands/start/command.go b/cmd/cluster-agent/subcommands/start/command.go
@@ -258,7 +258,7 @@ func start(log log.Component, config config.Component, telemetry telemetry.Compo
 	// create and setup the Autoconfig instance
 	// The Autoconfig instance setup happens in the workloadmeta start hook
 	// create and setup the Collector and others.
-	common.LoadComponents(mainCtx, demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
+	common.LoadComponents(demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
 
 	// Set up check collector
 	common.AC.AddScheduler("check", collector.InitCheckScheduler(common.Coll, demultiplexer), true)

diff --git a/comp/core/workloadmeta/workloadmeta.go b/comp/core/workloadmeta/workloadmeta.go
@@ -83,16 +83,18 @@ func newWorkloadMeta(deps dependencies) Component {
 
 		var err error
 
+		// Main context passed to components
+		// TODO(components): this mainCtx should probably be replaced by the
+		//                   context provided to the OnStart hook.
+		mainCtx, _ := common.GetMainCtxCancel()
+
 		// create and setup the Autoconfig instance
 		if deps.Params.InitHelper != nil {
-			err = deps.Params.InitHelper(c, wm)
+			err = deps.Params.InitHelper(mainCtx, wm)
 			if err != nil {
 				return err
 			}
 		}
-
-		// Main context passed to components
-		mainCtx, _ := common.GetMainCtxCancel()
 		wm.Start(mainCtx)
 		return nil
 	}})

diff --git a/pkg/cli/subcommands/check/command.go b/pkg/cli/subcommands/check/command.go
@@ -205,7 +205,7 @@ func run(config config.Component, cliParams *cliParams, demultiplexer demultiple
 		return nil
 	}
 
-	common.LoadComponents(context.Background(), demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
+	common.LoadComponents(demultiplexer, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
 	common.AC.LoadAndRun(context.Background())
 
 	// Create the CheckScheduler, but do not attach it to

diff --git a/pkg/diagnose/check.go b/pkg/diagnose/check.go
@@ -109,7 +109,7 @@ func diagnoseChecksInCLIProcess(diagCfg diagnosis.Config, senderManager diagnose
 	secretResolver := secretsimpl.GetInstance()
 
 	// Initializing the aggregator with a flush interval of 0 (to disable the flush goroutines)
-	common.LoadComponents(context.Background(), senderManagerInstance, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
+	common.LoadComponents(senderManagerInstance, secretResolver, pkgconfig.Datadog.GetString("confd_path"))
 	common.AC.LoadAndRun(context.Background())
 
 	// Create the CheckScheduler, but do not attach it to