Loading external fields.yml files
#11199
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you under | ||
| // the Apache License, Version 2.0 (the "License"); you may | ||
| // not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package mapping | ||
|
|
||
| import ( | ||
| "io/ioutil" | ||
|
|
||
| "github.com/elastic/beats/libbeat/asset" | ||
| "github.com/elastic/beats/libbeat/common" | ||
| "github.com/elastic/beats/libbeat/logp" | ||
| ) | ||
|
|
||
| // Supporter returns the configured fields bytes | ||
| type Supporter interface { | ||
| GetBytes() ([]byte, error) | ||
| } | ||
|
|
||
| // fieldsSupport returns the default fields of a Beat | ||
| type fieldsSupport struct { | ||
| log *logp.Logger | ||
| beat string | ||
| } | ||
|
|
||
| // customFieldsSupport returns the custom configured fields of a Beat | ||
| type customFieldsSupport struct { | ||
| log *logp.Logger | ||
| beat string | ||
| path string | ||
| } | ||
|
|
||
| // appendFieldsSupport return the default fields of a Beat | ||
| // and the additional fields from append_fields | ||
| type appendFieldsSupport struct { | ||
| original Supporter | ||
| appendedFields []byte | ||
| } | ||
|
|
||
| // externalFieldsSupport return the default fields of a Beat | ||
| // and the additional fields from external_fields | ||
| type externalFieldsSupport struct { | ||
| original Supporter | ||
| paths []string | ||
| } | ||
|
|
||
| func DefaultSupport(log *logp.Logger, beat string, cfg *common.Config) (Supporter, error) { | ||
|
There was a problem hiding this comment. exported function DefaultSupport should have comment or be unexported |
||
| if log == nil { | ||
| log = logp.NewLogger("mapping") | ||
| } else { | ||
| log = log.Named("mapping") | ||
| } | ||
|
|
||
| config := struct { | ||
| Template struct { | ||
| Fields string `config:"fields"` | ||
| AppendFields []byte `config:"append_fields"` | ||
| ExternalFields []string `config:"external_fields"` | ||
| } `config:"setup.template"` | ||
| }{} | ||
| err := cfg.Unpack(&config) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // load default fields.ymls of Beat | ||
| var s Supporter | ||
| s = &fieldsSupport{ | ||
| log: log, | ||
| beat: beat, | ||
| } | ||
|
|
||
| // custom fields.yml file is configured | ||
| if config.Template.Fields != "" { | ||
| s = &customFieldsSupport{ | ||
| log: log, | ||
| beat: beat, | ||
| path: config.Template.Fields, | ||
| } | ||
| } | ||
|
|
||
| // append_fields | ||
| if len(config.Template.AppendFields) > 0 { | ||
| s = &appendFieldsSupport{ | ||
| original: s, | ||
| appendedFields: config.Template.AppendFields, | ||
| } | ||
| } | ||
|
|
||
| // external_fields | ||
| if len(config.Template.ExternalFields) > 0 { | ||
| s = &externalFieldsSupport{ | ||
| original: s, | ||
| paths: config.Template.ExternalFields, | ||
| } | ||
| } | ||
|
|
||
| return s, nil | ||
| } | ||
|
|
||
| func (f *fieldsSupport) GetBytes() ([]byte, error) { | ||
| return asset.GetFields(f.beat) | ||
| } | ||
|
|
||
| func (c *customFieldsSupport) GetBytes() ([]byte, error) { | ||
| c.log.Debugf("Reading bytes custom fields.yml from %s", c.path) | ||
| return ioutil.ReadFile(c.path) | ||
| } | ||
|
|
||
| func (a *appendFieldsSupport) GetBytes() ([]byte, error) { | ||
| fields, err := a.original.GetBytes() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return append(fields, a.appendedFields...), nil | ||
| } | ||
|
|
||
| func (e *externalFieldsSupport) GetBytes() ([]byte, error) { | ||
| fields, err := e.original.GetBytes() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| for _, path := range e.paths { | ||
| f, err := ioutil.ReadFile(path) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| fields = append(fields, f...) | ||
| } | ||
|
|
||
| return fields, nil | ||
| } | ||
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
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
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
Oops, something went wrong.
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.
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.
To me the name kind of clashes with
setup.template.fields. Like: which one has priority, does one replace the other, are the two files combined, why not have setup.template.fields accept a list of files.