Skip to content

Commit e8256ae

Browse files
authored
[receiver/datadogreceiver] Fix /api/v1/check_run response to return JSON status: ok (#36029)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Changing the `/api/v1/check_run` response for service checks to be on par with the datadog api spec as per https://docs.datadoghq.com/api/latest/service-checks/ This is the same implementation as the PR for the series endpoints #35744 <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes #36027 <!--Describe what testing was performed and which tests were added.--> #### Testing Unit tests updated and are passing <!--Describe the documentation added.--> #### Documentation Changelog updated
1 parent e7ae19d commit e8256ae

File tree

3 files changed

+33
-2
lines changed

3 files changed

+33
-2
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: 'bug_fix'
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: 'datadogreceiver'
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: "Changes response message for `/api/v1/check_run` 202 response to be JSON and on par with Datadog API spec"
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [36027]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

receiver/datadogreceiver/receiver.go

+5-1
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,12 @@ func (ddr *datadogReceiver) handleCheckRun(w http.ResponseWriter, req *http.Requ
361361
return
362362
}
363363

364+
w.Header().Set("Content-Type", "application/json")
364365
w.WriteHeader(http.StatusAccepted)
365-
_, _ = w.Write([]byte("OK"))
366+
response := map[string]string{
367+
"status": "ok",
368+
}
369+
_ = json.NewEncoder(w).Encode(response)
366370
}
367371

368372
// handleSketches handles sketches, the underlying data structure of distributions https://docs.datadoghq.com/metrics/distributions/

receiver/datadogreceiver/receiver_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@ func TestDatadogServices_EndToEnd(t *testing.T) {
659659

660660
body, err := io.ReadAll(resp.Body)
661661
require.NoError(t, multierr.Combine(err, resp.Body.Close()), "Must not error when reading body")
662-
require.Equal(t, "OK", string(body), "Expected response to be 'OK', got %s", string(body))
662+
require.JSONEq(t, `{"status": "ok"}`, string(body), "Expected JSON response to be `{\"status\": \"ok\"}`, got %s", string(body))
663663
require.Equal(t, http.StatusAccepted, resp.StatusCode)
664664

665665
mds := sink.AllMetrics()

0 commit comments

Comments
 (0)