Skip to content

observability

__all__ = ['Observability'] module-attribute

Observability

Source code in griptape/observability/observability.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@define
class Observability:
    observability_driver: BaseObservabilityDriver = field(kw_only=True)

    @staticmethod
    def get_global_driver() -> BaseObservabilityDriver | None:
        return _global_observability_driver

    @staticmethod
    def set_global_driver(driver: BaseObservabilityDriver | None) -> 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() -> str | None:
        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: type[BaseException] | None,
        exc_value: BaseException | None,
        exc_traceback: TracebackType | None,
    ) -> 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 
45
46
47
48
49
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 
51
52
53
54
55
56
57
58
59
def __exit__(
    self,
    exc_type: type[BaseException] | None,
    exc_value: BaseException | None,
    exc_traceback: TracebackType | None,
) -> 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 
26
27
28
@staticmethod
def get_global_driver() -> BaseObservabilityDriver | None:
    return _global_observability_driver

get_span_id() staticmethod

Source code in griptape/observability/observability.py 
40
41
42
43
@staticmethod
def get_span_id() -> str | None:
    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 
35
36
37
38
@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 
30
31
32
33
@staticmethod
def set_global_driver(driver: BaseObservabilityDriver | None) -> None:
    global _global_observability_driver  # noqa: PLW0603
    _global_observability_driver = driver