-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Added short versions for the configuration files #1637
Conversation
Part of #1417. |
# Some sample encodings: | ||
# plain, utf-8, utf-16be-bom, utf-16be, utf-16le, big5, gb18030, gbk, | ||
# hz-gb-2312, euc-kr, euc-jp, iso-2022-jp, shift-jis, ... | ||
encoding: plain |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would leave out encoding
LGTM. +1 on moving forward with this. We can still make small adjustments later if needed. Two things for the naming:
The above notes unfortunately conflict with each other :-) My suggestion is to not have the short version in the the top level folder, only under _beat or etc. During building the |
alternative name for I think these very big comments make the minified version still to verbose. Let's try to have at most 1 or 2 lines commenting an option. Maybe with second line being a link to the docs (like we include link to doc reference at top of file, but it's so easily overlooked) |
I like the 2 lines suggestion by @urso with the docs. |
I did the 2 comment lines suggestion (but not the link to the docs, that would be quite an effort to maintain) and removed some more stuff as suggested by @ruflin. Let's discuss the rest in the meeting. |
Why not just name the short one |
4d84f97
to
a38e468
Compare
Added logging to the short version. I prefer doing the file rename in a follow up PR, so this is ready for merging unless more comments show up or the build fails. |
LGTM |
For now, the short files are named like `beatname.short.yml` and I kept the `beatname.yml` to be the full one. The intention is to switch them around. The short ones to become the default and the long ones to be something like `beatname.full.yml` or similar. But before doing that I wanted the others in the team to have a look. The decision of what to include in the short version is fairly arbitrary, I just did it based on what I thought makes most sense. I kept the ES and LS outputs in the configuration file. I considered having only ES for all the beats except Filebeat, but that would complicate the generation part and I think it's nice to highlight that we support multiple outputs.
a38e468
to
9abac74
Compare
For now, the short files are named like
beatname.short.yml
and I kept thebeatname.yml
to be the full one. The intention is to switch them around. Theshort ones to become the default and the long ones to be something like
beatname.full.yml
or similar.But before doing that I wanted the others in the team to have a look. The
decision of what to include in the short version is fairly arbitrary, I just
did it based on what I thought makes most sense.
I kept the ES and LS outputs in the configuration file. I considered having
only ES for all the beats except Filebeat, but that would complicate the
generation part and I think it's nice to highlight that we support multiple
outputs.