Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def get_traceparent(headers: dict[str, str]) -> str | None:

Args:
headers: Dictionary of HTTP headers, typically obtained from
:meth:`OpenTelemetryScope.inject_context_to_headers`.
:meth:`microsoft_agents_a365.observability.core.opentelemetry_scope.OpenTelemetryScope.inject_context_to_headers`.

Returns:
The traceparent string (e.g.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
class AgentFrameworkSpanProcessor(SpanProcessor):
"""SpanProcessor for Agent Framework.

Attribute mutation happens in the enricher (via :class:`EnrichedReadableSpan`)
Attribute mutation happens in the enricher (via
:class:`microsoft_agents_a365.observability.core.exporters.enriched_span.EnrichedReadableSpan`)
because OTel Python ``ReadableSpan`` is immutable after ``on_end``.
The enricher is invoked at export time by the ``EnrichingSpanProcessor``.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ObservabilityHostingManager:
_instance: ObservabilityHostingManager | None = None

def __init__(self) -> None:
"""Private constructor — use :meth:`configure` instead."""
"""Private constructor — use :meth:`~microsoft_agents_a365.observability.hosting.middleware.observability_hosting_manager.ObservabilityHostingManager.configure` instead."""

@classmethod
def configure(
Expand All @@ -59,7 +59,7 @@ def configure(
options: Configuration options controlling which middleware to enable.

Returns:
The singleton :class:`ObservabilityHostingManager` instance.
The singleton :class:`~microsoft_agents_a365.observability.hosting.middleware.observability_hosting_manager.ObservabilityHostingManager` instance.

Raises:
TypeError: If *middleware_set* or *options* is ``None``.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ def _derive_channel(


class OutputLoggingMiddleware:
"""Middleware that creates :class:`OutputScope` spans for outgoing messages.
"""Middleware that creates :class:`microsoft_agents_a365.observability.core.spans_scopes.output_scope.OutputScope` spans for outgoing messages.

Links to a parent span when :data:`A365_PARENT_TRACEPARENT_KEY` is set in
Links to a parent span when :data:`~microsoft_agents_a365.observability.hosting.middleware.output_logging_middleware.A365_PARENT_TRACEPARENT_KEY` is set in
``turn_state``.

**Privacy note:** Outgoing message content is captured verbatim as span
Expand Down
Loading