Rename flag variable

influxdata · Dec 10, 2024 · c885748 · c885748
1 parent f1d9d12
commit c885748
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 39 deletions.
diff --git a/cmd/telegraf/main.go b/cmd/telegraf/main.go
@@ -224,23 +224,23 @@ func runApp(args []string, outputBuffer io.Writer, pprof Server, c TelegrafConfi
 		filters := processFilterFlags(cCtx)
 
 		g := GlobalFlags{
-			config:                 cCtx.StringSlice("config"),
-			configDir:              cCtx.StringSlice("config-directory"),
-			testWait:               cCtx.Int("test-wait"),
-			configURLRetryAttempts: cCtx.Int("config-url-retry-attempts"),
-			configURLWatchInterval: cCtx.Duration("config-url-watch-interval"),
-			watchConfig:            cCtx.String("watch-config"),
-			watchInterval:          cCtx.Duration("watch-interval"),
-			pidFile:                cCtx.String("pidfile"),
-			plugindDir:             cCtx.String("plugin-directory"),
-			password:               cCtx.String("password"),
-			oldEnvBehavior:         cCtx.Bool("old-env-behavior"),
-			newPluginPrintBehavior: cCtx.Bool("new-plugin-print-behavior"),
-			test:                   cCtx.Bool("test"),
-			debug:                  cCtx.Bool("debug"),
-			once:                   cCtx.Bool("once"),
-			quiet:                  cCtx.Bool("quiet"),
-			unprotected:            cCtx.Bool("unprotected"),
+			config:                  cCtx.StringSlice("config"),
+			configDir:               cCtx.StringSlice("config-directory"),
+			testWait:                cCtx.Int("test-wait"),
+			configURLRetryAttempts:  cCtx.Int("config-url-retry-attempts"),
+			configURLWatchInterval:  cCtx.Duration("config-url-watch-interval"),
+			watchConfig:             cCtx.String("watch-config"),
+			watchInterval:           cCtx.Duration("watch-interval"),
+			pidFile:                 cCtx.String("pidfile"),
+			plugindDir:              cCtx.String("plugin-directory"),
+			password:                cCtx.String("password"),
+			oldEnvBehavior:          cCtx.Bool("old-env-behavior"),
+			printPluginConfigSource: cCtx.Bool("print-plugin-config-source"),
+			test:                    cCtx.Bool("test"),
+			debug:                   cCtx.Bool("debug"),
+			once:                    cCtx.Bool("once"),
+			quiet:                   cCtx.Bool("quiet"),
+			unprotected:             cCtx.Bool("unprotected"),
 		}
 
 		w := WindowFlags{
@@ -310,8 +310,8 @@ func runApp(args []string, outputBuffer io.Writer, pprof Server, c TelegrafConfi
 					Usage: "switch back to pre v1.27 environment replacement behavior",
 				},
 				&cli.BoolFlag{
-					Name:  "new-plugin-print-behavior",
-					Usage: "switch to the new plugin print behavior",
+					Name:  "print-plugin-config-source",
+					Usage: "print the source for a given plugin",
 				},
 				&cli.BoolFlag{
 					Name:  "once",

diff --git a/cmd/telegraf/telegraf.go b/cmd/telegraf/telegraf.go
@@ -34,23 +34,23 @@ import (
 var stop chan struct{}
 
 type GlobalFlags struct {
-	config                 []string
-	configDir              []string
-	testWait               int
-	configURLRetryAttempts int
-	configURLWatchInterval time.Duration
-	watchConfig            string
-	watchInterval          time.Duration
-	pidFile                string
-	plugindDir             string
-	password               string
-	oldEnvBehavior         bool
-	newPluginPrintBehavior bool
-	test                   bool
-	debug                  bool
-	once                   bool
-	quiet                  bool
-	unprotected            bool
+	config                  []string
+	configDir               []string
+	testWait                int
+	configURLRetryAttempts  int
+	configURLWatchInterval  time.Duration
+	watchConfig             string
+	watchInterval           time.Duration
+	pidFile                 string
+	plugindDir              string
+	password                string
+	oldEnvBehavior          bool
+	printPluginConfigSource bool
+	test                    bool
+	debug                   bool
+	once                    bool
+	quiet                   bool
+	unprotected             bool
 }
 
 type WindowFlags struct {
@@ -107,7 +107,7 @@ func (t *Telegraf) Init(pprofErr <-chan error, f Filters, g GlobalFlags, w Windo
 	// Set environment replacement behavior
 	config.OldEnvVarReplacement = g.oldEnvBehavior
 
-	config.NewPluginPrintBehaviour = g.newPluginPrintBehavior
+	config.PrintPluginConfigSource = g.printPluginConfigSource
 }
 
 func (t *Telegraf) ListSecretStores() ([]string, error) {

diff --git a/config/config.go b/config/config.go
@@ -53,7 +53,8 @@ var (
 	// environment variable replacement behavior
 	OldEnvVarReplacement = false
 
-	NewPluginPrintBehaviour = false
+	// PrintPluginConfigSource is a switch to enable printing of plugin sources
+	PrintPluginConfigSource = false
 
 	// Password specified via command-line
 	Password Secret
@@ -307,7 +308,7 @@ type AgentConfig struct {
 // based on the NewPluginPrintBehaviour flag
 func getPluginPrintString(plugins pluginNames) string {
 	output := PluginNameCounts(plugins)
-	if NewPluginPrintBehaviour {
+	if PrintPluginConfigSource {
 		return output + plugins.String()
 	}