Skip to content

Fix decode_json_fields processor to always add error key #29107

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 4 commits into from
Nov 29, 2021
Merged

Fix decode_json_fields processor to always add error key #29107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ba9d04
Fix `decode_json_fields` processor to always add error key
belimawr Nov 23, 2021
e5fce6c
Add field to error data, input is renamed to data
belimawr Nov 24, 2021
a83565c
changelog entry
belimawr Nov 24, 2021
c469e56
Add test
belimawr Nov 25, 2021
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 @@ -145,6 +145,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Fix `fingerprint` processor to give it access to the `@timestamp` field. {issue}28683[28683]
- Fix the wrong beat name on monitoring and state endpoint {issue}27755[27755]
- Skip configuration checks in autodiscover for configurations that are already running {pull}29048[29048]
- Fix `decode_json_processor` to always respect `add_error_key` {pull}29107[29107]

*Auditbeat*

Expand Down
5 changes: 5 additions & 0 deletions libbeat/processors/actions/decode_json_fields.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ func (f *decodeJSONFields) Run(event *beat.Event) (*beat.Event, error) {
if err != nil {
f.logger.Debugf("Error trying to unmarshal %s", text)
errs = append(errs, err.Error())
event.SetErrorWithOption(common.MapStr{
"message": "parsing input as JSON: " + err.Error(),
"data": text,
"field": field,
}, f.addErrorKey)
continue
}

Expand Down
21 changes: 21 additions & 0 deletions libbeat/processors/actions/decode_json_fields_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,6 +491,27 @@ func TestOverwriteMetadata(t *testing.T) {
assert.Equal(t, expected, actual)
}

func TestAddErrorToEventOnUnmarshalError(t *testing.T) {
testConfig := common.MustNewConfigFrom(map[string]interface{}{
"fields": "message",
"add_error_key": true,
})

input := common.MapStr{
"message": "Broken JSON [[",
}

actual := getActualValue(t, testConfig, input)

errObj, ok := actual["error"].(common.MapStr)
require.True(t, ok, "'error' field not present or of invalid type")
require.NotNil(t, actual["error"])

assert.Equal(t, "message", errObj["field"])
assert.NotNil(t, errObj["data"])
assert.NotNil(t, errObj["message"])
}

func getActualValue(t *testing.T, config *common.Config, input common.MapStr) common.MapStr {
log := logp.NewLogger("decode_json_fields_test")

Expand Down