Fix duplication of dynamic fields on reconnect #7352
Merged
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
ruflin
added
bug
review
libbeat
needs_backport
tsg
reviewed
Jun 18, 2018
CHANGELOG.asciidoc
Outdated
| @@ -71,6 +71,7 @@ https://github.com/elastic/beats/compare/v6.2.3...master[Check the HEAD diff] | |||
| - Do not emit Kubernetes autodiscover events for Pods without IP address. {pull}7235[7235] | |||
| - Allow to override the `ignore_above` option when defining new field with the type keyword. {pull}7238[7238] | |||
| - Allow index-pattern only setup when setup.dashboards.only_index=true. {pull}7285[7285] | |||
| - Fix duplicating dynamic_fields in template when overwriting the template. {pull}[] | |||
If `setup.template.overwrite: true` is set the template is overwritten each time the Beat reconnects. The `dynamicTemplates` are a global variable that keeps state. This had the side effect that each time the template was generated for loading, the dynamic fields were append again. The logic in the code is changed now that each time when the template is generated first the dynamicFields array is reset. This also works with the new `append_fields` config option because it is read during the load process to also potentially add dynamic fields. The same applies to the default fields which are global. Also this array is reset. As default_fields were only used for Elasticsearch 7.0 is does not need an entry in the changelog. If possible in the future both variables should be part of the template object instead of being global. Unfortunately this would required major changes.
ruflin
force-pushed
the
fix-dynamic-fields-duplicates
branch
from
3f3c6fa to
649d0b6
Compare
|
jenkins, test this |
1 similar comment
|
jenkins, test this |
andrewkroh
reviewed
Jun 20, 2018
libbeat/template/template.go
Outdated
| @@ -97,6 +97,9 @@ func New(beatVersion string, beatName string, esVersion string, config TemplateC | |||
|
|
|||
| func (t *Template) load(fields common.Fields) (common.MapStr, error) { | |||
|
|
|||
| dynamicTemplates = nil | |||
There was a problem hiding this comment.
With this function being called each time that a client connects to Elasticsearch I would expect that this could lead to data races (especially if the number of workers is greater than 1). So because these are globals I think a mutex is required for reads and writes.
There was a problem hiding this comment.
I added a lock directly above for the load method. All access to dynamicTemplates and defaultFields happens inside the processor and generator which both are triggered here. Generate could also be called from outside but in this case it's one of the Cobra commands so will not overlap with the running beat and only happening once.
ruflin
force-pushed
the
fix-dynamic-fields-duplicates
branch
from
262b13a to
67e65a7
Compare
ruflin
added a commit
to ruflin/beats
that referenced
this pull request
Jun 26, 2018
* Fix duplication of dynamic fields on reconnect If `setup.template.overwrite: true` is set the template is overwritten each time the Beat reconnects. The `dynamicTemplates` are a global variable that keeps state. This had the side effect that each time the template was generated for loading, the dynamic fields were append again. The logic in the code is changed now that each time when the template is generated first the dynamicFields array is reset. This also works with the new `append_fields` config option because it is read during the load process to also potentially add dynamic fields. The same applies to the default fields which are global. Also this array is reset. As default_fields were only used for Elasticsearch 7.0 is does not need an entry in the changelog. If possible in the future both variables should be part of the template object instead of being global. Unfortunately this would required major changes. (cherry picked from commit df74c26)
ruflin
added
v6.3.1
and removed
needs_backport
exekias
pushed a commit
that referenced
this pull request
Jun 27, 2018
* Fix duplication of dynamic fields on reconnect If `setup.template.overwrite: true` is set the template is overwritten each time the Beat reconnects. The `dynamicTemplates` are a global variable that keeps state. This had the side effect that each time the template was generated for loading, the dynamic fields were append again. The logic in the code is changed now that each time when the template is generated first the dynamicFields array is reset. This also works with the new `append_fields` config option because it is read during the load process to also potentially add dynamic fields. The same applies to the default fields which are global. Also this array is reset. As default_fields were only used for Elasticsearch 7.0 is does not need an entry in the changelog. If possible in the future both variables should be part of the template object instead of being global. Unfortunately this would required major changes. (cherry picked from commit df74c26)
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
…c#7417) * Fix duplication of dynamic fields on reconnect If `setup.template.overwrite: true` is set the template is overwritten each time the Beat reconnects. The `dynamicTemplates` are a global variable that keeps state. This had the side effect that each time the template was generated for loading, the dynamic fields were append again. The logic in the code is changed now that each time when the template is generated first the dynamicFields array is reset. This also works with the new `append_fields` config option because it is read during the load process to also potentially add dynamic fields. The same applies to the default fields which are global. Also this array is reset. As default_fields were only used for Elasticsearch 7.0 is does not need an entry in the changelog. If possible in the future both variables should be part of the template object instead of being global. Unfortunately this would required major changes. (cherry picked from commit b0a52be)
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.
If
setup.template.overwrite: trueis set the template is overwritten each time the Beat reconnects. ThedynamicTemplatesare a global variable that keeps state. This had the side effect that each time the template was generated for loading, the dynamic fields were append again. The logic in the code is changed now that each time when the template is generated first the dynamicFields array is reset.This also works with the new
append_fieldsconfig option because it is read during the load process to also potentially add dynamic fields.The same applies to the default fields which are global. Also this array is reset. As default_fields were only used for Elasticsearch 7.0 is does not need an entry in the changelog.
If possible in the future both variables should be part of the template object instead of being global. Unfortunately this would required major changes.