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

[Filebeat][proposal] Disable filesets that are not configured #17256

Closed
andrewkroh opened this issue Mar 26, 2020 · 6 comments · Fixed by #27526 or #27762
Closed

[Filebeat][proposal] Disable filesets that are not configured #17256

andrewkroh opened this issue Mar 26, 2020 · 6 comments · Fixed by #27526 or #27762
Assignees
Labels
discuss Issue needs further discussion. Filebeat Filebeat Team:Elastic-Agent Label for the Agent team Team:Integrations Label for the Integrations team [zube]: Team Triage

Comments

@andrewkroh
Copy link
Member

The default behavior for Filebeat modules is that all filesets are enabled by default. This puts a burden on users of modules when they upgrade versions. When a new fileset is added this is a breaking change to the end-user because they must take some action to change their configuration in order maintain the same behavior.

For example, when we add a new fileset to AWS module the end-user must add the new fileset to the configuration file just to disable it. If they don't then they will end up with errors because configuration is required for the new fileset to function.

A similar problem also manifests itself to users of the CLI when trying to enable particular filesets of a module. They get all filesets enabled by default. If they want to enable a subset of filesets they must use a wildcard option (that's undocumented AFAIK) -M aws.*.enabled=false.

My proposal is to change the default behavior of filesets to disabled by default when they do not appear in the configuration.

@andrewkroh andrewkroh added discuss Issue needs further discussion. Filebeat Filebeat labels Mar 26, 2020
@kaiyan-sheng
Copy link
Contributor

I agree, right now when user trying to run Filebeat with only cloudtrail fileset enabled, the config file looks like this:

filebeat.modules:
- module: aws
  cloudtrail:
    enabled: true
    var.queue_url: https://sqs.us-east-1.amazonaws.com/428152502467/test-fb-ks
    var.credential_profile_name: elastic-beats
    var.visibility_timeout: 300s
    var.endpoint: amazonaws.com
  elb.enabled: false
  s3access.enabled: false
  vpcflow.enabled: false

output.elasticsearch:
  hosts: ["localhost:9200"]

@kaiyan-sheng kaiyan-sheng added the Team:Integrations Label for the Integrations team label Mar 26, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations (Team:Integrations)

@exekias
Copy link
Contributor

exekias commented Mar 27, 2020

+1 on doing this, filesets requiring special settings should be manually enabled to avoid errors and wasting cpu cycles

@exekias
Copy link
Contributor

exekias commented Mar 27, 2020

btw this is a breaking change, right? How do you feel about how it will affect existing deployments?

@narph
Copy link
Contributor

narph commented Feb 22, 2021

+1 , we are seeing issues with this behavior as well in azure, has this gotten any traction so far?

@elasticmachine
Copy link
Collaborator

Pinging @elastic/agent (Team:Agent)

@urso urso self-assigned this Feb 25, 2021
@adriansr adriansr self-assigned this Aug 10, 2021
adriansr added a commit to adriansr/beats that referenced this issue Sep 6, 2021
This changes fileset loading so that only filesets that are explicitly
defined in the configuration are enabled.

Until now, an enabled module will have all its filesets enabled unless
explicitly disabled, which makes for a bad user experience with modules
that contain a lot of filesets.

Closes elastic#17256
adriansr added a commit that referenced this issue Sep 15, 2021
This changes fileset loading so that only filesets that are explicitly
defined in the configuration are enabled.

Until now, an enabled module will have all its filesets enabled unless
explicitly disabled, which makes for a bad user experience with modules
that contain a lot of filesets.

Closes #17256
@adriansr adriansr mentioned this issue Sep 27, 2021
19 tasks
Icedroid pushed a commit to Icedroid/beats that referenced this issue Nov 1, 2021
…c#27526)

This changes fileset loading so that only filesets that are explicitly
defined in the configuration are enabled.

Until now, an enabled module will have all its filesets enabled unless
explicitly disabled, which makes for a bad user experience with modules
that contain a lot of filesets.

Closes elastic#17256
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issue needs further discussion. Filebeat Filebeat Team:Elastic-Agent Label for the Agent team Team:Integrations Label for the Integrations team [zube]: Team Triage
Projects
None yet
9 participants