Observability

Overview

The Observability context manager sends telemetry (metrics and traces) for all functions and methods annotated with the @observable decorator to a destination of your choice. This is useful for monitoring and debugging your application.

Observability is completely optional. To opt in, wrap your application code with the Observability context manager, for example:

from griptape.drivers import GriptapeCloudObservabilityDriver
from griptape.observability import Observability
from griptape.structures import Agent

observability_driver = GriptapeCloudObservabilityDriver()

with Observability(observability_driver=observability_driver):
    # Important! Only code within this block is subject to observability
    agent = Agent()
    agent.run("Name the five greatest rappers of all time")

Info

For available Drivers (and destinations), see Observability Drivers.

Tracing Custom Code

All functions and methods annotated with the @observable decorator will be traced when invoked within the context of the Observability context manager, including functions and methods defined outside of the Griptape framework. Thus to trace custom code, you just need to add the @observable decorator to your function or method, then invoke it within the Observability context manager.

For example:

import time

from griptape.common import observable
from griptape.drivers import GriptapeCloudObservabilityDriver
from griptape.observability import Observability


# Decorate a function
@observable
def my_function() -> None:
    time.sleep(3)


class MyClass:
    # Decorate a method
    @observable
    def my_method(self) -> None:
        time.sleep(1)
        my_function()
        time.sleep(2)


observability_driver = GriptapeCloudObservabilityDriver()

# When invoking the instrumented code from within the Observability context manager, the
# telemetry for the custom code will be sent to the destination specified by the driver.
with Observability(observability_driver=observability_driver):
    my_function()
    MyClass().my_method()