Datadog observability driver

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `DummyObservabilityDriver` as a no-op Observability Driver.
 - `OpenTelemetryObservabilityDriver` for sending observability data to an open telemetry collector or vendor.
 - `GriptapeCloudObservabilityDriver` for sending observability data to Griptape Cloud.
+- `DatadogObservabilityDriver` for sending observability data to a Datadog Agent.
 - `Observability` context manager for enabling observability and configuring which Observability Driver to use.
 - `@observable` decorator for selecting which functions/methods to provide observability for.
 

griptape/drivers/__init__.py

@@ -113,6 +113,7 @@
 from .observability.no_op_observability_driver import NoOpObservabilityDriver
 from .observability.open_telemetry_observability_driver import OpenTelemetryObservabilityDriver
 from .observability.griptape_cloud_observability_driver import GriptapeCloudObservabilityDriver
+from .observability.datadog_observability_driver import DatadogObservabilityDriver
 
 __all__ = [
     "BasePromptDriver",
@@ -211,4 +212,5 @@
     "NoOpObservabilityDriver",
     "OpenTelemetryObservabilityDriver",
     "GriptapeCloudObservabilityDriver",
+    "DatadogObservabilityDriver",
 ]

griptape/drivers/observability/datadog_observability_driver.py

@@ -0,0 +1,22 @@
+import os
+
+from attrs import Factory, define, field
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.trace import SpanProcessor
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+from griptape.drivers.observability.open_telemetry_observability_driver import OpenTelemetryObservabilityDriver
+
+
+@define
+class DatadogObservabilityDriver(OpenTelemetryObservabilityDriver):
+    datadog_agent_endpoint: str = field(
+        default=Factory(lambda: os.getenv("DD_AGENT_ENDPOINT", "http://localhost:4318")), kw_only=True
+    )
+    span_processor: SpanProcessor = field(
+        default=Factory(
+            lambda self: BatchSpanProcessor(OTLPSpanExporter(endpoint=self.datadog_agent_endpoint + "/v1/traces")),
+            takes_self=True,
+        ),
+        kw_only=True,
+    )

griptape/drivers/observability/open_telemetry_observability_driver.py

@@ -18,18 +18,28 @@
 
 @define
 class OpenTelemetryObservabilityDriver(BaseObservabilityDriver):
-    service_name: str = field(kw_only=True)
+    service_name: str = field(default="griptape", kw_only=True)
     span_processor: SpanProcessor = field(kw_only=True)
+    service_version: Optional[str] = field(default=None, kw_only=True)
+    deployment_env: Optional[str] = field(default=None, kw_only=True)
     trace_provider: TracerProvider = field(
         default=Factory(
-            lambda self: TracerProvider(resource=Resource(attributes={"service.name": self.service_name})),
+            lambda self: self._trace_provider_factory(),
             takes_self=True,
         ),
         kw_only=True,
     )
     _tracer: Optional[Tracer] = None
     _root_span_context_manager: Any = None
 
+    def _trace_provider_factory(self) -> TracerProvider:
+        attributes = {"service.name": self.service_name}
+        if self.service_version:
+            attributes["service.version"] = self.service_version
+        if self.deployment_env:
+            attributes["deployment.environment"] = self.deployment_env
+        return TracerProvider(resource=Resource(attributes=attributes))  # pyright: ignore[reportArgumentType]
+
     def __attrs_post_init__(self) -> None:
         self.trace_provider.add_span_processor(self.span_processor)
         self._tracer = get_tracer(self.service_name, tracer_provider=self.trace_provider)

pyproject.toml

@@ -127,6 +127,13 @@ drivers-observability-griptape-cloud = [
     "opentelemetry-instrumentation-threading",
     "opentelemetry-exporter-otlp-proto-http",
 ]
+drivers-observability-datadog = [
+    "opentelemetry-sdk",
+    "opentelemetry-api",
+    "opentelemetry-instrumentation",
+    "opentelemetry-instrumentation-threading",
+    "opentelemetry-exporter-otlp-proto-http",
+]
 
 loaders-dataframe = ["pandas"]
 loaders-pdf = ["pypdf"]

tests/unit/drivers/observability/test_datadog_observability_driver.py

@@ -0,0 +1,28 @@
+import os
+from unittest import mock
+
+from griptape.drivers import DatadogObservabilityDriver
+
+
+class TestDatadogTelemetryObservabilityDriver:
+    def test_init(self):
+        driver = DatadogObservabilityDriver()
+
+        assert driver.service_name == "griptape"
+        assert driver.datadog_agent_endpoint == "http://localhost:4318"
+
+    @mock.patch.dict(os.environ, {"DD_AGENT_ENDPOINT": "http://griptape.ai:1234"})
+    def test_init_env_var_dd_agent(self):
+        driver = DatadogObservabilityDriver()
+
+        assert driver.datadog_agent_endpoint == "http://griptape.ai:1234"
+
+    def test_init_set_dd_agent(self):
+        driver = DatadogObservabilityDriver(datadog_agent_endpoint="http://griptape.ai:4321")
+
+        assert driver.datadog_agent_endpoint == "http://griptape.ai:4321"
+
+    def test_init_set_service_name(self):
+        driver = DatadogObservabilityDriver(service_name="test")
+
+        assert driver.service_name == "test"

tests/unit/drivers/observability/test_open_telemetry_observability_driver.py

@@ -23,10 +23,23 @@ def span_processor(self, mock_span_exporter):
 
     @pytest.fixture()
     def driver(self, span_processor):
-        return OpenTelemetryObservabilityDriver(service_name="test", span_processor=span_processor)
+        return OpenTelemetryObservabilityDriver(span_processor=span_processor)
 
-    def test_init(self, span_processor):
-        OpenTelemetryObservabilityDriver(service_name="test", span_processor=span_processor)
+    def test_init_no_optional(self, span_processor):
+        driver = OpenTelemetryObservabilityDriver(span_processor=span_processor)
+
+        assert driver.service_name == "griptape"
+        assert driver.service_version is None
+        assert driver.deployment_env is None
+
+    def test_init_all_optional(self, span_processor):
+        driver = OpenTelemetryObservabilityDriver(
+            service_name="griptape", service_version="1.0", deployment_env="test", span_processor=span_processor
+        )
+
+        assert driver.service_name == "griptape"
+        assert driver.service_version == "1.0"
+        assert driver.deployment_env == "test"
 
     def test_context_manager_pass(self, driver, mock_span_exporter):
         expected_spans = ExpectedSpans(spans=[ExpectedSpan(name="main", parent=None, status_code=StatusCode.OK)])