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

Respect suppress instrumentation key in gRPC client #559

Merged
merged 7 commits into from
Jul 14, 2021
Merged

Respect suppress instrumentation key in gRPC client #559

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
afe84d2
Respect suppress instrumentation key in gRPC client
RyanSiu1995 Jul 1, 2021
b0e315f
Lint the changed files
RyanSiu1995 Jul 1, 2021
ec8e94e
Merge branch 'main' into respect-suppress_instrumentation
lzchen Jul 9, 2021
c32cec4
Merge remote-tracking branch 'upstream/main' into respect-suppress_in…
RyanSiu1995 Jul 10, 2021
11b5b22
Add the CHANGELOG
RyanSiu1995 Jul 10, 2021
472db23
Merge branch 'main' into respect-suppress_instrumentation
RyanSiu1995 Jul 14, 2021
7bfc661
Merge branch 'main' into respect-suppress_instrumentation
Jul 14, 2021
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
9 changes: 8 additions & 1 deletion ...tion/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@

import grpc

from opentelemetry import trace
from opentelemetry import context, trace
from opentelemetry.instrumentation.grpc import grpcext
from opentelemetry.instrumentation.grpc._utilities import RpcInfo
from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
from opentelemetry.propagate import inject
from opentelemetry.propagators.textmap import Setter
from opentelemetry.semconv.trace import SpanAttributes
Expand Down Expand Up @@ -122,6 +123,9 @@ def _start_guarded_span(self, *args, **kwargs):
return _GuardedSpan(self._start_span(*args, **kwargs))

def intercept_unary(self, request, metadata, client_info, invoker):
if context.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this functionality need to be added to the server interceptor too?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From all the implementations under contrib repo,
_SUPPRESS_INSTRUMENTATION_KEY is mainly used under the client side instead of server side.
So, I did not implement the server side at first place.
My preference is first to make sure the client side works as expected.
Then, we can investigate the server side implementation later on.
I want to make each PR only containing a single feature.

Copy link
Member

@aabmass aabmass Jul 9, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should definitely be done for the server side as well if you get a chance 😃

@RyanSiu1995 do you mind commenting on #476 so I can assign it to you?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RyanSiu1995
Would you like to contribute that in a separate PR as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I will!

return invoker(request, metadata)

if not metadata:
mutable_metadata = OrderedDict()
else:
Expand Down Expand Up @@ -189,6 +193,9 @@ def _intercept_server_stream(
def intercept_stream(
self, request_or_iterator, metadata, client_info, invoker
):
if context.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
return invoker(request_or_iterator, metadata)

if client_info.is_server_stream:
return self._intercept_server_stream(
request_or_iterator, metadata, client_info, invoker
Expand Down
47 changes: 46 additions & 1 deletion instrumentation/opentelemetry-instrumentation-grpc/tests/test_client_interceptor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@
)

import opentelemetry.instrumentation.grpc
from opentelemetry import trace
from opentelemetry import context, trace
from opentelemetry.instrumentation.grpc import GrpcInstrumentorClient
from opentelemetry.instrumentation.grpc._client import (
OpenTelemetryClientInterceptor,
)
from opentelemetry.instrumentation.grpc.grpcext._interceptor import (
_UnaryClientInfo,
)
from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
from opentelemetry.propagate import get_global_textmap, set_global_textmap
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.test.mock_textmap import MockTextMapPropagator
Expand Down Expand Up @@ -286,3 +287,47 @@ def invoker(request, metadata):

finally:
set_global_textmap(previous_propagator)

def test_unary_unary_with_suppress_key(self):
token = context.attach(
context.set_value(_SUPPRESS_INSTRUMENTATION_KEY, True)
)
try:
simple_method(self._stub)
spans = self.memory_exporter.get_finished_spans()
finally:
context.detach(token)
self.assertEqual(len(spans), 0)

def test_unary_stream_with_suppress_key(self):
token = context.attach(
context.set_value(_SUPPRESS_INSTRUMENTATION_KEY, True)
)
try:
server_streaming_method(self._stub)
spans = self.memory_exporter.get_finished_spans()
finally:
context.detach(token)
self.assertEqual(len(spans), 0)

def test_stream_unary_with_suppress_key(self):
token = context.attach(
context.set_value(_SUPPRESS_INSTRUMENTATION_KEY, True)
)
try:
client_streaming_method(self._stub)
spans = self.memory_exporter.get_finished_spans()
finally:
context.detach(token)
self.assertEqual(len(spans), 0)

def test_stream_stream_with_suppress_key(self):
token = context.attach(
context.set_value(_SUPPRESS_INSTRUMENTATION_KEY, True)
)
try:
bidirectional_streaming_method(self._stub)
spans = self.memory_exporter.get_finished_spans()
finally:
context.detach(token)
self.assertEqual(len(spans), 0)