-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[filebeat] Add a configuration option for TCP/UDP network type #40623
[filebeat] Add a configuration option for TCP/UDP network type #40623
Conversation
Pinging @elastic/sec-deployment-and-devices (Team:Security-Deployment and Devices) |
This pull request does not have a backport label.
To fixup this pull request, you need to add the backport labels for the needed
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGMT! ty @aleksmaus
Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane) |
@@ -85,3 +86,10 @@ func (s *Server) createServer() (net.Listener, error) { | |||
} | |||
return l, nil | |||
} | |||
|
|||
func (s *Server) network() string { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is style/consistenty comment. I'm ok if you leave it as is, just want to bring it up to consider.
A common theme in the beats code base for default values is to make a defaultConfig function, that returns the struct with the default value filled in. And then when Unpack is run, if the supplied config didn't have the value, you get the default. And validate can work on the real values you want to check. An example would be:
beats/filebeat/input/tcp/input.go
Lines 50 to 67 in 6d25d46
func configure(cfg *conf.C) (stateless.Input, error) { | |
config := defaultConfig() | |
if err := cfg.Unpack(&config); err != nil { | |
return nil, err | |
} | |
return newServer(config) | |
} | |
func defaultConfig() config { | |
return config{ | |
Config: tcp.Config{ | |
Timeout: time.Minute * 5, | |
MaxMessageSize: 20 * humanize.MiByte, | |
}, | |
LineDelimiter: "\n", | |
} | |
} |
what do you think about using that pattern here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I saw this pattern, was not sure if that is consistent across the board and if nobody is going to ask why we do set the configuration option when it's was not set.
One example:
https://github.com/elastic/beats/blob/main/filebeat/inputsource/udp/server_test.go#L62
The original ticket requirement was:
"When no option is provided, the default value (udp or tcp) is used"
So, took it literally in this case: not changing the config, and using the default network type "When no option is provided". I'd probably still leave this network()
function at the point when the server is created in case if the config value gets messed up on a way to the server initialization.
Proposed commit message
Add a configuration option for TCP/UDP network type.
Description below is copied from the ticket #40407:
The TCP input would accept these values for the network type:
tcp
(default)tcp4
tcp6
The UDP input would accept these values for the network type:
udp
(default)udp4
udp6
Examples
Checklist
CHANGELOG.next.asciidoc
orCHANGELOG-developer.next.asciidoc
.Related issues
Screenshots