Make adding the hostname to the event optional #340
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robbavey
force-pushed
the
host_deprecate
branch
2 times, most recently
from
a887c01
to
674d6e5
Compare
Add `add_hostname` flag - when enabled, the `host` field will be populated by the value supplied by the beat in the `hostname` field if that field is present. The flag defaults to true to retain backwards compatibility with earlier versions of the beats input. The field is intentionally added as a deprecated field - auto populating the `host` field in this way will be removed in future versions of the beats input.
danhermann
reviewed
Jul 23, 2018
| @@ -82,6 +82,10 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base | |||
| # | |||
| config :ssl_certificate_authorities, :validate => :array, :default => [] | |||
|
|
|||
| # Flag to determine whether to add host information (provided by the beat in the 'hostname' field) to the event | |||
| config :add_hostname, :validate => :boolean, :default => true, :deprecated => 'Host field will not be automatically populated by future version of the Beats input' | |||
There was a problem hiding this comment.
Doesn't the default value of true conflict with the documented default value?
There was a problem hiding this comment.
Gah, you're right. Good catch, will change
And changelog update.
|
@karenzone Would you mind checking the doc changes? |
karenzone
reviewed
Jul 23, 2018
docs/index.asciidoc
Outdated
| [id="plugins-{type}s-{plugin}-add_hostname"] | ||
| ===== `add_hostname` | ||
|
|
||
| added[5.2.0, Field was added to allow users to not automatically add the `host` field in events.] |
There was a problem hiding this comment.
What about "Field was added to allow users to control whether or not the host field is automatically added to events."
docs/index.asciidoc
Outdated
| ===== `add_hostname` | ||
|
|
||
| added[5.2.0, Field was added to allow users to not automatically add the `host` field in events.] | ||
| deprecated[5.2.0, In future versions of this plugin, this setting will be removed, and the 'hosts' field will not be added to events.] |
There was a problem hiding this comment.
Can we say deprecated[5.2.1 if the field will be removed for future releases?
To summarize suggestion, "Added in 5.2.0. Deprecated in 5.2.1"
There was a problem hiding this comment.
The intent is to deprecate it immediately - the setting is a stop gap until we make the breaking change that will remove the setting.
Improved wording and fixed up versions for added and deprecated sections
elasticsearch-bot
pushed a commit
that referenced
this pull request
Jul 24, 2018
elasticsearch-bot
pushed a commit
that referenced
this pull request
Jul 24, 2018
And changelog update. Fixes #340
elasticsearch-bot
pushed a commit
that referenced
this pull request
Jul 24, 2018
Improved wording and fixed up versions for added and deprecated sections Fixes #340
fbacchella
pushed a commit
to fbacchella/netty-beats
that referenced
this pull request
Aug 12, 2018
Add `add_hostname` flag - when enabled, the `host` field will be populated by the value supplied by the beat in the `hostname` field if that field is present. The flag defaults to true to retain backwards compatibility with earlier versions of the beats input. The field is intentionally added as a deprecated field - auto populating the `host` field in this way will be removed in future versions of the beats input. Fixes logstash-plugins#340
fbacchella
pushed a commit
to fbacchella/netty-beats
that referenced
this pull request
Aug 12, 2018
fbacchella
pushed a commit
to fbacchella/netty-beats
that referenced
this pull request
Aug 12, 2018
And changelog update. Fixes logstash-plugins#340
fbacchella
pushed a commit
to fbacchella/netty-beats
that referenced
this pull request
Aug 12, 2018
Improved wording and fixed up versions for added and deprecated sections Fixes logstash-plugins#340
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add option to make the population of the 'host' field in the event with
the value from
beat.hostnameoptional. This field is intentionally addedas a deprecated field, as the this field will be removed in future versions
of the beats input, when the ability to populate
hostfield in this waywill be removed altogether.