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

Configuration files restyling #1624

Merged
merged 3 commits into from
May 12, 2016
Merged

Conversation

tsg
Copy link
Contributor

@tsg tsg commented May 12, 2016

Little changes content wise, but some style changes:

  • Use ###, ===, and --- headers to indicate hierarchy. This makes it
    easier to skim the config file. Idea stolen from elasticsearch.yml
  • Unindent filebeat prospectors and metricbeat modules by one level.
    This is still valid yaml, and fewer spaces make it harder to mess up the
    white spaces.
  • Reorganized a bit the logging config
  • Moved the "general" libbeat section before the outputs
  • Other fairly minor changes to the beats yaml files.

This is a follow up of #1544 and part of #1417.

Little changes content wise, but some style changes:

* Use ###, ===, and --- headers to indicate hierarchy. This makes it
  easier to skim the config file. Idea stolen from elasticsearch.yml
* Unindent filebeat prospectors and metricbeat modules by one level.
  This is still valid yaml, and fewer spaces make it harder to mess up the
  white spaces.
* Reorganized a bit the logging config
* Moved the "general" libbeat section before the outputs
* Other fairly minor changes to the beats yaml files.

This is a follow up of elastic#1544 and part of elastic#1417.
@tsg tsg added the review label May 12, 2016
@tsg
Copy link
Contributor Author

tsg commented May 12, 2016

These are the "full" config files. Creating the "short" ones (which will also become the defaults) will come in a future PR.

@tsg tsg mentioned this pull request May 12, 2016
14 tasks
@@ -1,192 +1,189 @@
################### Filebeat Configuration Example #########################
###################### Filebeat Configuration Example #########################
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps we can remove the example part and use "Example" for the short one then.

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 will do that in the PR adding the short ones, because I'm thinking the full and short should have a header mentioning the other option.

@ruflin
Copy link
Contributor

ruflin commented May 12, 2016

LGTM. See notes. I like the new styling with the headers.

@tsg
Copy link
Contributor Author

tsg commented May 12, 2016

Comments should be addressed.

@@ -1,4 +1,4 @@
# Apache Module
#----------------------------- Apache Module ----------------------------------
Copy link
Contributor

Choose a reason for hiding this comment

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

I hope to auto generate this line in the future based on a name entry in fields.yml.

@ruflin
Copy link
Contributor

ruflin commented May 12, 2016

LGTM. We should probably review all the docs after we finished all the changes.

@tsg
Copy link
Contributor Author

tsg commented May 12, 2016

@ruflin good point, I added that to the meta issue (#1417)

@ruflin ruflin merged commit 2180852 into elastic:master May 12, 2016
@tsg tsg deleted the config_files_styling branch August 25, 2016 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants