feat: Add an example with observability (#15)

Author: jsonbailey

README.md

@@ -30,6 +30,25 @@ This repository includes examples for `OpenAI`, `Bedrock`, and `LangChain` for m
 1. Set the environment variable `OPENAI_API_KEY` to your OpenAI key.
 1. On the command line, run `poetry run openai-example`.
 
+#### Chat with observability (observability plugin example)
+
+This example demonstrates how to use the LaunchDarkly observability SDK plugin to monitor AI chat operations. For more details, see the [Python SDK observability reference](https://launchdarkly.com/docs/sdk/observability/python).
+
+1. Install the required dependencies with `poetry install -E observability` or `poetry install --all-extras`.
+1. Set the environment variable for your AI provider (e.g., `OPENAI_API_KEY`), or configure your AI Config to use a different provider.
+1. Optionally, set service identification:
+   ```bash
+   export SERVICE_NAME="my-ai-service"
+   export SERVICE_VERSION="1.0.0"
+   ```
+1. On the command line, run `poetry run chat-observability-example`.
+
+The observability plugin automatically captures and sends data to LaunchDarkly:
+- **Observability tab**: SDK operations, flag evaluations, error monitoring, logging, and distributed tracing
+- **AI Config Monitoring tab**: Token usage, duration, success/error rates, and custom metadata for filtering and analysis
+
+View your data in the LaunchDarkly dashboard under **Observability** tabs.
+
 #### Bedrock setup (single provider)
 
 1. Install the required dependencies with `poetry install -E bedrock` or `poetry install --all-extras`.

examples/chat_observability_example.py

@@ -0,0 +1,105 @@
+import os
+import asyncio
+import logging
+import ldclient
+from ldclient import Context
+from ldclient.config import Config
+from ldai import LDAIClient, AICompletionConfigDefault
+from ldobserve import ObservabilityConfig, ObservabilityPlugin
+
+logging.getLogger('ldclient').setLevel(logging.WARNING)
+
+# Set sdk_key to your LaunchDarkly SDK key.
+sdk_key = os.getenv('LAUNCHDARKLY_SDK_KEY')
+
+# Set config_key to the AI Config key you want to evaluate.
+ai_config_key = os.getenv('LAUNCHDARKLY_AI_CONFIG_KEY', 'sample-ai-config')
+
+# Service configuration for observability
+service_name = os.getenv('SERVICE_NAME', 'hello-python-ai-observability')
+service_version = os.getenv('SERVICE_VERSION', '1.0.0')
+
+
+async def async_main():
+    if not sdk_key:
+        print("*** Please set the LAUNCHDARKLY_SDK_KEY env first")
+        exit()
+
+
+    # Initialize LaunchDarkly SDK with observability plugin
+    ldclient.set_config(Config(
+        sdk_key,
+        plugins=[
+            ObservabilityPlugin(
+                ObservabilityConfig(
+                    service_name=service_name,
+                    service_version=service_version,
+                )
+            )
+        ]
+    ))
+
+    if not ldclient.get().is_initialized():
+        print("\n*** SDK failed to initialize. Please check your internet connection and SDK credential for any typo.")
+        exit()
+
+    aiclient = LDAIClient(ldclient.get())
+    print("*** SDK successfully initialized")
+
+    # Set up the evaluation context with custom attributes for filtering
+    context = (
+        Context
+        .builder('example-user-key')
+        .kind('user')
+        .name('Sandy')
+        .set('environment', 'observability-demo')
+        .set('tier', 'premium')
+        .build()
+    )
+
+    try:
+        # Create a chat instance with custom variables
+        default_value = AICompletionConfigDefault(enabled=False)
+        
+        chat = await aiclient.create_chat(
+            ai_config_key, 
+            context, 
+            default_value, 
+            {
+                'example_type': 'observability_demo',
+                'session_id': 'demo-session-123',
+                'feature': 'ai_chat'
+            }
+        )
+
+        if not chat:
+            print(f"*** AI chat configuration is not enabled for key: {ai_config_key}")
+            return
+
+        user_input_1 = "What is feature flagging in 2 sentences?"
+        print("User Input:", user_input_1)
+        
+        response_1 = await chat.invoke(user_input_1)
+        print("Chat Response:", response_1.message.content)
+
+        user_input_2 = "Give me a specific use case example."
+        print("\nUser Input:", user_input_2)
+        
+        response_2 = await chat.invoke(user_input_2)
+        print("Chat Response:", response_2.message.content)
+
+        print("\nSuccess.")
+
+    except Exception as err:
+        print("Error:", err)
+    finally:
+        ldclient.get().close()
+
+
+def main():
+    """Synchronous entry point for Poetry script."""
+    asyncio.run(async_main())
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -15,13 +15,15 @@ langchain-example = 'examples.langchain_example:main'
 langgraph-agent-example = 'examples.langgraph_agent_example:main'
 langgraph-multi-agent-example = 'examples.langgraph_multi_agent_example:main'
 chat-judge-example = 'examples.chat_judge_example:main'
+chat-observability-example = 'examples.chat_observability_example:main'
 direct-judge-example = 'examples.direct_judge_example:main'
 
 [tool.poetry.dependencies]
 python = "^3.10"
 launchdarkly-server-sdk-ai = "^0.14.0"
 launchdarkly-server-sdk-ai-langchain = "^0.3.0"
 launchdarkly-server-sdk-ai-openai = "^0.1.0"
+launchdarkly-observability = { version = ">=0.1.0", optional = true }
 
 boto3 = { version = ">=0.2.0", optional = true }
 openai = { version = ">=0.2.0", optional = true }
@@ -39,6 +41,7 @@ openai = ["openai"]
 gemini = ["google-genai"]
 langchain = ["langchain", "langchain-core", "langchain-openai", "langchain-google-genai", "langchain-aws"]
 langgraph = ["langgraph", "typing-extensions"]
+observability = ["launchdarkly-observability", "openai"]
 
 [build-system]
 requires = ["poetry-core"]