observability

Adapted from the Griptape AI Framework documentation.

__all__ = ['Observability'] module-attribute

Source Code in griptape/observability/observability.py

@define
class Observability:
    observability_driver: BaseObservabilityDriver = field(kw_only=True)

    @staticmethod
    def get_global_driver() -> Optional[BaseObservabilityDriver]:
        return _global_observability_driver

    @staticmethod
    def set_global_driver(driver: Optional[BaseObservabilityDriver]) -> None:
        global _global_observability_driver  # noqa: PLW0603
        _global_observability_driver = driver

    @staticmethod
    def observe(call: Observable.Call) -> Any:
        driver = Observability.get_global_driver() or _no_op_observability_driver
        return driver.observe(call)

    @staticmethod
    def get_span_id() -> Optional[str]:
        driver = Observability.get_global_driver() or _no_op_observability_driver
        return driver.get_span_id()

    def __enter__(self) -> None:
        if Observability.get_global_driver() is not None:
            raise ValueError("Observability driver already set.")
        Observability.set_global_driver(self.observability_driver)
        self.observability_driver.__enter__()

    def __exit__(
        self,
        exc_type: Optional[type[BaseException]],
        exc_value: Optional[BaseException],
        exc_traceback: Optional[TracebackType],
    ) -> bool:
        Observability.set_global_driver(None)
        self.observability_driver.__exit__(exc_type, exc_value, exc_traceback)
        return False

observability_driver = field(kw_only=True) class-attribute instance-attribute

enter()

Source Code in griptape/observability/observability.py

def __enter__(self) -> None:
    if Observability.get_global_driver() is not None:
        raise ValueError("Observability driver already set.")
    Observability.set_global_driver(self.observability_driver)
    self.observability_driver.__enter__()

exit(exc_type, exc_value, exc_traceback)

Source Code in griptape/observability/observability.py

def __exit__(
    self,
    exc_type: Optional[type[BaseException]],
    exc_value: Optional[BaseException],
    exc_traceback: Optional[TracebackType],
) -> bool:
    Observability.set_global_driver(None)
    self.observability_driver.__exit__(exc_type, exc_value, exc_traceback)
    return False

get_global_driver()staticmethod

Source Code in griptape/observability/observability.py

@staticmethod
def get_global_driver() -> Optional[BaseObservabilityDriver]:
    return _global_observability_driver

get_span_id()staticmethod

Source Code in griptape/observability/observability.py

@staticmethod
def get_span_id() -> Optional[str]:
    driver = Observability.get_global_driver() or _no_op_observability_driver
    return driver.get_span_id()

observe(call)staticmethod

Source Code in griptape/observability/observability.py

@staticmethod
def observe(call: Observable.Call) -> Any:
    driver = Observability.get_global_driver() or _no_op_observability_driver
    return driver.observe(call)

set_global_driver(driver)staticmethod

Source Code in griptape/observability/observability.py

@staticmethod
def set_global_driver(driver: Optional[BaseObservabilityDriver]) -> None:
    global _global_observability_driver  # noqa: PLW0603
    _global_observability_driver = driver