Simplify OTel setup by setting more env variables ourselves

Author: pamelafox

.devcontainer/devcontainer.json

@@ -3,7 +3,7 @@
     "dockerComposeFile": "docker-compose.yml",
     "service": "app",
     "workspaceFolder": "/workspace",
-    "forwardPorts": [5432, 6379],
+    "forwardPorts": [5432, 6379, 18888],
     "features": {
         "ghcr.io/azure/azure-dev/azd:latest": {},
         "ghcr.io/devcontainers/features/azure-cli:latest": {}

.devcontainer/docker-compose.yml

@@ -8,6 +8,7 @@ services:
     command: sleep infinity
     environment:
       - OTEL_EXPORTER_OTLP_ENDPOINT=http://aspire-dashboard:18889
+      - OTEL_EXPORTER_OTLP_PROTOCOL=grpc
 
   db:
     image: pgvector/pgvector:pg17

.env.sample

@@ -12,6 +12,9 @@ GITHUB_TOKEN=YOUR-GITHUB-PERSONAL-ACCESS-TOKEN
 # Configure for Redis (used by agent_history_redis.py, defaults to dev container Redis):
 REDIS_URL=redis://localhost:6379
 OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+OTEL_EXPORTER_OTLP_PROTOCOL=grpc
+# Or use console exporters instead of OTLP:
+# ENABLE_CONSOLE_EXPORTERS=true
 # Configure for Azure AI Search (used by agent_knowledge_aisearch.py):
 AZURE_SEARCH_ENDPOINT=https://YOUR-SEARCH-SERVICE.search.windows.net
 AZURE_SEARCH_KNOWLEDGE_BASE_NAME=YOUR-KB-NAME

README.md

@@ -200,7 +200,7 @@ The Aspire Dashboard runs automatically as a service alongside the dev container
 2. Run the example:
 
     ```sh
-    uv run agent_otel_aspire.py
+    uv run examples/agent_otel_aspire.py
     ```
 
 3. Open the dashboard at <http://localhost:18888> and explore:

examples/agent_otel_aspire.py

@@ -5,7 +5,7 @@
 from datetime import datetime, timezone
 from typing import Annotated
 
-from agent_framework import ChatAgent
+from agent_framework import Agent, tool
 from agent_framework.observability import configure_otel_providers
 from agent_framework.openai import OpenAIChatClient
 from azure.identity.aio import DefaultAzureCredential, get_bearer_token_provider
@@ -20,18 +20,8 @@
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
 
-# Configure OpenTelemetry export to the Aspire Dashboard (if endpoint is set)
-otlp_endpoint = os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT")
-if otlp_endpoint:
-    os.environ.setdefault("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc")
-    os.environ.setdefault("OTEL_SERVICE_NAME", "agent-framework-demo")
-    configure_otel_providers(enable_sensitive_data=True)
-    logger.info(f"OpenTelemetry export enabled — sending to {otlp_endpoint}")
-else:
-    logger.info(
-        "Set OTEL_EXPORTER_OTLP_ENDPOINT in .env to export telemetry to the Aspire Dashboard. "
-        "Use http://aspire-dashboard:18889 in Codespaces/Dev Containers or http://localhost:4317 locally."
-    )
+# Configure OpenTelemetry based on environment variables
+configure_otel_providers(enable_sensitive_data=True)
 
 # Configure OpenAI client based on environment
 load_dotenv(override=True)
@@ -58,6 +48,7 @@
     )
 
 
+@tool
 def get_weather(
     city: Annotated[str, Field(description="City name, spelled out fully")],
 ) -> dict:
@@ -72,6 +63,7 @@ def get_weather(
     return random.choice(weather_options)
 
 
+@tool
 def get_current_time(
     timezone_name: Annotated[str, Field(description="Timezone name, e.g. 'US/Eastern', 'Asia/Tokyo', 'UTC'")],
 ) -> str:
@@ -81,9 +73,9 @@ def get_current_time(
     return f"The current time in {timezone_name} is approximately {now.strftime('%Y-%m-%d %H:%M:%S')} UTC"
 
 
-agent = ChatAgent(
+agent = Agent(
     name="weather-time-agent",
-    chat_client=client,
+    client=client,
     instructions="You are a helpful assistant that can look up weather and time information.",
     tools=[get_weather, get_current_time],
 )

examples/spanish/agent_otel_aspire.py

@@ -5,7 +5,7 @@
 from datetime import datetime, timezone
 from typing import Annotated
 
-from agent_framework import ChatAgent
+from agent_framework import Agent, tool
 from agent_framework.observability import configure_otel_providers
 from agent_framework.openai import OpenAIChatClient
 from azure.identity.aio import DefaultAzureCredential, get_bearer_token_provider
@@ -20,18 +20,8 @@
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
 
-# Configura la exportación de OpenTelemetry al Aspire Dashboard (si el endpoint está configurado)
-otlp_endpoint = os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT")
-if otlp_endpoint:
-    os.environ.setdefault("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc")
-    os.environ.setdefault("OTEL_SERVICE_NAME", "agent-framework-demo")
-    configure_otel_providers(enable_sensitive_data=True)
-    logger.info(f"Exportación OpenTelemetry habilitada — enviando a {otlp_endpoint}")
-else:
-    logger.info(
-        "Configura OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317 en .env"
-        " para exportar telemetría al Aspire Dashboard"
-    )
+# Configura OpenTelemetry (lee OTEL_EXPORTER_OTLP_* y ENABLE_CONSOLE_EXPORTERS del entorno)
+configure_otel_providers(enable_sensitive_data=True)
 
 # Configura el cliente para usar Azure OpenAI, GitHub Models u OpenAI
 load_dotenv(override=True)
@@ -58,6 +48,7 @@
     )
 
 
+@tool
 def get_weather(
     city: Annotated[str, Field(description="City name, spelled out fully")],
 ) -> dict:
@@ -72,6 +63,7 @@ def get_weather(
     return random.choice(weather_options)
 
 
+@tool
 def get_current_time(
     timezone_name: Annotated[
         str, Field(description="Timezone name, e.g. 'US/Eastern', 'America/Mexico_City', 'UTC'")
@@ -83,9 +75,9 @@ def get_current_time(
     return f"La hora actual en {timezone_name} es aproximadamente {now.strftime('%Y-%m-%d %H:%M:%S')} UTC"
 
 
-agent = ChatAgent(
+agent = Agent(
     name="weather-time-agent",
-    chat_client=client,
+    client=client,
     instructions="Eres un asistente útil que puede consultar información del clima y la hora.",
     tools=[get_weather, get_current_time],
 )