Skip to content

Report error root cause if available #613

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 2 commits into from
Dec 8, 2021
Merged

Report error root cause if available #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2266bb9
Report error root cause if available
r00tu53r Dec 8, 2021
9d5c22a
Add omitempty to ErrorBody fields and update test
r00tu53r Dec 8, 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
61 changes: 53 additions & 8 deletions internal/elasticsearch/error.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,64 @@ import (
// NewError returns a new error constructed from the given response body.
// This assumes the body contains a JSON encoded error. If the body cannot
// be parsed then an error is returned that contains the raw body.
func NewError(body []byte) error {
type ErrorBody struct {
Error struct {
Type string `json:"type"`
Reason string `json:"reason"`
} `json:"error"`
}
type ErrorBody struct {
Error struct {
RootCause []struct {
Type string `json:"type"`
Reason string `json:"reason"`
ProcessorType string `json:"processor_type,omitempty"`
ScriptStack []string `json:"script_stack,omitempty"`
Script string `json:"script,omitempty"`
Lang string `json:"lang,omitempty"`
Position struct {
Offset int `json:"offset"`
Start int `json:"start"`
End int `json:"end"`
} `json:"position,omitempty"`
Suppressed []struct {
Type string `json:"type"`
Reason string `json:"reason"`
ProcessorType string `json:"processor_type"`
} `json:"suppressed,omitempty"`
} `json:"root_cause,omitempty"`
Type string `json:"type"`
Reason string `json:"reason"`
ProcessorType string `json:"processor_type,omitempty"`
ScriptStack []string `json:"script_stack,omitempty"`
Script string `json:"script,omitempty"`
Lang string `json:"lang,omitempty"`
Position struct {
Offset int `json:"offset"`
Start int `json:"start"`
End int `json:"end"`
} `json:"position,omitempty"`
CausedBy struct {
Type string `json:"type"`
Reason string `json:"reason"`
CausedBy struct {
Type string `json:"type"`
Reason interface{} `json:"reason"`
} `json:"caused_by,omitempty"`
} `json:"caused_by,omitempty"`
Suppressed []struct {
Type string `json:"type"`
Reason string `json:"reason"`
ProcessorType string `json:"processor_type"`
} `json:"suppressed,omitempty"`
} `json:"error"`
Status int `json:"status"`
}

func NewError(body []byte) error {
var errBody ErrorBody
if err := json.NewDecoder(bytes.NewReader(body)).Decode(&errBody); err == nil {
if len(errBody.Error.RootCause) > 0 {
rootCause, _ := json.MarshalIndent(errBody.Error.RootCause, "", " ")
return fmt.Errorf("elasticsearch error (type=%v): %v\nRoot cause:\n%v", errBody.Error.Type,
errBody.Error.Reason, string(rootCause))
}
return fmt.Errorf("elasticsearch error (type=%v): %v", errBody.Error.Type, errBody.Error.Reason)
}

// Fall back to including to raw body if it cannot be parsed.
return fmt.Errorf("elasticsearch error: %v", string(body))
}
16 changes: 15 additions & 1 deletion internal/elasticsearch/error_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ func TestNewError(t *testing.T) {
"status" : 400
}`

const expected = `elasticsearch error (type=parse_exception): processor [set] doesn't support one or more provided configuration parameters [fail]
Root cause:
[
{
"type": "parse_exception",
"reason": "processor [set] doesn't support one or more provided configuration parameters [fail]",
"processor_type": "set",
"position": {
"offset": 0,
"start": 0,
"end": 0
}
}
]`
err := elasticsearch.NewError([]byte(resp))
assert.Equal(t, err.Error(), "elasticsearch error (type=parse_exception): processor [set] doesn't support one or more provided configuration parameters [fail]")
assert.Equal(t, err.Error(), expected)
}