Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[receiver/datadogreceiver] api/v2/series does not seem to support the datadog api client libraries #36079

Closed
jdgeisler opened this issue Oct 29, 2024 · 1 comment · Fixed by #36218
Closed

[receiver/datadogreceiver] api/v2/series does not seem to support the datadog api client libraries #36079

jdgeisler opened this issue Oct 29, 2024 · 1 comment · Fixed by #36218
Labels
bug Something isn't working needs triage New item requiring triage receiver/datadog

Comments

@jdgeisler
Copy link
Contributor

jdgeisler commented Oct 29, 2024 •
edited
Loading

Component(s)

receiver/datadog

What happened?

Description

We are using datadog api client libraries, such as the python library, to ship metrics to the /api/v2/series endpoint.

We have verified that the v2 api spec and request that we are sending is correct according to the datadog documentation, however we are getting 400 response errors such as proto: illegal wireType 6 and proto: wrong wireType = 0 for field Points

When using the api/v1/series instead, we are able to successfully ship metrics using the datadog client api library.

Looking in our logs and at the code, we see that these requests are likely failing here https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/datadogreceiver/internal/translator/series.go#L38-L41.

pl := new(gogen.MetricPayload)
if err := pl.Unmarshal(buf.Bytes()); err != nil {
	return mp, err
}

This could be because it is trying to unmarshal directly into a protobuf message from the datadog agent payload, but this fails because the datadog api request body is json.

Steps to Reproduce

  1. Try to ship metrics to the api/v2/series endpoint using the datadog api client library. Here is an example using the python library
  2. See that a 400 response is returned with the above protobuf errors

Expected Result

The api/v2/series endpoint can accept json requests from the datadog api client libraries

Actual Result

Metric requests to the api/v2/series endpoint from the datadog api client library fail with the above protobuf errors.

Collector version

v0.112.0

Environment information

Environment

OpenTelemetry Collector configuration

No response

Log output

2024-10-29 15:10:38.689	
2024-10-29T20:10:38.689Z	info	Metrics	{"kind": "exporter", "data_type": "metrics", "name": "debug", "resource metrics": 1, "metrics": 23, "data points": 27}
2024-10-29 15:10:31.566	
	net/http/server.go:2092
2024-10-29 15:10:31.566	
net/http.(*conn).serve
2024-10-29 15:10:31.566	
	net/http/server.go:3210
2024-10-29 15:10:31.566	
net/http.serverHandler.ServeHTTP
2024-10-29 15:10:31.566	
	go.opentelemetry.io/collector/config/confighttp@v0.112.0/clientinfohandler.go:26
2024-10-29 15:10:31.566	
go.opentelemetry.io/collector/config/confighttp.(*clientInfoHandler).ServeHTTP
2024-10-29 15:10:31.566	
	net/http/server.go:2220
2024-10-29 15:10:31.566	
net/http.HandlerFunc.ServeHTTP
2024-10-29 15:10:31.566	
	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp@v0.56.0/handler.go:65
2024-10-29 15:10:31.566	
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp.NewMiddleware.func1.1
2024-10-29 15:10:31.566	
	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp@v0.56.0/handler.go:171
2024-10-29 15:10:31.566	
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp.(*middleware).serveHTTP
2024-10-29 15:10:31.566	
	net/http/server.go:2220
2024-10-29 15:10:31.566	
net/http.HandlerFunc.ServeHTTP
2024-10-29 15:10:31.566	
	go.opentelemetry.io/collector/config/confighttp@v0.112.0/confighttp.go:553
2024-10-29 15:10:31.566	
go.opentelemetry.io/collector/config/confighttp.(*ServerConfig).ToServer.maxRequestBodySizeInterceptor.func2
2024-10-29 15:10:31.566	
	go.opentelemetry.io/collector/config/confighttp@v0.112.0/compression.go:175
2024-10-29 15:10:31.566	
go.opentelemetry.io/collector/config/confighttp.(*decompressor).ServeHTTP
2024-10-29 15:10:31.566	
	net/http/server.go:2747
2024-10-29 15:10:31.566	
net/http.(*ServeMux).ServeHTTP
2024-10-29 15:10:31.566	
	net/http/server.go:2220
2024-10-29 15:10:31.566	
net/http.HandlerFunc.ServeHTTP
2024-10-29 15:10:31.566	
	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/datadogreceiver@v0.112.0/receiver.go:305
2024-10-29 15:10:31.566	
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/datadogreceiver.(*datadogReceiver).handleV2Series
2024-10-29 15:10:31.566	
2024-10-29T20:10:31.566Z	error	datadogreceiver@v0.112.0/receiver.go:305	proto: illegal wireType 6

Additional context

No response
@jdgeisler jdgeisler added bug Something isn't working needs triage New item requiring triage labels Oct 29, 2024
@github-actions GitHub Actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot mentioned this issue Nov 5, 2024
Open
@jdgeisler jdgeisler mentioned this issue Nov 5, 2024
Merged
pull bot pushed a commit to abaguas/opentelemetry-collector-contrib that referenced this issue Nov 12, 2024
@jdgeisler @MovieStoreGuy @pull
[receiver/datadogreceiver] add json handling for the api/v2/series en…
7d162b0 
…dpoint (open-telemetry#36218)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Adding json handling for the `api/v2/series` endpoint. The datadog api
client libraries use json messages, however only protobuf messages are
currently supported in the` api/v2/series` endpoint, so requests fail
with `proto: illegal wireType 6`

If `Content-Type: application/json` is set, then we handle the json
message. Otherwise, we handle the protobuf message.

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes
open-telemetry#36079

<!--Describe what testing was performed and which tests were added.-->
#### Testing
Added test with a json metric payload that now passes.

Additionally, I also tested these changes in my own image and confirmed
that the datadog api client libraries can now successfully ship metrics
to the `api/v2/series` endpoint.

I also confirmed with the following curl:

```
curl -X POST \
  -H "Content-Type: application/json" \
  -H "DD-API-KEY: your_api_key_here" \
  -d '{
    "series": [
      {
        "resources": [
          {
            "name": "dummyhost",
            "type": "host"
          }
        ],
        "tags": ["env:test"],
        "metric": "test.metric",
        "points": [
          {
            "timestamp": 1730829575,
            "value": 1.0
          }
        ],
        "type": 3
      }
    ]
  }' \
  https://datadog-receiver/api/v2/series
{"errors":[]}
```

---------

Co-authored-by: Sean Marciniak <30928402+MovieStoreGuy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working needs triage New item requiring triage receiver/datadog
Projects
None yet
Milestone
No milestone
1 participant
@jdgeisler