[receiver/chrony] remove duplicate Timeout setting (#26113)

Use the Timeout setting from ScraperHelper instead

---------

Signed-off-by: Alex Boten <[email protected]>

Author: Alex Boten

.chloggen/codeboten_rm-dupe-chrony.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: chronyreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Removes duplicate `Timeout` field. This change has no impact on end users of the component."
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [26113]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

receiver/chronyreceiver/config.go

@@ -26,8 +26,6 @@ type Config struct {
 	//
 	// The default value is unix:///var/run/chrony/chronyd.sock
 	Endpoint string `mapstructure:"endpoint"`
-	// Timeout controls the max time allowed to read data from chronyd
-	Timeout time.Duration `mapstructure:"timeout"`
 }
 
 var (
@@ -37,12 +35,13 @@ var (
 )
 
 func newDefaultCongfig() component.Config {
+	cfg := scraperhelper.NewDefaultScraperControllerSettings(metadata.Type)
+	cfg.Timeout = 10 * time.Second
 	return &Config{
-		ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+		ScraperControllerSettings: cfg,
 		MetricsBuilderConfig:      metadata.DefaultMetricsBuilderConfig(),
 
 		Endpoint: "unix:///var/run/chrony/chronyd.sock",
-		Timeout:  10 * time.Second,
 	}
 }
 

receiver/chronyreceiver/config_test.go

@@ -40,7 +40,6 @@ func TestLoadConfig(t *testing.T) {
 		ScraperControllerSettings: scs,
 		MetricsBuilderConfig:      metadata.DefaultMetricsBuilderConfig(),
 		Endpoint:                  "udp://localhost:3030",
-		Timeout:                   10 * time.Second,
 	}, cfg)
 }
 
@@ -55,54 +54,72 @@ func TestValidate(t *testing.T) {
 		{
 			scenario: "Valid udp configuration",
 			conf: Config{
-				Endpoint:                  "udp://localhost:323",
-				Timeout:                   10 * time.Second,
-				ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+				Endpoint: "udp://localhost:323",
+				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
+					CollectionInterval: time.Minute,
+					InitialDelay:       time.Second,
+					Timeout:            10 * time.Second,
+				},
 			},
 			err: nil,
 		},
 		{
 			scenario: "Invalid udp hostname",
 			conf: Config{
-				Endpoint:                  "udp://:323",
-				Timeout:                   10 * time.Second,
-				ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+				Endpoint: "udp://:323",
+				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
+					CollectionInterval: time.Minute,
+					InitialDelay:       time.Second,
+					Timeout:            10 * time.Second,
+				},
 			},
 			err: chrony.ErrInvalidNetwork,
 		},
 		{
 			scenario: "Invalid udp port",
 			conf: Config{
-				Endpoint:                  "udp://localhost",
-				Timeout:                   10 * time.Second,
-				ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+				Endpoint: "udp://localhost",
+				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
+					CollectionInterval: time.Minute,
+					InitialDelay:       time.Second,
+					Timeout:            10 * time.Second,
+				},
 			},
 			err: chrony.ErrInvalidNetwork,
 		},
 		{
 			scenario: "Valid unix path",
 			conf: Config{
-				Endpoint:                  fmt.Sprintf("unix://%s", t.TempDir()),
-				Timeout:                   10 * time.Second,
-				ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+				Endpoint: fmt.Sprintf("unix://%s", t.TempDir()),
+				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
+					CollectionInterval: time.Minute,
+					InitialDelay:       time.Second,
+					Timeout:            10 * time.Second,
+				},
 			},
 			err: nil,
 		},
 		{
 			scenario: "Invalid unix path",
 			conf: Config{
-				Endpoint:                  "unix:///no/dir/to/socket",
-				Timeout:                   10 * time.Second,
-				ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+				Endpoint: "unix:///no/dir/to/socket",
+				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
+					CollectionInterval: time.Minute,
+					InitialDelay:       time.Second,
+					Timeout:            10 * time.Second,
+				},
 			},
 			err: os.ErrNotExist,
 		},
 		{
 			scenario: "Invalid timeout set",
 			conf: Config{
-				Endpoint:                  "unix://no/dir/to/socket",
-				Timeout:                   0,
-				ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
+				Endpoint: "unix://no/dir/to/socket",
+				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
+					CollectionInterval: time.Minute,
+					InitialDelay:       time.Second,
+					Timeout:            0,
+				},
 			},
 			err: errInvalidValue,
 		},

receiver/chronyreceiver/factory_test.go

@@ -51,10 +51,10 @@ func TestCreatingMetricsReceiver(t *testing.T) {
 		&Config{
 			ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
 				CollectionInterval: 30 * time.Second,
+				Timeout:            10 * time.Second,
 			},
 			MetricsBuilderConfig: mbc,
 			Endpoint:             "udp://localhost:323",
-			Timeout:              10 * time.Second,
 		},
 		consumertest.NewNop(),
 	)