Skip to content

[libbeat] Do not modify slice while iterating over it #41520

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
khushijain21 merged 3 commits into from
Nov 5, 2024
Merged

[libbeat] Do not modify slice while iterating over it #41520

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
7a65a73
[libbeat] Do not modify slice while iterating over it
khushijain21 Nov 5, 2024
fdf585f
fix linting
khushijain21 Nov 5, 2024
9c75d34
fix regex test case failing
khushijain21 Nov 5, 2024
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
19 changes: 10 additions & 9 deletions libbeat/processors/actions/drop_fields.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,22 +61,23 @@ func newDropFields(c *conf.C) (beat.Processor, error) {
return nil, fmt.Errorf("fail to unpack the drop_fields configuration: %w", err)
}

/* remove read only fields */
// TODO: Is this implementation used? If so, there's a fix needed in removal of exported fields
// Do not drop manadatory fields
var configFields []string
for _, readOnly := range processors.MandatoryExportedFields {
for i, field := range config.Fields {
if readOnly == field {
config.Fields = append(config.Fields[:i], config.Fields[i+1:]...)
for _, field := range config.Fields {
if readOnly == field || strings.HasPrefix(field, readOnly+".") {
continue
}
configFields = append(configFields, field)
}
}

// Parse regexp containing fields and removes them from initial config
regexpFields := make([]match.Matcher, 0)
for i := len(config.Fields) - 1; i >= 0; i-- {
field := config.Fields[i]
for i := len(configFields) - 1; i >= 0; i-- {
field := configFields[i]
if strings.HasPrefix(field, "/") && strings.HasSuffix(field, "/") && len(field) > 2 {
config.Fields = append(config.Fields[:i], config.Fields[i+1:]...)
configFields = append(configFields[:i], configFields[i+1:]...)

matcher, err := match.Compile(field[1 : len(field)-1])
if err != nil {
Expand All @@ -87,7 +88,7 @@ func newDropFields(c *conf.C) (beat.Processor, error) {
}
}

f := &dropFields{Fields: config.Fields, IgnoreMissing: config.IgnoreMissing, RegexpFields: regexpFields}
f := &dropFields{Fields: configFields, IgnoreMissing: config.IgnoreMissing, RegexpFields: regexpFields}
return f, nil
}

Expand Down
17 changes: 17 additions & 0 deletions libbeat/processors/actions/drop_fields_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
config2 "github.com/elastic/elastic-agent-libs/config"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/elastic/beats/v7/libbeat/beat"
"github.com/elastic/elastic-agent-libs/mapstr"
Expand All @@ -50,6 +51,22 @@ func TestDropFieldRun(t *testing.T) {
assert.Equal(t, event.Meta, newEvent.Meta)
})

t.Run("Do not drop mandatory fields", func(t *testing.T) {
c := config2.MustNewConfigFrom(
mapstr.M{
"fields": []string{"field1", "type", "type.value.key", "typeKey"},
"ignore_missing": true,
},
)

p, err := newDropFields(c)
require.NoError(t, err)
process, ok := p.(*dropFields)
assert.True(t, ok)
assert.NoError(t, err)
assert.Equal(t, []string{"field1", "typeKey"}, process.Fields)
})

t.Run("supports a metadata field", func(t *testing.T) {
p := dropFields{
Fields: []string{"@metadata.meta_field"},
Expand Down