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

Deprecate config_dir (Filebeat) and refactor docs #5321

Merged
merged 2 commits into from
Oct 5, 2017

Conversation

tsg
Copy link
Contributor

@tsg tsg commented Oct 4, 2017

This deprecates the config_dir option in Filebeat, as it's functionality is
covered by filebeat.config.prospectors. There's a bigger refactoring in the
docs, to reflect that the filebeat.config.* and metricbeat.config.* options
can be used for both including external files and live reloading. Only the
live reloading part stays in Beta, including external config files is GA.

Part of #4581.

@tsg tsg added review v6.0.0-rc2 needs_backport PR is waiting to be backported to other branches. labels Oct 4, 2017
This deprecates the config_dir option in Filebeat, as it's functionality is
covered by `filebeat.config.prospectors`. There's a bigger refactoring in the
docs, to reflect that the `filebeat.config.*` and `metricbeat.config.*` options
can be used for both including external files and live reloading. Only the
live reloading part stays in Beta, including external config files is GA.

Part of elastic#4581.
@tsg tsg force-pushed the deprecate_config_dir branch from fa77c15 to 764a1a4 Compare October 4, 2017 15:32
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

A couple of small changes. Otherwise, LGTM.


To enable dynamic config reloading, you specify the following options under
Filebeat can load external configuration files for prospectors and modules,
which allows you to separate your configuration in multiple smaller
Copy link
Contributor

Choose a reason for hiding this comment

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

Change "separate your configuration in multiple smaller" to "separate your configuration into multiple smaller"

To enable dynamic config reloading, you specify the following options under
Filebeat can load external configuration files for prospectors and modules,
which allows you to separate your configuration in multiple smaller
configuration files. To use this functionality, use the `path` option from the
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 we really need to mention the options here since we describe them more completely later. Might actually be a bit confusing.

Maybe just add links to the sections that follow and say:

To use this functionality, specify the path option when you configure the <<reload-prospector-config,prospector>> or <<reload-module-config,module>>.

BTW, I would probably rename the anchors to load-prospector-config and load-module-config.

@ruflin ruflin merged commit 396cff7 into elastic:master Oct 5, 2017
tsg added a commit to tsg/beats that referenced this pull request Oct 5, 2017
This deprecates the config_dir option in Filebeat, as it's functionality is
covered by `filebeat.config.prospectors`. There's a bigger refactoring in the
docs, to reflect that the `filebeat.config.*` and `metricbeat.config.*` options
can be used for both including external files and live reloading. Only the
live reloading part stays in Beta, including external config files is GA.

Part of elastic#4581.

(cherry picked from commit 396cff7)
@tsg tsg removed the needs_backport PR is waiting to be backported to other branches. label Oct 5, 2017
ruflin pushed a commit that referenced this pull request Oct 5, 2017
This deprecates the config_dir option in Filebeat, as it's functionality is
covered by `filebeat.config.prospectors`. There's a bigger refactoring in the
docs, to reflect that the `filebeat.config.*` and `metricbeat.config.*` options
can be used for both including external files and live reloading. Only the
live reloading part stays in Beta, including external config files is GA.

Part of #4581.

(cherry picked from commit 396cff7)
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…stic#5331)

This deprecates the config_dir option in Filebeat, as it's functionality is
covered by `filebeat.config.prospectors`. There's a bigger refactoring in the
docs, to reflect that the `filebeat.config.*` and `metricbeat.config.*` options
can be used for both including external files and live reloading. Only the
live reloading part stays in Beta, including external config files is GA.

Part of elastic#4581.

(cherry picked from commit 9af1d5c)
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