jararaca 0.3.26__tar.gz → 0.3.28__tar.gz

{jararaca-0.3.26 → jararaca-0.3.28}/PKG-INFO

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

{jararaca-0.3.26 → jararaca-0.3.28}/pyproject.toml

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

{jararaca-0.3.26 → jararaca-0.3.28}/src/jararaca/__init__.py

@@ -18,12 +18,17 @@ 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,
         get_tracing_provider,
         record_exception,
+        set_span_attribute,
         set_span_status,
         spawn_trace,
+        start_span,
     )
     from jararaca.observability.interceptor import ObservabilityInterceptor
     from jararaca.observability.providers.otel import OtelObservabilityProvider
@@ -233,8 +238,11 @@ if TYPE_CHECKING:
         "TracedFunc",
         "TracedClass",
         "traced_class",
+        "start_span",
         "spawn_trace",
+        "set_span_attribute",
         "add_event",
+        "setup_fastapi_exception_handler",
         "set_span_status",
         "record_exception",
         "get_tracing_provider",
@@ -412,6 +420,13 @@ _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_event": (__SPEC_PARENT__, "observability.hooks", None),
     "set_span_status": (__SPEC_PARENT__, "observability.hooks", None),
     "record_exception": (__SPEC_PARENT__, "observability.hooks", None),

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

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

{jararaca-0.3.26 → jararaca-0.3.28}/src/jararaca/observability/decorators.py

@@ -37,7 +37,7 @@ AttributeMap = Mapping[str, AttributeValue]
 
 class TracingContextProvider(Protocol):
 
-    def start_trace_context(
+    def start_span_context(
         self, trace_name: str, context_attributes: AttributeMap | None
     ) -> ContextManager[Any]: ...
 
@@ -56,7 +56,13 @@ class TracingContextProvider(Protocol):
         escaped: bool = False,
     ) -> None: ...
 
+    def set_span_attribute(
+        self,
+        key: str,
+        value: AttributeValue,
+    ) -> None: ...
 
+    def update_span_name(self, new_name: str) -> None: ...
 class TracingContextProviderFactory(Protocol):
 
     def root_setup(
@@ -117,7 +123,7 @@ class TracedFunc:
         ) -> Any:
 
             if ctx_provider := get_tracing_ctx_provider():
-                with ctx_provider.start_trace_context(
+                with ctx_provider.start_span_context(
                     self.trace_name,
                     self.trace_mapper(*args, **kwargs),
                 ):

jararaca-0.3.28/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.26 → jararaca-0.3.28}/src/jararaca/observability/hooks.py

@@ -1,21 +1,23 @@
+import logging
 from contextlib import contextmanager
 from typing import Any, Generator, Literal
 
 from jararaca.observability.decorators import (
     AttributeMap,
+    AttributeValue,
     TracingContextProvider,
     get_tracing_ctx_provider,
 )
 
 
 @contextmanager
-def spawn_trace(
+def start_span(
     name: str,
     attributes: AttributeMap | None = None,
 ) -> Generator[None, Any, None]:
 
     if trace_context_provider := get_tracing_ctx_provider():
-        with trace_context_provider.start_trace_context(
+        with trace_context_provider.start_span_context(
             trace_name=name, context_attributes=attributes
         ):
             yield
@@ -23,6 +25,19 @@ def spawn_trace(
         yield
 
 
+def spawn_trace(
+    name: str,
+    attributes: AttributeMap | None = None,
+) -> None:
+    logging.warning(
+        "spawn_trace is deprecated, use start_span as context manager instead."
+    )
+    if trace_context_provider := get_tracing_ctx_provider():
+        trace_context_provider.start_span_context(
+            trace_name=name, context_attributes=attributes
+        )
+
+
 def add_event(
     name: str,
     attributes: AttributeMap | None = None,
@@ -55,5 +70,17 @@ def record_exception(
         )
 
 
+def set_span_attribute(
+    key: str,
+    value: AttributeValue,
+) -> None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        trace_context_provider.set_span_attribute(
+            key=key,
+            value=value,
+        )
+
+
 def get_tracing_provider() -> TracingContextProvider | None:
     return get_tracing_ctx_provider()

{jararaca-0.3.26 → jararaca-0.3.28}/src/jararaca/observability/providers/otel.py

@@ -34,8 +34,10 @@ 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,
 )
@@ -50,7 +52,7 @@ class OtelTracingContextProvider(TracingContextProvider):
         self.app_context = app_context
 
     @contextmanager
-    def start_trace_context(
+    def start_span_context(
         self,
         trace_name: str,
         context_attributes: AttributeMap | None,
@@ -82,6 +84,14 @@ class OtelTracingContextProvider(TracingContextProvider):
         span = trace.get_current_span()
         span.record_exception(exception, attributes=attributes, escaped=escaped)
 
+    def set_span_attribute(self, key: str, value: AttributeValue) -> None:
+        span = trace.get_current_span()
+        span.set_attribute(key, value)
+
+    def update_span_name(self, new_name: str) -> None:
+        span = trace.get_current_span()
+        span.update_name(new_name)
+
 
 class OtelTracingContextProviderFactory(TracingContextProviderFactory):
 
@@ -185,10 +195,15 @@ 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)