refactor filebeat and metric module namespace (#40660)

makes it possible to configure filebeat and metricbeat so the module namespaces don't collide. This is necessary so you can have filebeat and metricbeat in the same process.
elastic · Aug 30, 2024 · 2f9345f · 2f9345f
1 parent a3db002
commit 2f9345f
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 14 deletions.
diff --git a/filebeat/cmd/root.go b/filebeat/cmd/root.go
@@ -40,8 +40,13 @@ const Name = "filebeat"
 // RootCmd to handle beats cli
 var RootCmd *cmd.BeatsRootCmd
 
-// FilebeatSettings contains the default settings for filebeat
-func FilebeatSettings() instance.Settings {
+// FilebeatSettings contains the default settings for filebeat.
+// moduleNameSpace allows you to override the default setting of
+// "module" for the module metrics to avoid name collisions.
+func FilebeatSettings(moduleNameSpace string) instance.Settings {
+	if moduleNameSpace == "" {
+		moduleNameSpace = "module"
+	}
 	runFlags := pflag.NewFlagSet(Name, pflag.ExitOnError)
 	runFlags.AddGoFlag(flag.CommandLine.Lookup("once"))
 	runFlags.AddGoFlag(flag.CommandLine.Lookup("modules"))
@@ -51,7 +56,7 @@ func FilebeatSettings() instance.Settings {
 		HasDashboards: true,
 		Initialize: []func(){
 			include.InitializeModule,
-			fileset.RegisterMonitoringModules,
+			func() { fileset.RegisterMonitoringModules(moduleNameSpace) },
 			input.RegisterMonitoringInputs,
 		},
 	}

diff --git a/filebeat/fileset/factory.go b/filebeat/fileset/factory.go
@@ -37,9 +37,9 @@ var moduleList = monitoring.NewUniqueList()
 var moduleListMetricsOnce sync.Once
 
 // RegisterMonitoringModules registers the modules list with the monitoring system.
-func RegisterMonitoringModules() {
+func RegisterMonitoringModules(namespace string) {
 	moduleListMetricsOnce.Do(func() {
-		monitoring.NewFunc(monitoring.GetNamespace("state").GetRegistry(), "module", moduleList.Report, monitoring.Report)
+		monitoring.NewFunc(monitoring.GetNamespace("state").GetRegistry(), namespace, moduleList.Report, monitoring.Report)
 	})
 }
 

diff --git a/filebeat/main.go b/filebeat/main.go
@@ -34,7 +34,7 @@ import (
 // Finally, input uses the registrar information, on restart, to
 // determine where in each file to restart a harvester.
 func main() {
-	if err := cmd.Filebeat(inputs.Init, cmd.FilebeatSettings()).Execute(); err != nil {
+	if err := cmd.Filebeat(inputs.Init, cmd.FilebeatSettings("")).Execute(); err != nil {
 		os.Exit(1)
 	}
 }
diff --git a/filebeat/main_test.go b/filebeat/main_test.go
@@ -38,7 +38,7 @@ var (
 func init() {
 	testing.Init()
 	systemTest = flag.Bool("systemTest", false, "Set to true when running system tests")
-	fbCommand = fbcmd.Filebeat(inputs.Init, fbcmd.FilebeatSettings())
+	fbCommand = fbcmd.Filebeat(inputs.Init, fbcmd.FilebeatSettings(""))
 	fbCommand.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("systemTest"))
 	fbCommand.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("test.coverprofile"))
 }

diff --git a/metricbeat/cmd/root.go b/metricbeat/cmd/root.go
@@ -53,7 +53,12 @@ var withECSVersion = processing.WithFields(mapstr.M{
 })
 
 // MetricbeatSettings contains the default settings for metricbeat
-func MetricbeatSettings() instance.Settings {
+// moduleNameSpace allows you to override the default setting of
+// "module" for the module metrics to avoid name collisions.
+func MetricbeatSettings(moduleNameSpace string) instance.Settings {
+	if moduleNameSpace == "" {
+		moduleNameSpace = "module"
+	}
 	var runFlags = pflag.NewFlagSet(Name, pflag.ExitOnError)
 	runFlags.AddGoFlag(flag.CommandLine.Lookup("system.hostfs"))
 	return instance.Settings{
@@ -63,7 +68,7 @@ func MetricbeatSettings() instance.Settings {
 		Processing:    processing.MakeDefaultSupport(true, nil, withECSVersion, processing.WithHost, processing.WithAgentMeta()),
 		Initialize: []func(){
 			include.InitializeModule,
-			module.RegisterMonitoringModules,
+			func() { module.RegisterMonitoringModules(moduleNameSpace) },
 		},
 	}
 }
@@ -77,5 +82,5 @@ func Initialize(settings instance.Settings) *cmd.BeatsRootCmd {
 }
 
 func init() {
-	RootCmd = Initialize(MetricbeatSettings())
+	RootCmd = Initialize(MetricbeatSettings(""))
 }
diff --git a/metricbeat/mb/module/runner.go b/metricbeat/mb/module/runner.go
@@ -33,9 +33,9 @@ var moduleList = monitoring.NewUniqueList()
 var moduleListMetricsOnce sync.Once
 
 // RegisterMonitoringModules registers the modules list with the monitoring system.
-func RegisterMonitoringModules() {
+func RegisterMonitoringModules(namespace string) {
 	moduleListMetricsOnce.Do(func() {
-		monitoring.NewFunc(monitoring.GetNamespace("state").GetRegistry(), "module", moduleList.Report, monitoring.Report)
+		monitoring.NewFunc(monitoring.GetNamespace("state").GetRegistry(), namespace, moduleList.Report, monitoring.Report)
 	})
 }
 

diff --git a/x-pack/filebeat/cmd/root.go b/x-pack/filebeat/cmd/root.go
@@ -28,7 +28,7 @@ const Name = fbcmd.Name
 
 // Filebeat build the beat root command for executing filebeat and it's subcommands.
 func Filebeat() *cmd.BeatsRootCmd {
-	settings := fbcmd.FilebeatSettings()
+	settings := fbcmd.FilebeatSettings("")
 	globalProcs, err := processors.NewPluginConfigFromList(defaultProcessors())
 	if err != nil { // these are hard-coded, shouldn't fail
 		panic(fmt.Errorf("error creating global processors: %w", err))

diff --git a/x-pack/metricbeat/cmd/root.go b/x-pack/metricbeat/cmd/root.go
@@ -48,7 +48,7 @@ func init() {
 	if err != nil { // these are hard-coded, shouldn't fail
 		panic(fmt.Errorf("error creating global processors: %w", err))
 	}
-	settings := mbcmd.MetricbeatSettings()
+	settings := mbcmd.MetricbeatSettings("")
 	settings.ElasticLicensed = true
 	settings.Processing = processing.MakeDefaultSupport(true, globalProcs, withECSVersion, processing.WithHost, processing.WithAgentMeta())
 	RootCmd = cmd.GenRootCmdWithSettings(beater.DefaultCreator(), settings)