From c14609d42323fea143a29116e46a51e6423e7849 Mon Sep 17 00:00:00 2001 From: John Meagher Date: Wed, 30 Oct 2024 16:29:23 -0500 Subject: [PATCH] [receiver/datadogreceiver] Return json for traces if the version is > 0.3 (#35705) #### Description Problem: * [The Datadog agent for versions > 0.3 returns Json instead of "Ok"](https://github.com/DataDog/datadog-agent/blob/86b2ae24f93941447a5bf0a2b6419caed77e76dd/pkg/trace/api/api.go#L511-L519) * [dd-trace-js is using V0.4 for sending data to Datadog and that expects to get a JSON response back](https://github.com/DataDog/dd-trace-js/blob/2d175d30d5ad7291c238819116a07f003074316b/packages/dd-trace/src/exporters/agent/writer.js#L52) * When sending traces from NodeJS with the dd-trace-js library it works, but throws a high volume of errors from the non-json response. Fix: For trace submissions with a version > 0.3 return a valid, but empty Json response. #### Testing Added unit test to ensure the expected responses to traces are returned. --------- Co-authored-by: Sean Marciniak <30928402+MovieStoreGuy@users.noreply.github.com> --- .../datadog-trace-receiver-return-body.yaml | 27 +++++++++++++++++++ receiver/datadogreceiver/receiver.go | 18 +++++++++++-- receiver/datadogreceiver/receiver_test.go | 23 +++++++++++++--- 3 files changed, 63 insertions(+), 5 deletions(-) create mode 100644 .chloggen/datadog-trace-receiver-return-body.yaml diff --git a/.chloggen/datadog-trace-receiver-return-body.yaml b/.chloggen/datadog-trace-receiver-return-body.yaml new file mode 100644 index 000000000000..26fb041b2540 --- /dev/null +++ b/.chloggen/datadog-trace-receiver-return-body.yaml @@ -0,0 +1,27 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: bug_fix + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: datadogreceiver + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Return a json reponse instead of "OK" when a trace is received with a newer protocol version. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [35705] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + +# If your change doesn't affect end users or the exported elements of any package, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [user] diff --git a/receiver/datadogreceiver/receiver.go b/receiver/datadogreceiver/receiver.go index ef850fd1e6c0..17b2814ce007 100644 --- a/receiver/datadogreceiver/receiver.go +++ b/receiver/datadogreceiver/receiver.go @@ -10,6 +10,7 @@ import ( "fmt" "io" "net/http" + "strings" "github.com/DataDog/agent-payload/v5/gogen" pb "github.com/DataDog/datadog-agent/pkg/proto/pbgo/trace" @@ -244,8 +245,21 @@ func (ddr *datadogReceiver) handleTraces(w http.ResponseWriter, req *http.Reques } } - _, _ = w.Write([]byte("OK")) - + responseBody := "OK" + contentType := "text/plain" + urlSplit := strings.Split(req.RequestURI, "/") + if len(urlSplit) == 3 { + // Match the response logic from dd-agent https://github.com/DataDog/datadog-agent/blob/86b2ae24f93941447a5bf0a2b6419caed77e76dd/pkg/trace/api/api.go#L511-L519 + switch version := urlSplit[1]; version { + case "v0.1", "v0.2", "v0.3": + // Keep the "OK" response for these versions + default: + contentType = "application/json" + responseBody = "{}" + } + } + w.Header().Set("Content-Type", contentType) + _, _ = w.Write([]byte(responseBody)) } // handleV1Series handles the v1 series endpoint https://docs.datadoghq.com/api/latest/metrics/#submit-metrics diff --git a/receiver/datadogreceiver/receiver_test.go b/receiver/datadogreceiver/receiver_test.go index 7455ec45387f..1588f7240d13 100644 --- a/receiver/datadogreceiver/receiver_test.go +++ b/receiver/datadogreceiver/receiver_test.go @@ -75,8 +75,9 @@ func TestDatadogServer(t *testing.T) { }) for _, tc := range []struct { - name string - op io.Reader + name string + op io.Reader + endpoint string expectCode int expectContent string @@ -84,15 +85,31 @@ func TestDatadogServer(t *testing.T) { { name: "invalid data", op: strings.NewReader("{"), + endpoint: "http://%s/v0.7/traces", expectCode: http.StatusBadRequest, expectContent: "Unable to unmarshal reqs\n", }, { name: "Fake featuresdiscovery", op: nil, // Content-length: 0. + endpoint: "http://%s/v0.7/traces", expectCode: http.StatusBadRequest, expectContent: "Fake featuresdiscovery\n", }, + { + name: "Older version returns OK", + op: strings.NewReader("[]"), + endpoint: "http://%s/v0.3/traces", + expectCode: http.StatusOK, + expectContent: "OK", + }, + { + name: "Older version returns JSON", + op: strings.NewReader("[]"), + endpoint: "http://%s/v0.4/traces", + expectCode: http.StatusOK, + expectContent: "{}", + }, } { tc := tc t.Run(tc.name, func(t *testing.T) { @@ -100,7 +117,7 @@ func TestDatadogServer(t *testing.T) { req, err := http.NewRequest( http.MethodPost, - fmt.Sprintf("http://%s/v0.7/traces", dd.(*datadogReceiver).address), + fmt.Sprintf(tc.endpoint, dd.(*datadogReceiver).address), tc.op, ) require.NoError(t, err, "Must not error when creating request")