mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-29 21:23:55 +08:00
148 lines
4.8 KiB
Python
148 lines
4.8 KiB
Python
# Copyright The OpenTelemetry Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import grpc
|
|
|
|
from opentelemetry import trace
|
|
from opentelemetry.instrumentation.grpc import GrpcInstrumentorClient
|
|
from opentelemetry.test.test_base import TestBase
|
|
|
|
from ._client import simple_method
|
|
from ._server import create_test_server
|
|
from .protobuf import test_server_pb2_grpc
|
|
|
|
|
|
# User defined interceptor. Is used in the tests along with the opentelemetry client interceptor.
|
|
class Interceptor(
|
|
grpc.UnaryUnaryClientInterceptor,
|
|
grpc.UnaryStreamClientInterceptor,
|
|
grpc.StreamUnaryClientInterceptor,
|
|
grpc.StreamStreamClientInterceptor,
|
|
):
|
|
def __init__(self):
|
|
pass
|
|
|
|
def intercept_unary_unary(
|
|
self, continuation, client_call_details, request
|
|
):
|
|
return self._intercept_call(continuation, client_call_details, request)
|
|
|
|
def intercept_unary_stream(
|
|
self, continuation, client_call_details, request
|
|
):
|
|
return self._intercept_call(continuation, client_call_details, request)
|
|
|
|
def intercept_stream_unary(
|
|
self, continuation, client_call_details, request_iterator
|
|
):
|
|
return self._intercept_call(
|
|
continuation, client_call_details, request_iterator
|
|
)
|
|
|
|
def intercept_stream_stream(
|
|
self, continuation, client_call_details, request_iterator
|
|
):
|
|
return self._intercept_call(
|
|
continuation, client_call_details, request_iterator
|
|
)
|
|
|
|
@staticmethod
|
|
def _intercept_call(
|
|
continuation, client_call_details, request_or_iterator
|
|
):
|
|
return continuation(client_call_details, request_or_iterator)
|
|
|
|
|
|
def request_hook(span, request):
|
|
span.set_attribute("request_data", request.request_data)
|
|
|
|
|
|
def response_hook(span, response):
|
|
span.set_attribute("response_data", response.response_data)
|
|
|
|
|
|
def request_hook_with_exception(_span, _request):
|
|
raise Exception() # pylint: disable=broad-exception-raised
|
|
|
|
|
|
def response_hook_with_exception(_span, _response):
|
|
raise Exception() # pylint: disable=broad-exception-raised
|
|
|
|
|
|
class TestHooks(TestBase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.server = create_test_server(25565)
|
|
self.server.start()
|
|
# use a user defined interceptor along with the opentelemetry client interceptor
|
|
self.interceptors = [Interceptor()]
|
|
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
self.server.stop(None)
|
|
|
|
def test_response_and_request_hooks(self):
|
|
instrumentor = GrpcInstrumentorClient()
|
|
|
|
try:
|
|
instrumentor.instrument(
|
|
request_hook=request_hook,
|
|
response_hook=response_hook,
|
|
)
|
|
|
|
channel = grpc.insecure_channel("localhost:25565")
|
|
channel = grpc.intercept_channel(channel, *self.interceptors)
|
|
|
|
stub = test_server_pb2_grpc.GRPCTestServerStub(channel)
|
|
|
|
simple_method(stub)
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
span = spans[0]
|
|
|
|
self.assertEqual(span.name, "/GRPCTestServer/SimpleMethod")
|
|
self.assertIs(span.kind, trace.SpanKind.CLIENT)
|
|
|
|
self.assertIn("request_data", span.attributes)
|
|
self.assertEqual(span.attributes["request_data"], "data")
|
|
|
|
self.assertIn("response_data", span.attributes)
|
|
self.assertEqual(span.attributes["response_data"], "data")
|
|
finally:
|
|
instrumentor.uninstrument()
|
|
|
|
def test_hooks_with_exception(self):
|
|
instrumentor = GrpcInstrumentorClient()
|
|
|
|
try:
|
|
instrumentor.instrument(
|
|
request_hook=request_hook_with_exception,
|
|
response_hook=response_hook_with_exception,
|
|
)
|
|
|
|
channel = grpc.insecure_channel("localhost:25565")
|
|
channel = grpc.intercept_channel(channel, *self.interceptors)
|
|
|
|
stub = test_server_pb2_grpc.GRPCTestServerStub(channel)
|
|
|
|
simple_method(stub)
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
span = spans[0]
|
|
|
|
self.assertEqual(span.name, "/GRPCTestServer/SimpleMethod")
|
|
self.assertIs(span.kind, trace.SpanKind.CLIENT)
|
|
finally:
|
|
instrumentor.uninstrument()
|