|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from contextlib import AbstractContextManager, contextmanager |
| 4 | +from typing import TYPE_CHECKING, TypeAlias, TypeVar, cast |
| 5 | + |
| 6 | +from opentelemetry.propagate import get_global_textmap |
| 7 | +from opentelemetry.propagators.textmap import Setter, TextMapPropagator, default_setter |
| 8 | +from opentelemetry.trace import ( |
| 9 | + Span, |
| 10 | + SpanKind, |
| 11 | + TracerProvider, |
| 12 | + get_current_span, |
| 13 | + get_tracer_provider, |
| 14 | +) |
| 15 | + |
| 16 | +from connectrpc.errors import ConnectError |
| 17 | + |
| 18 | +from ._semconv import ( |
| 19 | + CLIENT_ADDRESS, |
| 20 | + CLIENT_PORT, |
| 21 | + ERROR_TYPE, |
| 22 | + RPC_METHOD, |
| 23 | + RPC_RESPONSE_STATUS_CODE, |
| 24 | + RPC_SYSTEM_NAME, |
| 25 | + SERVER_ADDRESS, |
| 26 | + SERVER_PORT, |
| 27 | + RpcSystemNameValues, |
| 28 | +) |
| 29 | +from ._version import __version__ |
| 30 | + |
| 31 | +if TYPE_CHECKING: |
| 32 | + from collections.abc import Iterator, MutableMapping |
| 33 | + |
| 34 | + from opentelemetry.util.types import AttributeValue |
| 35 | + |
| 36 | + from connectrpc.request import RequestContext |
| 37 | + |
| 38 | +REQ = TypeVar("REQ") |
| 39 | +RES = TypeVar("RES") |
| 40 | + |
| 41 | +Token: TypeAlias = tuple[AbstractContextManager, Span] |
| 42 | + |
| 43 | +# Workaround bad typing |
| 44 | +_DEFAULT_TEXTMAP_SETTER = cast("Setter[MutableMapping[str, str]]", default_setter) |
| 45 | + |
| 46 | + |
| 47 | +class OpenTelemetryInterceptor: |
| 48 | + """Interceptor to generate telemetry for RPC server and client requests.""" |
| 49 | + |
| 50 | + def __init__( |
| 51 | + self, |
| 52 | + *, |
| 53 | + propagator: TextMapPropagator | None = None, |
| 54 | + tracer_provider: TracerProvider | None = None, |
| 55 | + client: bool = False, |
| 56 | + ) -> None: |
| 57 | + """Creates a new OpenTelemetry interceptor. |
| 58 | +
|
| 59 | + Args: |
| 60 | + propagator: The OpenTelemetry TextMapPropagator to use. If not |
| 61 | + provided, the global default will be used. |
| 62 | + tracer_provider: The OpenTelemetry TracerProvider to use. If not |
| 63 | + provided, the global default will be used. |
| 64 | + client: Whether this interceptor is for a client or server. |
| 65 | + """ |
| 66 | + self._client = client |
| 67 | + tracer_provider = tracer_provider or get_tracer_provider() |
| 68 | + self._tracer = tracer_provider.get_tracer("connectrpc-otel", __version__) |
| 69 | + self._propagator = propagator or get_global_textmap() |
| 70 | + |
| 71 | + async def on_start(self, ctx: RequestContext) -> Token: |
| 72 | + return self.on_start_sync(ctx) |
| 73 | + |
| 74 | + def on_start_sync(self, ctx: RequestContext) -> Token: |
| 75 | + cm = self._start_span(ctx) |
| 76 | + span = cm.__enter__() |
| 77 | + return cm, span |
| 78 | + |
| 79 | + async def on_end( |
| 80 | + self, token: Token, ctx: RequestContext, error: Exception | None |
| 81 | + ) -> None: |
| 82 | + self.on_end_sync(token, ctx, error) |
| 83 | + |
| 84 | + def on_end_sync( |
| 85 | + self, token: Token, ctx: RequestContext, error: Exception | None |
| 86 | + ) -> None: |
| 87 | + cm, span = token |
| 88 | + self._finish_span(span, error) |
| 89 | + if error: |
| 90 | + cm.__exit__(type(error), error, error.__traceback__) |
| 91 | + else: |
| 92 | + cm.__exit__(None, None, None) |
| 93 | + |
| 94 | + @contextmanager |
| 95 | + def _start_span(self, ctx: RequestContext) -> Iterator[Span]: |
| 96 | + parent_otel_ctx = None |
| 97 | + if self._client: |
| 98 | + span_kind = SpanKind.CLIENT |
| 99 | + carrier = ctx.request_headers() |
| 100 | + self._propagator.inject(carrier, setter=_DEFAULT_TEXTMAP_SETTER) |
| 101 | + else: |
| 102 | + span_kind = SpanKind.SERVER |
| 103 | + parent_span = get_current_span() |
| 104 | + if not parent_span.get_span_context().is_valid: |
| 105 | + carrier = ctx.request_headers() |
| 106 | + parent_otel_ctx = self._propagator.extract(carrier) |
| 107 | + |
| 108 | + rpc_method = f"{ctx.method().service_name}/{ctx.method().name}" |
| 109 | + |
| 110 | + attrs: MutableMapping[str, AttributeValue] = { |
| 111 | + RPC_SYSTEM_NAME: RpcSystemNameValues.CONNECTRPC.value, |
| 112 | + RPC_METHOD: rpc_method, |
| 113 | + } |
| 114 | + if sa := ctx.server_address(): |
| 115 | + addr, port = sa.rsplit(":", 1) |
| 116 | + attrs[SERVER_ADDRESS] = addr |
| 117 | + attrs[SERVER_PORT] = int(port) |
| 118 | + if ca := ctx.client_address(): |
| 119 | + addr, port = ca.rsplit(":", 1) |
| 120 | + attrs[CLIENT_ADDRESS] = addr |
| 121 | + attrs[CLIENT_PORT] = int(port) |
| 122 | + |
| 123 | + with self._tracer.start_as_current_span( |
| 124 | + rpc_method, kind=span_kind, attributes=attrs, context=parent_otel_ctx |
| 125 | + ) as span: |
| 126 | + yield span |
| 127 | + |
| 128 | + def _finish_span(self, span: Span, error: Exception | None) -> None: |
| 129 | + if error: |
| 130 | + if isinstance(error, ConnectError): |
| 131 | + span.set_attribute(RPC_RESPONSE_STATUS_CODE, error.code.value) |
| 132 | + else: |
| 133 | + span.set_attribute(RPC_RESPONSE_STATUS_CODE, "unknown") |
| 134 | + span.set_attribute(ERROR_TYPE, type(error).__qualname__) |
0 commit comments