[receiver/datadog] Implement '/info' endpoint #34772

lopes-felipe · 2024-08-20T18:43:47Z

Description:
The Datadog agent exposes a /info endpoint, communicating its available endpoints and capabilities.

This endpoint is used for the trace libraries to infer the features available in the queried agent, and make some decisions about the telemetry data at hand, including whether to send client stats for the local sampled spans used to calculate the trace metrics.

PS: in order to dynamically expose the available endpoints, this PR also does a minor refactor on the endpoint configuration structure, defining them in a []Endpoint rather than registering them directly in the ServeMux.

Link to tracking Issue:

Testing:

Documentation:

lopes-felipe · 2024-08-20T21:45:17Z

I'm having a bit of a hard time with the CI checks (as you can see from the list of "fix issues" commits) 😞

Any help on this would be really appreciated here. Thanks 🙂

Signed-off-by: Juraci Paixão Kröhling <[email protected]>

jpkrohling

I applied a couple of fixes and added comments about how to find and fix them. Let's see if the CI Lords are happy now.

jpkrohling · 2024-08-21T08:09:18Z

receiver/datadogreceiver/go.mod

@@ -4,6 +4,7 @@ go 1.22.0

 require (
 	github.com/DataDog/agent-payload/v5 v5.0.130
+	github.com/DataDog/datadog-agent/pkg/obfuscate v0.55.3


Because this component is included by other ones (like tests and the dev distribution), you need to run make gotidy. Running it here, it yielded these changes:

> git st On branch datadog-receiver/info-endpoint Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git restore <file>..." to discard changes in working directory) modified: receiver/datadogreceiver/go.sum modified: testbed/go.mod modified: testbed/go.sum

Hmm, good to know, thanks :)

jpkrohling · 2024-08-21T08:15:02Z

receiver/datadogreceiver/receiver_test.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"go.opentelemetry.io/collector/consumer"


This is failing the linter, as we require the imports to be split in three blocks: stdlib, third-party, local packages. This here is a third-party among the stdlib. You can run make lint from the component's directory, and it should this:

datadogreceiver/receiver_test.go:11: File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(github.com/open-telemetry/opentelemetry-collector-contrib) (gci) "go.opentelemetry.io/collector/consumer" datadogreceiver/receiver_test.go:20: File is not `gci`-ed with --skip-generated -s standard -s default -s prefix(github.com/open-telemetry/opentelemetry-collector-contrib) (gci) "go.opentelemetry.io/collector/component/componenttest" datadogreceiver/receiver_test.go:16: File is not `goimports`-ed with -local github.com/open-telemetry/opentelemetry-collector-contrib (goimports)

This is how it looks like:

diff --git a/receiver/datadogreceiver/receiver_test.go b/receiver/datadogreceiver/receiver_test.go index 76ab51d4c3..573e271ba8 100644 --- a/receiver/datadogreceiver/receiver_test.go +++ b/receiver/datadogreceiver/receiver_test.go @@ -8,7 +8,6 @@ import ( "context" "errors" "fmt" - "go.opentelemetry.io/collector/consumer" "io" "net/http" "strings" @@ -18,6 +17,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "go.opentelemetry.io/collector/component/componenttest" + "go.opentelemetry.io/collector/consumer" "go.opentelemetry.io/collector/consumer/consumertest" "go.opentelemetry.io/collector/pdata/pcommon" "go.opentelemetry.io/collector/pdata/pmetric"

Oh, that makes sense. Thanks!

lopes-felipe · 2024-08-21T13:51:38Z

I applied a couple of fixes and added comments about how to find and fix them. Let's see if the CI Lords are happy now.

It looks like they are! Thank you for the help ☺️

**Description:** <Describe what has changed.> Following up on #34772, this PR implements Datadog Agent's `/stats` endpoint, which is used for sending [client stats](https://github.com/DataDog/dd-trace-java/blob/master/communication/src/main/java/datadog/communication/ddagent/DDAgentFeaturesDiscovery.java#L40) of the [local sampled spans](https://github.com/DataDog/dd-trace-java/blob/master/dd-trace-core/src/main/java/datadog/trace/core/CoreTracer.java#L993-L1008) to calculate the [trace metrics](https://docs.datadoghq.com/tracing/metrics/metrics_namespace/). This PR also does a minor refactor in the usage of Datadog's common headers, moving from literal strings to centralized constants. **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> **Documentation:** <Describe the documentation added.>

**Description:** <Describe what has changed.> The Datadog agent exposes a `/info` [endpoint](https://github.com/DataDog/datadog-agent/blob/ab888632bb71bcd57716e3428ed4c242ed7b9aaa/pkg/trace/api/api.go#L205), communicating its available endpoints and capabilities. This endpoint is used for the [trace libraries](https://github.com/DataDog/dd-trace-java/blob/master/communication/src/main/java/datadog/communication/ddagent/DDAgentFeaturesDiscovery.java#L140-L173) to infer the features available in the queried agent, and make some decisions about the telemetry data at hand, including whether to send [client stats](https://github.com/DataDog/dd-trace-java/blob/master/communication/src/main/java/datadog/communication/ddagent/DDAgentFeaturesDiscovery.java#L40) for the [local sampled spans](https://github.com/DataDog/dd-trace-java/blob/master/dd-trace-core/src/main/java/datadog/trace/core/CoreTracer.java#L993-L1008) used to calculate the [trace metrics](https://docs.datadoghq.com/tracing/metrics/metrics_namespace/). PS: in order to dynamically expose the available endpoints, this PR also does a minor refactor on the endpoint configuration structure, defining them in a `[]Endpoint` rather than registering them directly in the `ServeMux`. **Link to tracking Issue:** **Testing:** **Documentation:** --------- Signed-off-by: Juraci Paixão Kröhling <[email protected]> Co-authored-by: Juraci Paixão Kröhling <[email protected]>

**Description:** <Describe what has changed.> Following up on open-telemetry#34772, this PR implements Datadog Agent's `/stats` endpoint, which is used for sending [client stats](https://github.com/DataDog/dd-trace-java/blob/master/communication/src/main/java/datadog/communication/ddagent/DDAgentFeaturesDiscovery.java#L40) of the [local sampled spans](https://github.com/DataDog/dd-trace-java/blob/master/dd-trace-core/src/main/java/datadog/trace/core/CoreTracer.java#L993-L1008) to calculate the [trace metrics](https://docs.datadoghq.com/tracing/metrics/metrics_namespace/). This PR also does a minor refactor in the usage of Datadog's common headers, moving from literal strings to centralized constants. **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> **Documentation:** <Describe the documentation added.>

lopes-felipe added 2 commits August 20, 2024 13:56

[receiver/datadogreceiver] Implement '/info' endpoint

a53d4b0

chore

abcf5eb

lopes-felipe requested review from jpkrohling and MovieStoreGuy as code owners August 20, 2024 18:43

lopes-felipe requested a review from a team August 20, 2024 18:43

github-actions bot assigned jpkrohling Aug 20, 2024

github-actions bot added the receiver/datadog label Aug 20, 2024

github-actions bot requested review from boostchicken and gouthamve August 20, 2024 18:44

lopes-felipe changed the title ~~[receiver/datadogreceiver] Implement '/info' endpoint~~ [receiver/datadog] Implement '/info' endpoint Aug 20, 2024

lopes-felipe added 3 commits August 20, 2024 15:53

Add changelog

081eaeb

Merge branch 'main' into datadog-receiver/info-endpoint

a56ab27

Fix code

9b93c32

github-actions bot added the cmd/otelcontribcol otelcontribcol command label Aug 20, 2024

lopes-felipe added 5 commits August 20, 2024 16:33

Fix issues

ee294dd

Fix issues

51d70db

Fix issues

a066511

Fix issues

1d1f791

Fix issues

e021e32

linting fixes

3ab3e5a

Signed-off-by: Juraci Paixão Kröhling <[email protected]>

github-actions bot added the testbed label Aug 21, 2024

jpkrohling approved these changes Aug 21, 2024

View reviewed changes

lopes-felipe mentioned this pull request Aug 21, 2024

[receiver/datadogreceiver] Implement '/stats' endpoint lopes-felipe/opentelemetry-collector-contrib#2

Closed

jpkrohling merged commit 8477a83 into open-telemetry:main Aug 21, 2024
156 checks passed

github-actions bot added this to the next release milestone Aug 21, 2024

lopes-felipe mentioned this pull request Aug 21, 2024

[receiver/datadog] Implement '/stats' endpoint #34790

Merged

lopes-felipe deleted the datadog-receiver/info-endpoint branch August 27, 2024 20:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[receiver/datadog] Implement '/info' endpoint #34772

[receiver/datadog] Implement '/info' endpoint #34772

lopes-felipe commented Aug 20, 2024 •

edited

Loading

lopes-felipe commented Aug 20, 2024 •

edited

Loading

jpkrohling left a comment

jpkrohling Aug 21, 2024

lopes-felipe Aug 21, 2024

jpkrohling Aug 21, 2024

lopes-felipe Aug 21, 2024

lopes-felipe commented Aug 21, 2024

[receiver/datadog] Implement '/info' endpoint #34772

[receiver/datadog] Implement '/info' endpoint #34772

Conversation

lopes-felipe commented Aug 20, 2024 • edited Loading

lopes-felipe commented Aug 20, 2024 • edited Loading

jpkrohling left a comment

Choose a reason for hiding this comment

jpkrohling Aug 21, 2024

Choose a reason for hiding this comment

lopes-felipe Aug 21, 2024

Choose a reason for hiding this comment

jpkrohling Aug 21, 2024

Choose a reason for hiding this comment

lopes-felipe Aug 21, 2024

Choose a reason for hiding this comment

lopes-felipe commented Aug 21, 2024

lopes-felipe commented Aug 20, 2024 •

edited

Loading

lopes-felipe commented Aug 20, 2024 •

edited

Loading