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] Documentation update #41459

Open
wants to merge 1 commit into
base: 8.15
Choose a base branch
from
Open

[Filebeat] Documentation update #41459

wants to merge 1 commit into from

Conversation

flexitrev
Copy link

Add information regarding automatic enablement of inputs in external configuration files and correct examples. #17638

Docs

Proposed commit message

Add information regarding automatic enablement of inputs in external configuration files and correct examples. #17638

Details

Responding to recent concerns about external configuration enablement behavior. Correcting documentation for now, until we can prioritize the work to change the behavior and support enablement within external configurations.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

None

How to test this PR locally

N/A

Related issues

Add information regarding automatic enablement of inputs in external configuration files and correct examples. #17638
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 28, 2024
@botelastic
Copy link

botelastic bot commented Oct 28, 2024

This pull request doesn't have a Team:<team> label.

var.paths: [/var/log/apache2/access.log*]
error:
enabled: true
# Enable settings are ignored within external configuration files
Copy link
Contributor

@lucabelluccini lucabelluccini Nov 5, 2024

Choose a reason for hiding this comment

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

Hello @flexitrev

The enabled setting under a specific fileset/metricset under a Module works.
Example: you can enable the Apache access fileset and disable the error one. This works fine.

What is broken in #17638 (comment) is using enabled in the inputs specified in the external file pointed by the path setting within <beat>.config.inputs

Copy link
Contributor

Choose a reason for hiding this comment

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

8.6.1

Filebeat

filebeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: true

  # Period on which files under path should be checked for changes
  reload.period: 10s

Enabled coredns module via filebeat module enable coredns.

Enabling / disabling a single metricset/fileset in coredns.yml works:

Error creating runner from config: could not create module registry for filesets: module coredns is configured but has no enabled filesets

Enabled apache module, then enabled only the access one:

Enabled modules/filesets: apache (access)
Starting runner: apache (access)

Enabled also the error fileset:

Starting runner: apache (access), apache (error)

The problem is restricted to inputs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants