[receiver/datadog]: follow receiver contract (#35975)

#35300
introduced a common methodology intended to be used by network receivers
to follow [the
contract](https://github.com/open-telemetry/opentelemetry-collector/blob/df3c9e38a80ccc3b14705462be2e2e51c628a3b3/receiver/doc.go#L10)
and maintain the correct order of operations. This PR re-uses that for
datadog.

Author: VihasMakwana

.chloggen/datagog-receiver-contract.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# 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. otlpreceiver)
+component: datadogreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Follow receiver contract based on type of error
+
+# One or more tracking issues or pull requests related to the change
+issues: [5909]
+
+# (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:
+
+# 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: []

receiver/datadogreceiver/go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/DataDog/datadog-agent/pkg/trace v0.58.0
 	github.com/DataDog/datadog-api-client-go/v2 v2.31.0
 	github.com/DataDog/sketches-go v1.4.6
+	github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal v0.112.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics v0.112.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/internal/sharedcomponent v0.112.0
 	github.com/stretchr/testify v1.9.0
@@ -19,6 +20,7 @@ require (
 	go.opentelemetry.io/collector/config/confighttp v0.112.0
 	go.opentelemetry.io/collector/confmap v1.18.0
 	go.opentelemetry.io/collector/consumer v0.112.0
+	go.opentelemetry.io/collector/consumer/consumererror v0.112.0
 	go.opentelemetry.io/collector/consumer/consumertest v0.112.0
 	go.opentelemetry.io/collector/pdata v1.18.0
 	go.opentelemetry.io/collector/receiver v0.112.0
@@ -72,7 +74,7 @@ require (
 	github.com/power-devops/perfstat v0.0.0-20220216144756-c35f1ee13d7c // indirect
 	github.com/rs/cors v1.11.1 // indirect
 	github.com/secure-systems-lab/go-securesystemslib v0.7.0 // indirect
-	github.com/shirou/gopsutil/v3 v3.24.4 // indirect
+	github.com/shirou/gopsutil/v3 v3.24.5 // indirect
 	github.com/shoenig/go-m1cpu v0.1.6 // indirect
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
 	github.com/tklauser/numcpus v0.6.1 // indirect
@@ -86,7 +88,6 @@ require (
 	go.opentelemetry.io/collector/config/configtelemetry v0.112.0 // indirect
 	go.opentelemetry.io/collector/config/configtls v1.18.0 // indirect
 	go.opentelemetry.io/collector/config/internal v0.112.0 // indirect
-	go.opentelemetry.io/collector/consumer/consumererror v0.112.0 // indirect
 	go.opentelemetry.io/collector/consumer/consumerprofiles v0.112.0 // indirect
 	go.opentelemetry.io/collector/extension v0.112.0 // indirect
 	go.opentelemetry.io/collector/extension/auth v0.112.0 // indirect
@@ -128,3 +129,5 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest
 replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/golden => ../../pkg/golden
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil => ../../pkg/pdatautil
+
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal => ../../internal/coreinternal

receiver/datadogreceiver/go.sum

@@ -21,6 +21,7 @@ import (
 	"go.opentelemetry.io/collector/receiver/receiverhelper"
 	"go.uber.org/zap"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/errorutil"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/datadogreceiver/internal/translator"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/datadogreceiver/internal/translator/header"
 )
@@ -237,7 +238,7 @@ func (ddr *datadogReceiver) handleTraces(w http.ResponseWriter, req *http.Reques
 		spanCount = otelTraces.SpanCount()
 		err = ddr.nextTracesConsumer.ConsumeTraces(obsCtx, otelTraces)
 		if err != nil {
-			http.Error(w, "Trace consumer errored out", http.StatusInternalServerError)
+			errorutil.HTTPError(w, err)
 			ddr.params.Logger.Error("Trace consumer errored out", zap.Error(err))
 			return
 		}
@@ -277,7 +278,7 @@ func (ddr *datadogReceiver) handleV1Series(w http.ResponseWriter, req *http.Requ
 
 	err = ddr.nextMetricsConsumer.ConsumeMetrics(obsCtx, metrics)
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		errorutil.HTTPError(w, err)
 		ddr.params.Logger.Error("metrics consumer errored out", zap.Error(err))
 		return
 	}
@@ -311,7 +312,7 @@ func (ddr *datadogReceiver) handleV2Series(w http.ResponseWriter, req *http.Requ
 
 	err = ddr.nextMetricsConsumer.ConsumeMetrics(obsCtx, metrics)
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		errorutil.HTTPError(w, err)
 		ddr.params.Logger.Error("metrics consumer errored out", zap.Error(err))
 		return
 	}
@@ -355,7 +356,7 @@ func (ddr *datadogReceiver) handleCheckRun(w http.ResponseWriter, req *http.Requ
 
 	err = ddr.nextMetricsConsumer.ConsumeMetrics(obsCtx, metrics)
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		errorutil.HTTPError(w, err)
 		ddr.params.Logger.Error("metrics consumer errored out", zap.Error(err))
 		return
 	}
@@ -386,7 +387,7 @@ func (ddr *datadogReceiver) handleSketches(w http.ResponseWriter, req *http.Requ
 
 	err = ddr.nextMetricsConsumer.ConsumeMetrics(obsCtx, metrics)
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		errorutil.HTTPError(w, err)
 		ddr.params.Logger.Error("metrics consumer errored out", zap.Error(err))
 		return
 	}
@@ -455,7 +456,7 @@ func (ddr *datadogReceiver) handleStats(w http.ResponseWriter, req *http.Request
 	err = ddr.nextMetricsConsumer.ConsumeMetrics(obsCtx, metrics)
 	if err != nil {
 		ddr.params.Logger.Error("Metrics consumer errored out", zap.Error(err))
-		http.Error(w, "Metrics consumer errored out", http.StatusInternalServerError)
+		errorutil.HTTPError(w, err)
 		return
 	}
 

receiver/datadogreceiver/receiver.go

@@ -19,6 +19,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/consumer"
+	"go.opentelemetry.io/collector/consumer/consumererror"
 	"go.opentelemetry.io/collector/consumer/consumertest"
 	"go.opentelemetry.io/collector/pdata/pcommon"
 	"go.opentelemetry.io/collector/pdata/pmetric"
@@ -116,6 +117,55 @@ func TestDatadogServer(t *testing.T) {
 	}
 }
 
+func TestDatadogResponse(t *testing.T) {
+	tests := []struct {
+		name           string
+		err            error
+		expectedStatus int
+	}{
+		{
+			name:           "non-permanent error",
+			err:            errors.New("non-permanenet error"),
+			expectedStatus: http.StatusServiceUnavailable,
+		},
+		{
+			name:           "permanent error",
+			err:            consumererror.NewPermanent(errors.New("non-permanenet error")),
+			expectedStatus: http.StatusBadRequest,
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			cfg := createDefaultConfig().(*Config)
+			cfg.Endpoint = "localhost:0" // Using a randomly assigned address
+			dd, err := newDataDogReceiver(
+				cfg,
+				receivertest.NewNopSettings(),
+			)
+			require.NoError(t, err, "Must not error when creating receiver")
+			dd.(*datadogReceiver).nextTracesConsumer = consumertest.NewErr(tc.err)
+
+			ctx, cancel := context.WithCancel(context.Background())
+			t.Cleanup(cancel)
+
+			require.NoError(t, dd.Start(ctx, componenttest.NewNopHost()))
+			t.Cleanup(func() {
+				require.NoError(t, dd.Shutdown(ctx), "Must not error shutting down")
+			})
+
+			apiPayload := pb.TracerPayload{}
+			var reqBytes []byte
+			bytez, _ := apiPayload.MarshalMsg(reqBytes)
+			req, err := http.NewRequestWithContext(ctx, http.MethodPost, fmt.Sprintf("http://%s/v0.7/traces", dd.(*datadogReceiver).address), bytes.NewReader(bytez))
+			require.NoError(t, err, "Must not error creating request")
+			resp, err := http.DefaultClient.Do(req)
+			require.NoError(t, err, "Must not error performing request")
+			require.Equal(t, tc.expectedStatus, resp.StatusCode)
+		})
+	}
+
+}
+
 func TestDatadogInfoEndpoint(t *testing.T) {
 	for _, tc := range []struct {
 		name            string