jararaca 0.3.23__tar.gz → 0.3.25__tar.gz

{jararaca-0.3.23 → jararaca-0.3.25}/PKG-INFO

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

{jararaca-0.3.23 → jararaca-0.3.25}/pyproject.toml

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

{jararaca-0.3.23 → jararaca-0.3.25}/src/jararaca/__init__.py

@@ -18,7 +18,13 @@ if TYPE_CHECKING:
         use_app_type,
     )
     from jararaca.observability.decorators import TracedClass, TracedFunc, traced_class
-    from jararaca.observability.hooks import spawn_trace
+    from jararaca.observability.hooks import (
+        add_event,
+        get_tracing_provider,
+        record_exception,
+        set_span_status,
+        spawn_trace,
+    )
     from jararaca.observability.interceptor import ObservabilityInterceptor
     from jararaca.observability.providers.otel import OtelObservabilityProvider
     from jararaca.persistence.sort_filter import (
@@ -228,6 +234,10 @@ if TYPE_CHECKING:
         "TracedClass",
         "traced_class",
         "spawn_trace",
+        "add_event",
+        "set_span_status",
+        "record_exception",
+        "get_tracing_provider",
         "QueryInjector",
         "HttpMicroservice",
         "use_current_container",
@@ -402,6 +412,10 @@ _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),
+    "add_event": (__SPEC_PARENT__, "observability.hooks", None),
+    "set_span_status": (__SPEC_PARENT__, "observability.hooks", None),
+    "record_exception": (__SPEC_PARENT__, "observability.hooks", None),
+    "get_tracing_provider": (__SPEC_PARENT__, "observability.hooks", None),
     "QueryInjector": (__SPEC_PARENT__, "persistence.utilities", None),
     "HttpMicroservice": (__SPEC_PARENT__, "presentation.http_microservice", None),
     "use_current_container": (__SPEC_PARENT__, "microservice", None),

{jararaca-0.3.23 → jararaca-0.3.25}/src/jararaca/observability/decorators.py

@@ -9,6 +9,7 @@ from typing import (
     Callable,
     ContextManager,
     Generator,
+    Literal,
     Mapping,
     Protocol,
     Sequence,
@@ -36,10 +37,25 @@ AttributeMap = Mapping[str, AttributeValue]
 
 class TracingContextProvider(Protocol):
 
-    def __call__(
+    def start_trace_context(
         self, trace_name: str, context_attributes: AttributeMap | None
     ) -> ContextManager[Any]: ...
 
+    def add_event(
+        self,
+        event_name: str,
+        event_attributes: AttributeMap | None = None,
+    ) -> None: ...
+
+    def set_span_status(self, status_code: Literal["OK", "ERROR", "UNSET"]) -> None: ...
+
+    def record_exception(
+        self,
+        exception: Exception,
+        attributes: AttributeMap | None = None,
+        escaped: bool = False,
+    ) -> None: ...
+
 
 class TracingContextProviderFactory(Protocol):
 
@@ -101,7 +117,7 @@ class TracedFunc:
         ) -> Any:
 
             if ctx_provider := get_tracing_ctx_provider():
-                with ctx_provider(
+                with ctx_provider.start_trace_context(
                     self.trace_name,
                     self.trace_mapper(*args, **kwargs),
                 ):

jararaca-0.3.25/src/jararaca/observability/hooks.py

@@ -0,0 +1,59 @@
+from contextlib import contextmanager
+from typing import Any, Generator, Literal
+
+from jararaca.observability.decorators import (
+    AttributeMap,
+    TracingContextProvider,
+    get_tracing_ctx_provider,
+)
+
+
+@contextmanager
+def spawn_trace(
+    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(
+            trace_name=name, context_attributes=attributes
+        ):
+            yield
+    else:
+        yield
+
+
+def add_event(
+    name: str,
+    attributes: AttributeMap | None = None,
+) -> None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        trace_context_provider.add_event(
+            event_name=name,
+            event_attributes=attributes,
+        )
+
+
+def set_span_status(status_code: Literal["OK", "ERROR", "UNSET"]) -> None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        trace_context_provider.set_span_status(status_code=status_code)
+
+
+def record_exception(
+    exception: Exception,
+    attributes: AttributeMap | None = None,
+    escaped: bool = False,
+) -> None:
+
+    if trace_context_provider := get_tracing_ctx_provider():
+        trace_context_provider.record_exception(
+            exception=exception,
+            attributes=attributes,
+            escaped=escaped,
+        )
+
+
+def get_tracing_provider() -> TracingContextProvider | None:
+    return get_tracing_ctx_provider()

{jararaca-0.3.23 → jararaca-0.3.25}/src/jararaca/observability/providers/otel.py

@@ -1,6 +1,6 @@
 import logging
 from contextlib import asynccontextmanager, contextmanager
-from typing import Any, AsyncGenerator, Generator, Protocol
+from typing import Any, AsyncGenerator, Generator, Literal, Protocol
 
 from opentelemetry import metrics, trace
 from opentelemetry._logs import set_logger_provider
@@ -50,7 +50,7 @@ class OtelTracingContextProvider(TracingContextProvider):
         self.app_context = app_context
 
     @contextmanager
-    def __call__(
+    def start_trace_context(
         self,
         trace_name: str,
         context_attributes: AttributeMap | None,
@@ -59,6 +59,29 @@ class OtelTracingContextProvider(TracingContextProvider):
         with tracer.start_as_current_span(trace_name, attributes=context_attributes):
             yield
 
+    def add_event(
+        self, event_name: str, event_attributes: AttributeMap | None = None
+    ) -> None:
+        trace.get_current_span().add_event(name=event_name, attributes=event_attributes)
+
+    def set_span_status(self, status_code: Literal["OK", "ERROR", "UNSET"]) -> None:
+        span = trace.get_current_span()
+        if status_code == "OK":
+            span.set_status(trace.Status(trace.StatusCode.OK))
+        elif status_code == "ERROR":
+            span.set_status(trace.Status(trace.StatusCode.ERROR))
+        else:
+            span.set_status(trace.Status(trace.StatusCode.UNSET))
+
+    def record_exception(
+        self,
+        exception: Exception,
+        attributes: AttributeMap | None = None,
+        escaped: bool = False,
+    ) -> None:
+        span = trace.get_current_span()
+        span.record_exception(exception, attributes=attributes, escaped=escaped)
+
 
 class OtelTracingContextProviderFactory(TracingContextProviderFactory):
 

jararaca-0.3.23/src/jararaca/observability/hooks.py

@@ -1,20 +0,0 @@
-from contextlib import contextmanager
-from typing import Any, Generator
-
-from jararaca.observability.decorators import AttributeMap, get_tracing_ctx_provider
-
-
-@contextmanager
-def spawn_trace(
-    name: str,
-    attributes: AttributeMap | None = None,
-) -> Generator[None, Any, None]:
-
-    if trace_context_provider := get_tracing_ctx_provider():
-        with trace_context_provider(trace_name=name, context_attributes=attributes):
-            yield
-    else:
-        yield
-
-
-spawn_trace