Skip to content

Avoid duplicate names in dynamic_templates #18849

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 2, 2020
Merged

Avoid duplicate names in dynamic_templates #18849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9cf4c28
Avoid duplicate names in dynamic_templates
simitt May 29, 2020
b403a3a
Add changelog
simitt Jun 2, 2020
3a14b28
Merge remote-tracking branch 'elastic/master' into dynamic-template-keys
simitt Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Introduce APM libbeat instrumentation, active when running the beat with ELASTIC_APM_ACTIVE=true. {pull}17938[17938]
- Remove the non-ECS `agent.hostname` field. Use the `agent.name` or `agent.id` fields for an identifier. {issue}16377[16377] {pull}18328[18328]
- Make error message about locked data path actionable. {pull}18667[18667]
- Ensure dynamic template names are unique for the same field. {pull}18849[18849]

*Auditbeat*

Expand Down
45 changes: 30 additions & 15 deletions libbeat/template/processor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package template

import (
"errors"
"fmt"
"strings"

"github.com/elastic/beats/v7/libbeat/common"
Expand Down Expand Up @@ -319,29 +320,51 @@ func (p *Processor) object(f *mapping.Field) common.MapStr {

for _, otp := range otParams {
dynProperties := getDefaultProperties(f)
var matchingType string

switch otp.ObjectType {
case "scaled_float":
dynProperties = p.scaledFloat(f, common.MapStr{scalingFactorKey: otp.ScalingFactor})
addDynamicTemplate(f, dynProperties, matchType("*", otp.ObjectTypeMappingType))
matchingType = matchType("*", otp.ObjectTypeMappingType)
case "text":
dynProperties["type"] = "text"

if p.EsVersion.IsMajor(2) {
dynProperties["type"] = "string"
dynProperties["index"] = "analyzed"
}
addDynamicTemplate(f, dynProperties, matchType("string", otp.ObjectTypeMappingType))
matchingType = matchType("string", otp.ObjectTypeMappingType)
case "keyword":
dynProperties["type"] = otp.ObjectType
addDynamicTemplate(f, dynProperties, matchType("string", otp.ObjectTypeMappingType))
matchingType = matchType("string", otp.ObjectTypeMappingType)
case "byte", "double", "float", "long", "short", "boolean":
dynProperties["type"] = otp.ObjectType
addDynamicTemplate(f, dynProperties, matchType(otp.ObjectType, otp.ObjectTypeMappingType))
matchingType = matchType(otp.ObjectType, otp.ObjectTypeMappingType)
case "histogram":
dynProperties["type"] = otp.ObjectType
addDynamicTemplate(f, dynProperties, matchType("*", otp.ObjectTypeMappingType))
matchingType = matchType("*", otp.ObjectTypeMappingType)
default:
continue
}

path := f.Path
if len(path) > 0 {
path += "."
}
path += f.Name
pathMatch := path
// ensure the `path_match` string ends with a `*`
if !strings.ContainsRune(path, '*') {
pathMatch += ".*"
}
// When multiple object type parameters are detected for a field,
// add a unique part to the name of the dynamic template.
// Duplicated dynamic template names can lead to errors when template
// inheritance is applied, and will not be supported in future versions
if len(otParams) > 1 {
path = fmt.Sprintf("%s_%s", path, matchingType)
}
addDynamicTemplate(path, pathMatch, dynProperties, matchingType)
}

properties := getDefaultProperties(f)
Expand All @@ -357,18 +380,10 @@ func (p *Processor) object(f *mapping.Field) common.MapStr {
return properties
}

func addDynamicTemplate(f *mapping.Field, properties common.MapStr, matchType string) {
path := ""
if len(f.Path) > 0 {
path = f.Path + "."
}
pathMatch := path + f.Name
if !strings.ContainsRune(pathMatch, '*') {
pathMatch += ".*"
}
func addDynamicTemplate(path string, pathMatch string, properties common.MapStr, matchType string) {
template := common.MapStr{
// Set the path of the field as name
path + f.Name: common.MapStr{
path: common.MapStr{
"mapping": properties,
"match_mapping_type": matchType,
"path_match": pathMatch,
Expand Down
12 changes: 6 additions & 6 deletions libbeat/template/processor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,22 +443,22 @@ func TestDynamicTemplates(t *testing.T) {
Name: "context",
},
expected: []common.MapStr{
common.MapStr{
"context": common.MapStr{
{
"context_float": common.MapStr{
"mapping": common.MapStr{"type": "float"},
"match_mapping_type": "float",
"path_match": "context.*",
},
},
common.MapStr{
"context": common.MapStr{
{
"context_boolean": common.MapStr{
"mapping": common.MapStr{"type": "boolean"},
"match_mapping_type": "boolean",
"path_match": "context.*",
},
},
common.MapStr{
"context": common.MapStr{
{
"context_*": common.MapStr{
"mapping": common.MapStr{"type": "scaled_float", "scaling_factor": 10000},
"match_mapping_type": "*",
"path_match": "context.*",
Expand Down