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.

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

fix(grpc): aio grpc client interceptor incorrect metadata handling #2363

Merged
merged 5 commits into from
Apr 18, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
fix(grpc): aio grpc client interceptor incorrect metadata handling
  • Loading branch information
legau committed Mar 20, 2024
commit 3c1c5a93d2282b9ca52cdce33b695eb29754ee4d
Original file line number Diff line number Diff line change
@@ -14,10 +14,9 @@

import functools
import logging
from collections import OrderedDict

import grpc
from grpc.aio import ClientCallDetails
from grpc.aio import ClientCallDetails, Metadata

from opentelemetry.instrumentation.grpc._client import (
OpenTelemetryClientInterceptor,
@@ -55,20 +54,19 @@ def callback(call):

class _BaseAioClientInterceptor(OpenTelemetryClientInterceptor):
@staticmethod
def propagate_trace_in_details(client_call_details):
def propagate_trace_in_details(client_call_details: ClientCallDetails):
metadata = client_call_details.metadata
if not metadata:
mutable_metadata = OrderedDict()
mutable_metadata = Metadata()
else:
mutable_metadata = OrderedDict(metadata)
mutable_metadata = Metadata(*tuple(metadata))
legau marked this conversation as resolved.
Show resolved Hide resolved

inject(mutable_metadata, setter=_carrier_setter)
metadata = tuple(mutable_metadata.items())

return ClientCallDetails(
client_call_details.method,
client_call_details.timeout,
metadata,
mutable_metadata,
client_call_details.credentials,
client_call_details.wait_for_ready,
)
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ async def simple_method(stub, error=False):
request = Request(
client_id=CLIENT_ID, request_data="error" if error else "data"
)
return await stub.SimpleMethod(request)
return await stub.SimpleMethod(request, metadata=(("key", "value"),))


async def client_streaming_method(stub, error=False):
@@ -41,7 +41,7 @@ def server_streaming_method(stub, error=False):
client_id=CLIENT_ID, request_data="error" if error else "data"
)

return stub.ServerStreamingMethod(request)
return stub.ServerStreamingMethod(request, metadata=(("key", "value"),))


def bidirectional_streaming_method(stub, error=False):
@@ -53,4 +53,6 @@ def request_messages():
)
yield request

return stub.BidirectionalStreamingMethod(request_messages())
return stub.BidirectionalStreamingMethod(
request_messages(), metadata=(("key", "value"),)
)
Original file line number Diff line number Diff line change
@@ -21,14 +21,14 @@ def simple_method(stub, error=False):
request = Request(
client_id=CLIENT_ID, request_data="error" if error else "data"
)
stub.SimpleMethod(request)
stub.SimpleMethod(request, metadata=(("key", "value"),))


def simple_method_future(stub, error=False):
request = Request(
client_id=CLIENT_ID, request_data="error" if error else "data"
)
return stub.SimpleMethod.future(request)
return stub.SimpleMethod.future(request, metadata=(("key", "value"),))


def client_streaming_method(stub, error=False):
@@ -40,14 +40,18 @@ def request_messages():
)
yield request

stub.ClientStreamingMethod(request_messages())
stub.ClientStreamingMethod(
request_messages(), metadata=(("key", "value"),)
)


def server_streaming_method(stub, error=False):
request = Request(
client_id=CLIENT_ID, request_data="error" if error else "data"
)
response_iterator = stub.ServerStreamingMethod(request)
response_iterator = stub.ServerStreamingMethod(
request, metadata=(("key", "value"),)
)
list(response_iterator)


@@ -59,6 +63,8 @@ def request_messages():
)
yield request

response_iterator = stub.BidirectionalStreamingMethod(request_messages())
response_iterator = stub.BidirectionalStreamingMethod(
request_messages(), metadata=(("key", "value"),)
)

list(response_iterator)
Original file line number Diff line number Diff line change
@@ -305,11 +305,10 @@ async def test_client_interceptor_trace_context_propagation(self):
await simple_method(stub)

metadata = recording_interceptor.recorded_details.metadata
assert len(metadata) == 2
assert metadata[0][0] == "mock-traceid"
assert metadata[0][1] == "0"
assert metadata[1][0] == "mock-spanid"
assert metadata[1][1] == "0"
assert len(metadata) == 3
assert metadata.get_all("key") == ["value"]
assert metadata.get_all("mock-traceid") == ["0"]
assert metadata.get_all("mock-spanid") == ["0"]
finally:
set_global_textmap(previous_propagator)

Loading