Skip to content
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.

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

Cherry-pick #8751 to 6.x: Dissect tag on parsing error #8818

Merged
merged 1 commit into from
Nov 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ https://github.com/elastic/beats/compare/v6.4.0...6.x[Check the HEAD diff]
- Add Beats Central Management {pull}8559[8559]
- Report configured queue type. {pull}8091[8091]
- Enable `host` and `cloud` metadata processors by default. {pull}8596[8596]
- Dissect will now flag event on parsing error. {pull}8751[8751]

*Auditbeat*

Expand Down
3 changes: 3 additions & 0 deletions libbeat/beat/event.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ import (
"github.com/elastic/beats/libbeat/common"
)

// FlagField fields used to keep information or errors when events are parsed.
const FlagField = "log.flags"

// Event is the common event format shared by all beats.
// Every event must have a timestamp and provide encodable Fields in `Fields`.
// The `Meta`-fields can be used to pass additional meta-data to the outputs.
Expand Down
10 changes: 10 additions & 0 deletions libbeat/processors/dissect/processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ import (
"github.com/elastic/beats/libbeat/processors"
)

const flagParsingError = "dissect_parsing_error"

type processor struct {
config config
}
Expand Down Expand Up @@ -60,6 +62,14 @@ func (p *processor) Run(event *beat.Event) (*beat.Event, error) {

m, err := p.config.Tokenizer.Dissect(s)
if err != nil {
if err := common.AddTagsWithKey(
event.Fields,
beat.FlagField,
[]string{flagParsingError},
); err != nil {
return event, errors.Wrap(err, "cannot add new flag the event")
}

return event, err
}

Expand Down
56 changes: 56 additions & 0 deletions libbeat/processors/dissect/processor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,59 @@ func TestFieldAlreadyExist(t *testing.T) {
})
}
}

func TestErrorFlagging(t *testing.T) {
t.Run("when the parsing fails add a flag", func(t *testing.T) {
c, err := common.NewConfigFrom(map[string]interface{}{
"tokenizer": "%{ok} - %{notvalid}",
})

if !assert.NoError(t, err) {
return
}

processor, err := newProcessor(c)
if !assert.NoError(t, err) {
return
}

e := beat.Event{Fields: common.MapStr{"message": "hello world"}}
event, err := processor.Run(&e)

if !assert.Error(t, err) {
return
}

flags, err := event.GetValue(beat.FlagField)
if !assert.NoError(t, err) {
return
}

assert.Contains(t, flags, flagParsingError)
})

t.Run("when the parsing is succesful do not add a flag", func(t *testing.T) {
c, err := common.NewConfigFrom(map[string]interface{}{
"tokenizer": "%{ok} %{valid}",
})

if !assert.NoError(t, err) {
return
}

processor, err := newProcessor(c)
if !assert.NoError(t, err) {
return
}

e := beat.Event{Fields: common.MapStr{"message": "hello world"}}
event, err := processor.Run(&e)

if !assert.NoError(t, err) {
return
}

_, err = event.GetValue(beat.FlagField)
assert.Error(t, err)
})
}