jararaca 0.3.27__tar.gz → 0.3.29__tar.gz

{jararaca-0.3.27 → jararaca-0.3.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jararaca
-Version: 0.3.27
+Version: 0.3.29
 Summary: A simple and fast API framework for Python
 Home-page: https://github.com/LuscasLeo/jararaca
 Author: Lucas S

{jararaca-0.3.27 → jararaca-0.3.29}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jararaca"
-version = "0.3.27"
+version = "0.3.29"
 description = "A simple and fast API framework for Python"
 authors = ["Lucas S <me@luscasleo.dev>"]
 readme = "README.md"

{jararaca-0.3.27 → jararaca-0.3.29}/src/jararaca/__init__.py

@@ -18,8 +18,14 @@ if TYPE_CHECKING:
         use_app_type,
     )
     from jararaca.observability.decorators import TracedClass, TracedFunc, traced_class
+    from jararaca.observability.fastapi_exception_handler import (
+        setup_fastapi_exception_handler,
+    )
     from jararaca.observability.hooks import (
         add_event,
+        add_span_link,
+        get_current_span,
+        get_current_span_context,
         get_tracing_provider,
         record_exception,
         set_span_attribute,
@@ -236,9 +242,13 @@ if TYPE_CHECKING:
         "TracedClass",
         "traced_class",
         "start_span",
+        "add_span_link",
+        "get_current_span",
+        "get_current_span_context",
         "spawn_trace",
         "set_span_attribute",
         "add_event",
+        "setup_fastapi_exception_handler",
         "set_span_status",
         "record_exception",
         "get_tracing_provider",
@@ -416,8 +426,16 @@ _dynamic_imports: "dict[str, tuple[str, str, str | None]]" = {
     "TracedClass": (__SPEC_PARENT__, "observability.decorators", None),
     "traced_class": (__SPEC_PARENT__, "observability.decorators", None),
     "spawn_trace": (__SPEC_PARENT__, "observability.hooks", None),
+    "setup_fastapi_exception_handler": (
+        __SPEC_PARENT__,
+        "observability.fastapi_exception_handler",
+        None,
+    ),
     "set_span_attribute": (__SPEC_PARENT__, "observability.hooks", None),
     "start_span": (__SPEC_PARENT__, "observability.hooks", None),
+    "add_span_link": (__SPEC_PARENT__, "observability.hooks", None),
+    "get_current_span": (__SPEC_PARENT__, "observability.hooks", None),
+    "get_current_span_context": (__SPEC_PARENT__, "observability.hooks", None),
     "add_event": (__SPEC_PARENT__, "observability.hooks", None),
     "set_span_status": (__SPEC_PARENT__, "observability.hooks", None),
     "record_exception": (__SPEC_PARENT__, "observability.hooks", None),

jararaca-0.3.29/src/jararaca/observability/constants.py

@@ -0,0 +1,3 @@
+TRACEPARENT_KEY = "traceparent"
+
+__all__ = ["TRACEPARENT_KEY"]

{jararaca-0.3.27 → jararaca-0.3.29}/src/jararaca/observability/decorators.py

@@ -35,6 +35,12 @@ AttributeValue = Union[
 AttributeMap = Mapping[str, AttributeValue]
 
 
+class TracingSpan(Protocol): ...
+
+
+class TracingSpanContext(Protocol): ...
+
+
 class TracingContextProvider(Protocol):
 
     def start_span_context(
@@ -63,6 +69,13 @@ class TracingContextProvider(Protocol):
     ) -> None: ...
 
     def update_span_name(self, new_name: str) -> None: ...
+
+    def add_link(self, span_context: TracingSpanContext) -> None: ...
+
+    def get_current_span(self) -> TracingSpan | None: ...
+    def get_current_span_context(self) -> TracingSpanContext | None: ...
+
+
 class TracingContextProviderFactory(Protocol):
 
     def root_setup(

jararaca-0.3.29/src/jararaca/observability/fastapi_exception_handler.py

@@ -0,0 +1,33 @@
+from fastapi import FastAPI, Request, Response
+from fastapi.exception_handlers import (
+    http_exception_handler,
+    request_validation_exception_handler,
+)
+from fastapi.exceptions import RequestValidationError
+from fastapi.responses import JSONResponse
+from starlette.exceptions import HTTPException
+
+from jararaca.observability.constants import TRACEPARENT_KEY
+
+
+def setup_fastapi_exception_handler(
+    app: FastAPI, trace_header_name: str = "traceparent"
+) -> None:
+    async def base_http_exception_handler(
+        request: Request, exc: HTTPException | RequestValidationError
+    ) -> JSONResponse | Response:
+
+        if isinstance(exc, RequestValidationError):
+            response = await request_validation_exception_handler(request, exc)
+            response.headers[trace_header_name] = request.scope.get(TRACEPARENT_KEY, "")
+            return response
+        else:
+            err_response = await http_exception_handler(request, exc)
+
+            err_response.headers[trace_header_name] = request.scope.get(
+                TRACEPARENT_KEY, ""
+            )
+            return err_response
+
+    app.exception_handlers[HTTPException] = base_http_exception_handler
+    app.exception_handlers[RequestValidationError] = base_http_exception_handler

{jararaca-0.3.27 → jararaca-0.3.29}/src/jararaca/observability/hooks.py

@@ -6,6 +6,8 @@ from jararaca.observability.decorators import (
     AttributeMap,
     AttributeValue,
     TracingContextProvider,
+    TracingSpan,
+    TracingSpanContext,
     get_tracing_ctx_provider,
 )
 
@@ -84,3 +86,23 @@ def set_span_attribute(
 
 def get_tracing_provider() -> TracingContextProvider | None:
     return get_tracing_ctx_provider()
+
+
+def get_current_span_context() -> TracingSpanContext | None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        return trace_context_provider.get_current_span_context()
+    return None
+
+
+def get_current_span() -> TracingSpan | None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        return trace_context_provider.get_current_span()
+    return None
+
+
+def add_span_link(span_context: TracingSpanContext) -> None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        trace_context_provider.add_link(span_context=span_context)

{jararaca-0.3.27 → jararaca-0.3.29}/src/jararaca/observability/providers/otel.py

@@ -2,7 +2,6 @@ import logging
 from contextlib import asynccontextmanager, contextmanager
 from typing import Any, AsyncGenerator, Generator, Literal, Protocol
 
-from fastapi import HTTPException
 from opentelemetry import metrics, trace
 from opentelemetry._logs import set_logger_provider
 from opentelemetry.baggage.propagation import W3CBaggagePropagator
@@ -35,17 +34,32 @@ from jararaca.microservice import (
     Microservice,
     use_app_transaction_context,
 )
+from jararaca.observability.constants import TRACEPARENT_KEY
 from jararaca.observability.decorators import (
     AttributeMap,
     AttributeValue,
     TracingContextProvider,
     TracingContextProviderFactory,
+    TracingSpan,
+    TracingSpanContext,
 )
 from jararaca.observability.interceptor import ObservabilityProvider
 
 tracer: trace.Tracer = trace.get_tracer(__name__)
 
 
+class OtelTracingSpan(TracingSpan):
+
+    def __init__(self, span: trace.Span) -> None:
+        self.span = span
+
+
+class OtelTracingSpanContext(TracingSpanContext):
+
+    def __init__(self, span_context: trace.SpanContext) -> None:
+        self.span_context = span_context
+
+
 class OtelTracingContextProvider(TracingContextProvider):
 
     def __init__(self, app_context: AppTransactionContext) -> None:
@@ -90,8 +104,21 @@ class OtelTracingContextProvider(TracingContextProvider):
 
     def update_span_name(self, new_name: str) -> None:
         span = trace.get_current_span()
+
         span.update_name(new_name)
 
+    def add_link(self, span_context: TracingSpanContext) -> None:
+        if not isinstance(span_context, OtelTracingSpanContext):
+            return
+        span = trace.get_current_span()
+        span.add_link(span_context.span_context)
+
+    def get_current_span(self) -> TracingSpan | None:
+        return OtelTracingSpan(trace.get_current_span())
+
+    def get_current_span_context(self) -> TracingSpanContext | None:
+        return OtelTracingSpanContext(trace.get_current_span().get_span_context())
+
 
 class OtelTracingContextProviderFactory(TracingContextProviderFactory):
 
@@ -195,25 +222,20 @@ class OtelTracingContextProviderFactory(TracingContextProviderFactory):
             },
         ) as root_span:
             cx = root_span.get_span_context()
+            span_traceparent_id = hex(cx.trace_id)[2:].rjust(32, "0")
             if app_tx_ctx.transaction_data.context_type == "http":
-                app_tx_ctx.transaction_data.response.headers["traceparent"] = hex(
-                    cx.trace_id
-                )[2:].rjust(32, "0")
+                app_tx_ctx.transaction_data.request.scope[TRACEPARENT_KEY] = (
+                    span_traceparent_id
+                )
+            elif app_tx_ctx.transaction_data.context_type == "websocket":
+                app_tx_ctx.transaction_data.websocket.scope[TRACEPARENT_KEY] = (
+                    span_traceparent_id
+                )
             tracing_headers: ImplicitHeaders = {}
             TraceContextTextMapPropagator().inject(tracing_headers)
             W3CBaggagePropagator().inject(tracing_headers)
             with provide_implicit_headers(tracing_headers):
-                try:
-                    yield
-                except HTTPException as http_exc:
-                    root_span.record_exception(http_exc)
-                    root_span.set_status(
-                        trace.Status(
-                            trace.StatusCode.ERROR,
-                            f"HTTP {http_exc.status_code}: {http_exc.detail}",
-                        )
-                    )
-                    raise
+                yield
 
 
 class LoggerHandlerCallback(Protocol):