[receiver/snmpreceiver] make timeout configureable #26070
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The timeout of snmp requests was hard coded to 5 seconds. This commit adds timeout to the configuration of this receiver. The timeout can now be set using the timeout key at the higest level in the configuration. The default is left at 5 seconds.
dmitryax
reviewed
Aug 23, 2023
receiver/snmpreceiver/config.go
Outdated
| @@ -76,6 +77,10 @@ type Config struct { | |||
| // If no port is given, 161 is assumed. | |||
| Endpoint string `mapstructure:"endpoint"` | |||
|
|
|||
| // Timeout for each SNMP request. | |||
| // Default: 5 seconds | |||
| Timeout time.Duration `mapstructure:"timeout"` | |||
There was a problem hiding this comment.
ScraperControllerSettings already has Timeout option for this purposes, let's reuse it
There was a problem hiding this comment.
I've moved the Timeout setting to ScraperControllerSettings.
djaglowski
approved these changes
Aug 28, 2023
atoulme
approved these changes
Aug 28, 2023
dmitryax
approved these changes
Aug 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
The timeout of snmp requests was hard coded to 5 seconds. This commit adds timeout to the configuration of this receiver. The timeout can now be set using the timeout key at the higest level in the configuration. The default is left at 5 seconds.
Link to tracking Issue:
#25885
Testing:
Updated
TestNewFactorymethod to reflect new default config.Ran receiver against devices demanding a high timeout. During testing added extra logging statements to check if timeout setting was propagated correctly to the underlying SNMP library and if it was reflected in the SNMP commands executed. Tests succeeded. Removed extra logging statements as we shouldn't create a log per datapoint received in production.
Documentation:
Added the new config option
timeoutto README.