rename the source metadata to channel

Author: nikhilc-microsoft

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/__init__.py

@@ -28,7 +28,7 @@
 from .middleware.baggage_builder import BaggageBuilder
 from .opentelemetry_scope import OpenTelemetryScope
 from .request import Request
-from .source_metadata import SourceMetadata
+from .channel import Channel
 from .tenant_details import TenantDetails
 from .tool_call_details import ToolCallDetails
 from .tool_type import ToolType
@@ -64,7 +64,7 @@
     "AgentDetails",
     "TenantDetails",
     "ToolCallDetails",
-    "SourceMetadata",
+    "Channel",
     "Request",
     "InferenceCallDetails",
     "ServiceEndpoint",

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/channel.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# Channel class.
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Channel:
+    """Channel information for agent execution context."""
+
+    name: str | None = None
+    link: str | None = None

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/execute_tool_scope.py

@@ -131,9 +131,9 @@ def __init__(
                 self.set_tag_maybe(SERVER_PORT_KEY, endpoint.port)
 
         # Set request metadata if provided
-        if request and request.source_metadata:
-            self.set_tag_maybe(CHANNEL_NAME_KEY, request.source_metadata.name)
-            self.set_tag_maybe(CHANNEL_LINK_KEY, request.source_metadata.description)
+        if request and request.channel:
+            self.set_tag_maybe(CHANNEL_NAME_KEY, request.channel.name)
+            self.set_tag_maybe(CHANNEL_LINK_KEY, request.channel.link)
 
     def record_response(self, response: str) -> None:
         """Records response information for telemetry tracking.

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/inference_scope.py

@@ -124,9 +124,9 @@ def __init__(
                 self.set_tag_maybe(SERVER_PORT_KEY, str(details.endpoint.port))
 
         # Set request metadata if provided
-        if request and request.source_metadata:
-            self.set_tag_maybe(CHANNEL_NAME_KEY, request.source_metadata.name)
-            self.set_tag_maybe(CHANNEL_LINK_KEY, request.source_metadata.description)
+        if request and request.channel:
+            self.set_tag_maybe(CHANNEL_NAME_KEY, request.channel.name)
+            self.set_tag_maybe(CHANNEL_LINK_KEY, request.channel.link)
 
     def record_input_messages(self, messages: List[str]) -> None:
         """Records the input messages for telemetry tracking.

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/invoke_agent_scope.py

@@ -149,9 +149,9 @@ def __init__(
 
         # Set request metadata if provided
         if request:
-            if request.source_metadata:
-                self.set_tag_maybe(CHANNEL_NAME_KEY, request.source_metadata.name)
-                self.set_tag_maybe(CHANNEL_LINK_KEY, request.source_metadata.description)
+            if request.channel:
+                self.set_tag_maybe(CHANNEL_NAME_KEY, request.channel.name)
+                self.set_tag_maybe(CHANNEL_LINK_KEY, request.channel.link)
 
             self.set_tag_maybe(
                 GEN_AI_EXECUTION_TYPE_KEY,

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/middleware/baggage_builder.py

@@ -28,7 +28,7 @@
     USER_ID_KEY,
     USER_NAME_KEY,
 )
-from ..utils import deprecated, validate_and_normalize_ip
+from ..utils import validate_and_normalize_ip
 
 logger = logging.getLogger(__name__)
 
@@ -177,16 +177,6 @@ def conversation_item_link(self, value: str | None) -> "BaggageBuilder":
         self._set(GEN_AI_CONVERSATION_ITEM_LINK_KEY, value)
         return self
 
-    @deprecated("Use channel_name() instead")
-    def source_metadata_name(self, value: str | None) -> "BaggageBuilder":
-        """Set the execution source metadata name (e.g., channel name)."""
-        return self.channel_name(value)
-
-    @deprecated("Use channel_links() instead")
-    def source_metadata_description(self, value: str | None) -> "BaggageBuilder":
-        """Set the execution source metadata description (e.g., channel description)."""
-        return self.channel_links(value)
-
     def session_id(self, value: str | None) -> "BaggageBuilder":
         """Set the session ID baggage value."""
         self._set(SESSION_ID_KEY, value)
@@ -203,7 +193,7 @@ def channel_name(self, value: str | None) -> "BaggageBuilder":
         return self
 
     def channel_links(self, value: str | None) -> "BaggageBuilder":
-        """Sets the channel link baggage value. (e.g., channel links or description)."""
+        """Sets the channel link baggage value."""
         self._set(CHANNEL_LINK_KEY, value)
         return self
 

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/request.py

@@ -6,7 +6,7 @@
 from dataclasses import dataclass
 
 from .execution_type import ExecutionType
-from .source_metadata import SourceMetadata
+from .channel import Channel
 
 
 @dataclass
@@ -16,4 +16,4 @@ class Request:
     content: str
     execution_type: ExecutionType
     session_id: str | None = None
-    source_metadata: SourceMetadata | None = None
+    channel: Channel | None = None

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/source_metadata.py

@@ -83,10 +83,10 @@ def _derive_conversation_id(context: TurnContext) -> str | None:
     return conv.id if conv else None
 
 
-def _derive_source_metadata(
+def _derive_channel(
     context: TurnContext,
 ) -> dict[str, str | None]:
-    """Derive source metadata (channel name and description) from TurnContext."""
+    """Derive channel (name and link) from TurnContext."""
     channel_id = getattr(context.activity, "channel_id", None)
     channel_name: str | None = None
     sub_channel: str | None = None
@@ -96,7 +96,7 @@ def _derive_source_metadata(
         elif hasattr(channel_id, "channel"):
             channel_name = channel_id.channel
             sub_channel = channel_id.sub_channel
-    return {"name": channel_name, "description": sub_channel}
+    return {"name": channel_name, "link": sub_channel}
 
 
 def _derive_execution_type(context: TurnContext) -> str | None:
@@ -131,7 +131,7 @@ async def on_turn(
 
         caller_details = _derive_caller_details(context)
         conversation_id = _derive_conversation_id(context)
-        source_metadata = _derive_source_metadata(context)
+        channel = _derive_channel(context)
         execution_type = _derive_execution_type(context)
 
         context.on_send_activities(
@@ -141,7 +141,7 @@ async def on_turn(
                 tenant_details,
                 caller_details,
                 conversation_id,
-                source_metadata,
+                channel,
                 execution_type,
             )
         )
@@ -155,7 +155,7 @@ def _create_send_handler(
         tenant_details: TenantDetails,
         caller_details: CallerDetails | None,
         conversation_id: str | None,
-        source_metadata: dict[str, str | None],
+        channel: dict[str, str | None],
         execution_type: str | None,
     ) -> Callable:
         """Create a send handler that wraps outgoing messages in OutputScope spans.
@@ -197,8 +197,8 @@ async def handler(
             # Set additional attributes on the scope
             output_scope.set_tag_maybe(GEN_AI_CONVERSATION_ID_KEY, conversation_id)
             output_scope.set_tag_maybe(GEN_AI_EXECUTION_TYPE_KEY, execution_type)
-            output_scope.set_tag_maybe(CHANNEL_NAME_KEY, source_metadata.get("name"))
-            output_scope.set_tag_maybe(CHANNEL_LINK_KEY, source_metadata.get("description"))
+            output_scope.set_tag_maybe(CHANNEL_NAME_KEY, channel.get("name"))
+            output_scope.set_tag_maybe(CHANNEL_LINK_KEY, channel.get("link"))
 
             if caller_details:
                 output_scope.set_tag_maybe(USER_ID_KEY, caller_details.caller_id)

libraries/microsoft-agents-a365-observability-hosting/microsoft_agents_a365/observability/hosting/middleware/output_logging_middleware.py

@@ -11,9 +11,9 @@
 
 from .utils import (
     get_caller_pairs,
+    get_channel_pairs,
     get_conversation_pairs,
     get_execution_type_pair,
-    get_source_metadata_pairs,
     get_target_agent_pairs,
     get_tenant_id_pair,
 )
@@ -27,7 +27,7 @@ def _iter_all_pairs(turn_context: TurnContext) -> Iterator[tuple[str, Any]]:
     yield from get_execution_type_pair(activity)
     yield from get_target_agent_pairs(activity)
     yield from get_tenant_id_pair(activity)
-    yield from get_source_metadata_pairs(activity)
+    yield from get_channel_pairs(activity)
     yield from get_conversation_pairs(activity)