[receiver/splunkhecreceiver] Updates Splunk receiver http status code…

…s in order to be compliant with SplunkCloud (#14469) * Updates all StatusAccepted on Splunk Receiver * Fixes all tests by asserting StatusOK instead of StatusAccepted * Adds CHANGELOG entry for Splunk HEC Receiver changes regarding http status codes * Update splunkhecreceiver-http-status-code-return.yaml Co-authored-by: Bogdan Drutu <lazy@splunk.com>
open-telemetry · Sep 28, 2022 · d3cc2dd · d3cc2dd
1 parent 60fb9d3
commit d3cc2dd
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 14 deletions.
diff --git a/receiver/splunkhecreceiver/receiver.go b/receiver/splunkhecreceiver/receiver.go
@@ -276,7 +276,7 @@ func (r *splunkReceiver) handleRawReq(resp http.ResponseWriter, req *http.Reques
 	if consumerErr != nil {
 		r.failRequest(ctx, resp, http.StatusInternalServerError, errInternalServerError, sl.LogRecords().Len(), consumerErr)
 	} else {
-		resp.WriteHeader(http.StatusAccepted)
+		resp.WriteHeader(http.StatusOK)
 		r.obsrecv.EndLogsOp(ctx, typeStr, sl.LogRecords().Len(), nil)
 	}
 }
@@ -359,7 +359,7 @@ func (r *splunkReceiver) consumeMetrics(ctx context.Context, events []*splunk.Ev
 	if decodeErr != nil {
 		r.failRequest(ctx, resp, http.StatusInternalServerError, errInternalServerError, len(events), decodeErr)
 	} else {
-		resp.WriteHeader(http.StatusAccepted)
+		resp.WriteHeader(http.StatusOK)
 		_, err := resp.Write(okRespBody)
 		if err != nil {
 			r.failRequest(ctx, resp, http.StatusInternalServerError, errInternalServerError, len(events), err)
@@ -380,7 +380,7 @@ func (r *splunkReceiver) consumeLogs(ctx context.Context, events []*splunk.Event
 	if decodeErr != nil {
 		r.failRequest(ctx, resp, http.StatusInternalServerError, errInternalServerError, len(events), decodeErr)
 	} else {
-		resp.WriteHeader(http.StatusAccepted)
+		resp.WriteHeader(http.StatusOK)
 		if _, err := resp.Write(okRespBody); err != nil {
 			r.failRequest(ctx, resp, http.StatusInternalServerError, errInternalServerError, len(events), err)
 		}

diff --git a/receiver/splunkhecreceiver/receiver_test.go b/receiver/splunkhecreceiver/receiver_test.go
@@ -254,7 +254,7 @@ func Test_splunkhecReceiver_handleReq(t *testing.T) {
 				return req
 			}(),
 			assertResponse: func(t *testing.T, status int, body string) {
-				assert.Equal(t, http.StatusAccepted, status)
+				assert.Equal(t, http.StatusOK, status)
 				assert.Equal(t, responseOK, body)
 			},
 		},
@@ -275,7 +275,7 @@ func Test_splunkhecReceiver_handleReq(t *testing.T) {
 				return req
 			}(),
 			assertResponse: func(t *testing.T, status int, body string) {
-				assert.Equal(t, http.StatusAccepted, status)
+				assert.Equal(t, http.StatusOK, status)
 				assert.Equal(t, responseOK, body)
 			},
 		},
@@ -439,7 +439,7 @@ func Test_splunkhecReceiver_TLS(t *testing.T) {
 
 	resp, err := client.Do(req)
 	require.NoErrorf(t, err, "should not have failed when sending to splunk HEC receiver %v", err)
-	assert.Equal(t, http.StatusAccepted, resp.StatusCode)
+	assert.Equal(t, http.StatusOK, resp.StatusCode)
 	t.Log("Splunk HEC Request Received")
 
 	got := sink.AllLogs()
@@ -519,7 +519,7 @@ func Test_splunkhecReceiver_AccessTokenPassthrough(t *testing.T) {
 			endServer := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 				_, err := io.Copy(io.Discard, req.Body)
 				assert.NoError(t, err)
-				rw.WriteHeader(http.StatusAccepted)
+				rw.WriteHeader(http.StatusOK)
 				accessTokensChan <- req.Header.Get("Authorization")
 			}))
 			defer endServer.Close()
@@ -619,7 +619,7 @@ func Test_Logs_splunkhecReceiver_IndexSourceTypePassthrough(t *testing.T) {
 			endServer := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 				body, err := io.ReadAll(req.Body)
 				assert.NoError(t, err)
-				rw.WriteHeader(http.StatusAccepted)
+				rw.WriteHeader(http.StatusOK)
 				receivedSplunkLogs <- body
 			}))
 			defer endServer.Close()
@@ -671,7 +671,7 @@ func Test_Logs_splunkhecReceiver_IndexSourceTypePassthrough(t *testing.T) {
 			assert.NoError(t, err)
 			var bodyStr string
 			assert.NoError(t, json.Unmarshal(respBytes, &bodyStr))
-			assert.Equal(t, http.StatusAccepted, resp.StatusCode)
+			assert.Equal(t, http.StatusOK, resp.StatusCode)
 			assert.Equal(t, responseOK, bodyStr)
 			select {
 			case <-done:
@@ -712,7 +712,7 @@ func Test_Metrics_splunkhecReceiver_IndexSourceTypePassthrough(t *testing.T) {
 			endServer := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 				body, err := io.ReadAll(req.Body)
 				assert.NoError(t, err)
-				rw.WriteHeader(http.StatusAccepted)
+				rw.WriteHeader(http.StatusOK)
 				receivedSplunkMetrics <- body
 			}))
 			defer endServer.Close()
@@ -765,7 +765,7 @@ func Test_Metrics_splunkhecReceiver_IndexSourceTypePassthrough(t *testing.T) {
 			assert.NoError(t, err)
 			var bodyStr string
 			assert.NoError(t, json.Unmarshal(respBytes, &bodyStr))
-			assert.Equal(t, http.StatusAccepted, resp.StatusCode)
+			assert.Equal(t, http.StatusOK, resp.StatusCode)
 			assert.Equal(t, responseOK, bodyStr)
 			select {
 			case <-done:
@@ -899,7 +899,7 @@ func Test_splunkhecReceiver_handleRawReq(t *testing.T) {
 				return req
 			}(),
 			assertResponse: func(t *testing.T, status int, body string) {
-				assert.Equal(t, http.StatusAccepted, status)
+				assert.Equal(t, http.StatusOK, status)
 			},
 		},
 		{
@@ -911,7 +911,7 @@ func Test_splunkhecReceiver_handleRawReq(t *testing.T) {
 				return req
 			}(),
 			assertResponse: func(t *testing.T, status int, body string) {
-				assert.Equal(t, http.StatusAccepted, status)
+				assert.Equal(t, http.StatusOK, status)
 			},
 		},
 		{
@@ -931,7 +931,7 @@ func Test_splunkhecReceiver_handleRawReq(t *testing.T) {
 				return req
 			}(),
 			assertResponse: func(t *testing.T, status int, body string) {
-				assert.Equal(t, http.StatusAccepted, status)
+				assert.Equal(t, http.StatusOK, status)
 			},
 		},
 		{

diff --git a/unreleased/splunkhecreceiver-http-status-code-return.yaml b/unreleased/splunkhecreceiver-http-status-code-return.yaml
@@ -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: Updates Splunk receiver http status codes in order to be compliant with SplunkCloud
+
+# One or more tracking issues related to the change
+issues: [14469]