Disable JSON support in OTLP receiver #1178
Conversation
nilebox
requested review from
bogdandrutu,
dmitryax,
flands,
owais,
pjanotti,
rghetia,
songy23 and
tigrannajaryan
as code owners
| // Explicitly handle "application/json" encoding to return custom human friendly error | ||
| // See issue https://github.com/open-telemetry/opentelemetry-proto/issues/129 | ||
| // describing why we don't support JSON at the moment. | ||
| gatewayruntime.WithMarshalerOption("application/json", newJSONUnsupportedMarshaler()), |
There was a problem hiding this comment.
If we just override default * marshaler, it will return a binary protobuf response with the status message "Unexpected EOF", which might be confusing when users sent JSON payload with Content-Type: application/json header, so I've implemented a custom marshaler which returns a JSON response with a better error message:
{
"error": "'application/json' encoding is not supported",
"code": 3,
"message": "'application/json' encoding is not supported"
}
| @@ -0,0 +1,54 @@ | |||
| // Copyright 2020 The OpenTelemetry Authors | |||
There was a problem hiding this comment.
IIRC the year was removed from the license, but make addlicense still adds it.
| // describing why we don't support JSON at the moment. | ||
| gatewayruntime.WithMarshalerOption("application/json", newJSONUnsupportedMarshaler()), | ||
| // Override default JSON handling with Protobuf | ||
| gatewayruntime.WithMarshalerOption(gatewayruntime.MIMEWildcard, protobufMarshaler), |
There was a problem hiding this comment.
This is the main change in this PR - by default, gRPC Gateway is using JSON marshaler for any content type other than explicitly configured above, see https://github.com/grpc-ecosystem/grpc-gateway/blob/ee3ef70b7777cde4e61e4e224cb11e92beecee6a/runtime/marshaler_registry.go#L78. Here I changed it to use Protobuf marshaler by default.
Alternatively, we may require always setting Content-Type: application/x-protobuf explicitly and return an error for * wildcard here.
|
Closing this PR for now, since there's still an open discussion in #1177 |
nilebox
changed the title
nilebox
changed the title
…y#1178) Bumps [boto3](https://github.com/boto/boto3) from 1.20.45 to 1.20.46. - [Release notes](https://github.com/boto/boto3/releases) - [Changelog](https://github.com/boto/boto3/blob/develop/CHANGELOG.rst) - [Commits](boto/boto3@1.20.45...1.20.46) --- updated-dependencies: - dependency-name: boto3 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Description:
Disable support for JSON payload in OTLP receiver.
Return a JSON response with error message
'application/json' encoding is not supportedfor requests withContent-Type: application/json.Link to tracking Issue: Fixes #1177
Testing: Unit test
Documentation: -