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.

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

Jump to bottom

[receiver/splunkhec] Align hec receiver errors messages to splunk enterprise #19769

Merged
merged 3 commits into from
Mar 19, 2023
Merged

[receiver/splunkhec] Align hec receiver errors messages to splunk enterprise #19769

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d37209
Align hec receiver errors messages to splunk enterprise
timannguyen Mar 17, 2023
a4e4824
include chlog
timannguyen Mar 17, 2023
b5de049
revert removing obsrecv in raw
timannguyen Mar 17, 2023
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
11 changes: 11 additions & 0 deletions .chloggen/splunkhecreceiver-align-error-message.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: splunkhecreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: align error message with splunk enterprise to include No Data, Invalid Data Format, Event field is required, and Event field cannot be blank

# One or more tracking issues related to the change
issues: [19219]
28 changes: 22 additions & 6 deletions receiver/splunkhecreceiver/receiver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,16 @@ const (
responseOK = "OK"
responseInvalidMethod = `Only "POST" method is supported`
responseInvalidEncoding = `"Content-Encoding" must be "gzip" or empty`
responseInvalidDataFormat = `{"text":"Invalid data format","code":6}`
responseErrEventRequired = `{"text":"Event field is required","code":12}`
responseErrEventBlank = `{"text":"Event field cannot be blank","code":13}`
responseErrGzipReader = "Error on gzip body"
responseErrUnmarshalBody = "Failed to unmarshal message body"
responseErrInternalServerError = "Internal Server Error"
responseErrUnsupportedMetricEvent = "Unsupported metric event"
responseErrUnsupportedLogEvent = "Unsupported log event"
Comment on lines 52 to 55
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to revise the existing error message to follow similar structure too? For example Internal Server Error would be error code 8. If the answer is yes, a further question to @atoulme, this would change the behavior for existing users, do you know who we need to notify to get signed off for?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can make that change. The config options for beta components are considered stable, but we have no particular consideration for error messages, so we should be ok changing them as long as there is a release note for it.

responseErrHandlingIndexedFields = `{"text":"Error in handling indexed fields","code":15,"invalid-event-number":%d}`
responseNoData = `{"text":"No data","code":5}`
// Centralizing some HTTP and related string constants.
gzipEncoding = "gzip"
httpContentEncodingHeader = "Content-Encoding"
Expand All @@ -64,13 +68,17 @@ var (
errInvalidEncoding = errors.New("invalid encoding")

okRespBody = initJSONResponse(responseOK)
invalidMethodRespBody = initJSONResponse(responseInvalidMethod)
eventRequiredRespBody = initJSONResponse(responseErrEventRequired)
eventBlankRespBody = initJSONResponse(responseErrEventBlank)
invalidEncodingRespBody = initJSONResponse(responseInvalidEncoding)
invalidFormatRespBody = initJSONResponse(responseInvalidDataFormat)
invalidMethodRespBody = initJSONResponse(responseInvalidMethod)
errGzipReaderRespBody = initJSONResponse(responseErrGzipReader)
errUnmarshalBodyRespBody = initJSONResponse(responseErrUnmarshalBody)
errInternalServerError = initJSONResponse(responseErrInternalServerError)
errUnsupportedMetricEvent = initJSONResponse(responseErrUnsupportedMetricEvent)
errUnsupportedLogEvent = initJSONResponse(responseErrUnsupportedLogEvent)
noDataRespBody = initJSONResponse(responseNoData)
)

// splunkReceiver implements the receiver.Metrics for Splunk HEC metric protocol.
Expand Down Expand Up @@ -245,7 +253,7 @@ func (r *splunkReceiver) handleRawReq(resp http.ResponseWriter, req *http.Reques
}

if req.ContentLength == 0 {
r.obsrecv.EndLogsOp(ctx, typeStr, 0, nil)
timannguyen marked this conversation as resolved.
Show resolved Hide resolved
r.failRequest(ctx, resp, http.StatusBadRequest, noDataRespBody, 0, nil)
return
}

Expand Down Expand Up @@ -311,9 +319,7 @@ func (r *splunkReceiver) handleReq(resp http.ResponseWriter, req *http.Request)
}

if req.ContentLength == 0 {
if _, err := resp.Write(okRespBody); err != nil {
r.failRequest(ctx, resp, http.StatusInternalServerError, errInternalServerError, 0, err)
}
r.failRequest(ctx, resp, http.StatusBadRequest, noDataRespBody, 0, nil)
return
}

Expand All @@ -325,7 +331,17 @@ func (r *splunkReceiver) handleReq(resp http.ResponseWriter, req *http.Request)
var msg splunk.Event
err := dec.Decode(&msg)
if err != nil {
r.failRequest(ctx, resp, http.StatusBadRequest, errUnmarshalBodyRespBody, len(events), err)
r.failRequest(ctx, resp, http.StatusBadRequest, invalidFormatRespBody, len(events), err)
return
}

if msg.Event == nil {
r.failRequest(ctx, resp, http.StatusBadRequest, eventRequiredRespBody, len(events), nil)
return
}

if msg.Event == "" {
r.failRequest(ctx, resp, http.StatusBadRequest, eventBlankRespBody, len(events), nil)
return
}

Expand Down
58 changes: 52 additions & 6 deletions receiver/splunkhecreceiver/receiver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,9 @@ func Test_splunkhecReceiver_handleReq(t *testing.T) {
{
name: "incorrect_content_type",
req: func() *http.Request {
req := httptest.NewRequest("POST", "http://localhost/foo", nil)
msgBytes, err := json.Marshal(splunkMsg)
require.NoError(t, err)
req := httptest.NewRequest("POST", "http://localhost/foo", bytes.NewReader(msgBytes))
req.Header.Set("Content-Type", "application/not-json")
return req
}(),
Expand Down Expand Up @@ -234,7 +236,7 @@ func Test_splunkhecReceiver_handleReq(t *testing.T) {
}(),
assertResponse: func(t *testing.T, status int, body string) {
assert.Equal(t, http.StatusBadRequest, status)
assert.Equal(t, responseErrUnmarshalBody, body)
assert.Equal(t, responseInvalidDataFormat, body)
},
},
{
Expand All @@ -244,8 +246,51 @@ func Test_splunkhecReceiver_handleReq(t *testing.T) {
return req
}(),
assertResponse: func(t *testing.T, status int, body string) {
assert.Equal(t, http.StatusOK, status)
assert.Equal(t, responseOK, body)
assert.Equal(t, http.StatusBadRequest, status)
assert.Equal(t, responseNoData, body)
},
},
{
name: "invalid_data_format",
req: func() *http.Request {
msgBytes, err := json.Marshal(`{"foo":"bar"}`)
require.NoError(t, err)
req := httptest.NewRequest("POST", "http://localhost/foo", bytes.NewReader(msgBytes))
return req
}(),
assertResponse: func(t *testing.T, status int, body string) {
assert.Equal(t, http.StatusBadRequest, status)
assert.Equal(t, responseInvalidDataFormat, body)
},
},
{
name: "event_required_error",
req: func() *http.Request {
nilEventMsg := buildSplunkHecMsg(currentTime, 3)
nilEventMsg.Event = nil
msgBytes, err := json.Marshal(nilEventMsg)
require.NoError(t, err)
req := httptest.NewRequest("POST", "http://localhost/foo", bytes.NewReader(msgBytes))
return req
}(),
assertResponse: func(t *testing.T, status int, body string) {
assert.Equal(t, http.StatusBadRequest, status)
assert.Equal(t, responseErrEventRequired, body)
},
},
{
name: "event_cannot_be_blank_error",
req: func() *http.Request {
blankEventMsg := buildSplunkHecMsg(currentTime, 3)
blankEventMsg.Event = ""
msgBytes, err := json.Marshal(blankEventMsg)
require.NoError(t, err)
req := httptest.NewRequest("POST", "http://localhost/foo", bytes.NewReader(msgBytes))
return req
}(),
assertResponse: func(t *testing.T, status int, body string) {
assert.Equal(t, http.StatusBadRequest, status)
assert.Equal(t, responseErrEventBlank, body)
},
},
{
Expand Down Expand Up @@ -864,7 +909,7 @@ func Test_splunkhecReceiver_handleRawReq(t *testing.T) {
{
name: "incorrect_content_type",
req: func() *http.Request {
req := httptest.NewRequest("POST", "http://localhost/foo", nil)
req := httptest.NewRequest("POST", "http://localhost/foo", strings.NewReader("foo\nbar"))
req.Header.Set("Content-Type", "application/not-json")
return req
}(),
Expand All @@ -891,7 +936,8 @@ func Test_splunkhecReceiver_handleRawReq(t *testing.T) {
return req
}(),
assertResponse: func(t *testing.T, status int, body string) {
assert.Equal(t, http.StatusOK, status)
assert.Equal(t, http.StatusBadRequest, status)
assert.Equal(t, responseNoData, body)
},
},

Expand Down