Skip to content
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

Migrate packetbeat config options to namespace #1490

Merged
merged 1 commit into from
Apr 27, 2016
Merged

Conversation

ruflin
Copy link
Contributor

@ruflin ruflin commented Apr 26, 2016

  • Fix docs by adding indentation
  • Remove singleton config

This change is not backward compatible.

Relates to #1417

if pb.PbConfig.Shipper.QueueSize != nil {
queueSize = *pb.PbConfig.Shipper.QueueSize
if cfg.Shipper.QueueSize != nil {
queueSize = *cfg.Shipper.QueueSize
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means that these two options under shipper now are under packetbeat.shipper. Since these settings might be read by both Packetbeat and libbeat, but now they are defined in two parts. We could either leave Shipper top level in config.Config or clean this up to not require Packetbeat reading options from the libbeat sections.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe @urso can comment on whether these two options could be just removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ups, this change was not intended :-( I think I should revert the shipper changes for this PR in any case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the Logging section which is not quite clear to me why it is also declared at Packetbeat level.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@tsg
Copy link
Contributor

tsg commented Apr 26, 2016

Did you try to make it backwards compatible like for Topbeat? Does it complicate the code too much?


# Select the network interfaces to sniff the data. You can use the "any"
# keyword to sniff on all connected interfaces.
interfaces:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it wouldn't be better to write these as:

packetbeat.interfaces:
  device: any

This way, there's no increase in the indentation level, making it easier for people to migrate and for us to review config changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was thinking about the same, see: #1488 (Option 2)

Going with the above would mean doing the same for flows, protocols and and procs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to use the . notation.

@ruflin
Copy link
Contributor Author

ruflin commented Apr 26, 2016

I didn't try the BC change. I think it would be possible to implement it also with BC but makes the code a little bit more complex. My idea was to make it BC in a second step if needed to keep the change smaller.

ports: [80, 8080]
send_response: true
include_body_for: ["text/html"]
protocols:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tsg Thinking if I should also do here packetbeat.protocols instead of changing the indentation. At the same time it "only" describes the protocols part. Same for all other doc parts.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dedemorton WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think packetbeat.protocols is better, because when people copy/paste it's more likely to get it right.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will change it accordingly everywhere.

* Fix docs by adding indentation
* Remove singleton config

Relates to elastic#1417
@tsg tsg mentioned this pull request Apr 27, 2016
14 tasks
@tsg tsg merged commit 9aeac72 into elastic:master Apr 27, 2016
"github.com/elastic/beats/packetbeat/procs"
)

type Config struct {
Packetbeat PacketbeatConfig
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alternatively this could have been written like:

type Config struct {
  Interfaces InterfacesConfig `config:"packetbeat.interfaces"`
  Flows      *Flows           `config:"packetbeat.flows"`
  ...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, I wasn't aware that this would work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants