M hietala/merge remove enable telemetry function (#41009)

* init agents v1 with new operations

* update

* add samples

* aio

* update

* update

* updates

* update

* update

* update

* update

* update

* add create_thread_and_run

* create thread and process run

* add tests and update README (#40760)

* update README

* update tests

* fix sample

* adding tracing (#40769)

* Fix unit tests (#40783)

* Fix unit tests

* Record instrumentor tests

* modifying multiagent sample (#40799)

* Jhakulin/azure sdk review fixes (#40795)

Fix static analysis, updates from azure sdk reviews.

---------

Co-authored-by: nick863 <[email protected]>

* run black, fix some readme update snip issue (#40815)

* Howie/ffix toolcall (#40750)

* max retry and tests

* fix test

* Update samples csv data (#40821)

* update samples csv data

* add cspell

* Add ew artifact to list (#40833)

* [AI] [Agents] tool schema updates (#40841)

* [AI] [Agents] tool changes for Bing tools and Azure AI Search

* add implementation for abstract tool methods

* Remove packages not handled in the branch from the CI (#40842)

* Jhakulin/agents naming changes (#40845)

* naming changes

* update tests

* Record the tests and disable azue functions for now (#40852)

* Nirovins/record tests (#40854)

* Record the tests and disable azue functions for now

* Add recordings for azure functions

* Record instrumentation tests

---------

Co-authored-by: Jarno Hakulinen <[email protected]>

---------

Co-authored-by: Nikolay Rovinskiy <[email protected]>

* bring tests README back (#40858)

* Uncomment function tests (#40855)

* naming changes

* update names

* update

* update tests

* update

* Record the tests and disable azue functions for now (#40852)

* Nirovins/record tests (#40854)

* Record the tests and disable azue functions for now

* Add recordings for azure functions

* Record instrumentation tests

---------

Co-authored-by: Jarno Hakulinen <[email protected]>

* Uncomment function tests

* Fix

---------

Co-authored-by: jhakulin <[email protected]>

* Jhakulin/list op update (#40871)

* update list operations

* update tests

* update README

* update

* Fix the instrumentation tests (#40877)

* Fix the instrumentation tests

* Better instrumentation handling

* pylint

---------

Co-authored-by: Nikolay Rovinskiy <[email protected]>

* Howie/poll timeout (#40825)

* add timeout for polling

* fix merge

* fix merge

* fix merge

* fixed merge

* enable_auto_function_calls param changes (#40820)

* get CI green (#40884)

* fix logic app sample (#40883)

* agent azure monitor tracing sample updates (#40865)

* agent azure monitor tracing sample updates

* disable pylint for global statement

* agent tracing runid to feature branch (#40888)

* omit azure-ai-agents from pypy compatibility map

* [AI] [Agents] write initial CHANGELOG and add missing samples (#40891)

* [AI] [Agents] write initial CHANGELOG

* add sample for multiple connected agents

* add sample for connected agents

* update snippets

* try get green pipeline (#40914)

* resolved comments (#40922)

* update code owner (#40933)

* Howie/toolcall fix (#40939)

* update code owner

* fix tool call for async to be same as sync

* fix test

* Resolved Johan comments (#40943)

* resolved comments

* resolved comments

* Resolved comments

* change project label

* Hide the hack to use connection string. (#40945)

* FIx for function name changes (#40951)

* Remove Key Authentication (#40954)

* Remove Key Authentication

* Exclude samples

* Fix linter

* Fixed logger (#40957)

* clean up py (#40959)

* removing enable_trace function from agents telemetry

* removing an import of the removed function

* redoing change that was incorrectly merged

* removing one remaining enable_telemetry import

* adding instrumentor call to azure monitor tracing samples

* fixing multiagent sample trace configurator

* updating tracing snippet in readme

---------

Co-authored-by: jhakulin <[email protected]>
Co-authored-by: Nikolay Rovinskiy <[email protected]>
Co-authored-by: Howie Leung <[email protected]>
Co-authored-by: Glenn Harper <[email protected]>
Co-authored-by: Scott Beddall <[email protected]>

Author: 6 people

sdk/ai/azure-ai-agents/README.md

@@ -1172,10 +1172,13 @@ from azure.monitor.opentelemetry import configure_azure_monitor
 application_insights_connection_string = os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"]
 configure_azure_monitor(connection_string=application_insights_connection_string)
 
-# enable additional instrumentations
-from azure.ai.agents.telemetry import enable_telemetry
-
-enable_telemetry()
+try:
+    from azure.ai.agents.telemetry import AIAgentsInstrumentor
+    agents_instrumentor = AIAgentsInstrumentor()
+    if not agents_instrumentor.is_instrumented():
+        agents_instrumentor.instrument()
+except Exception as exc:  # pylint: disable=broad-exception-caught
+    print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
 
 scenario = os.path.basename(__file__)
 tracer = trace.get_tracer(__name__)

sdk/ai/azure-ai-agents/azure/ai/agents/telemetry/__init__.py

@@ -7,8 +7,7 @@
 # --------------------------------------------------------------------------
 
 from ._ai_agents_instrumentor import AIAgentsInstrumentor
-from ._utils import enable_telemetry
 from ._trace_function import trace_function
 
 
-__all__ = ["AIAgentsInstrumentor", "enable_telemetry", "trace_function"]
+__all__ = ["AIAgentsInstrumentor", "trace_function"]

sdk/ai/azure-ai-agents/azure/ai/agents/telemetry/_utils.py

@@ -3,12 +3,8 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-from typing import Any, Optional, TextIO, Union, cast
-
-import io
+from typing import Optional
 import logging
-import sys
-
 from enum import Enum
 
 from azure.core.tracing import AbstractSpan, SpanKind  # type: ignore
@@ -157,150 +153,3 @@ def start_span(
             span.add_attribute(GEN_AI_REQUEST_RESPONSE_FORMAT, response_format)
 
     return span
-
-
-# Internal helper functions to enable OpenTelemetry, used by both sync and async clients
-def _get_trace_exporter(destination: Union[TextIO, str, None]) -> Any:
-    if isinstance(destination, str):
-        # `destination` is the OTLP endpoint
-        # See: https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html#usage
-        try:
-            from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter  # type: ignore
-        except ModuleNotFoundError as e:
-            raise ModuleNotFoundError(
-                "OpenTelemetry OTLP exporter is not installed. "
-                + "Please install it using 'pip install opentelemetry-exporter-otlp-proto-grpc'"
-            ) from e
-        return OTLPSpanExporter(endpoint=destination)
-
-    if isinstance(destination, io.TextIOWrapper):
-        if destination is sys.stdout:
-            # See: https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.ConsoleSpanExporter # pylint: disable=line-too-long
-            try:
-                from opentelemetry.sdk.trace.export import ConsoleSpanExporter
-            except ModuleNotFoundError as e:
-                raise ModuleNotFoundError(
-                    "OpenTelemetry SDK is not installed. Please install it using 'pip install opentelemetry-sdk'"
-                ) from e
-
-            return ConsoleSpanExporter()
-        raise ValueError("Only `sys.stdout` is supported at the moment for type `TextIO`")
-
-    return None
-
-
-def _get_log_exporter(destination: Union[TextIO, str, None]) -> Any:
-    if isinstance(destination, str):
-        # `destination` is the OTLP endpoint
-        # See: https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html#usage
-        try:
-            # _logs are considered beta (not internal) in OpenTelemetry Python API/SDK.
-            # So it's ok to use it for local development, but we'll swallow
-            # any errors in case of any breaking changes on OTel side.
-            from opentelemetry.exporter.otlp.proto.grpc._log_exporter import OTLPLogExporter  # type: ignore  # pylint: disable=import-error,no-name-in-module
-        except Exception as ex:  # pylint: disable=broad-exception-caught
-            # since OTel logging is still in beta in Python, we're going to swallow any errors
-            # and just warn about them.
-            logger.warning("Failed to configure OpenTelemetry logging.", exc_info=ex)
-            return None
-
-        return OTLPLogExporter(endpoint=destination)
-
-    if isinstance(destination, io.TextIOWrapper):
-        if destination is sys.stdout:
-            # See: https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.ConsoleSpanExporter # pylint: disable=line-too-long
-            try:
-                from opentelemetry.sdk._logs.export import ConsoleLogExporter
-
-                return ConsoleLogExporter()
-            except ModuleNotFoundError as ex:
-                # since OTel logging is still in beta in Python, we're going to swallow any errors
-                # and just warn about them.
-                logger.warning("Failed to configure OpenTelemetry logging.", exc_info=ex)
-            return None
-        raise ValueError("Only `sys.stdout` is supported at the moment for type `TextIO`")
-
-    return None
-
-
-def _configure_tracing(span_exporter: Any) -> None:
-    if span_exporter is None:
-        return
-
-    try:
-        from opentelemetry import trace
-        from opentelemetry.sdk.trace import TracerProvider
-        from opentelemetry.sdk.trace.export import SimpleSpanProcessor
-    except ModuleNotFoundError as e:
-        raise ModuleNotFoundError(
-            "OpenTelemetry SDK is not installed. Please install it using 'pip install opentelemetry-sdk'"
-        ) from e
-
-    # if tracing was not setup before, we need to create a new TracerProvider
-    if not isinstance(trace.get_tracer_provider(), TracerProvider):
-        # If the provider is NoOpTracerProvider, we need to create a new TracerProvider
-        provider = TracerProvider()
-        trace.set_tracer_provider(provider)
-
-    # get_tracer_provider returns opentelemetry.trace.TracerProvider
-    # however, we have opentelemetry.sdk.trace.TracerProvider, which implements
-    # add_span_processor method, though we need to cast it to fix type checking.
-    provider = cast(TracerProvider, trace.get_tracer_provider())
-    provider.add_span_processor(SimpleSpanProcessor(span_exporter))
-
-
-def _configure_logging(log_exporter: Any) -> None:
-    if log_exporter is None:
-        return
-
-    try:
-        # _events and _logs are considered beta (not internal) in
-        # OpenTelemetry Python API/SDK.
-        # So it's ok to use them for local development, but we'll swallow
-        # any errors in case of any breaking changes on OTel side.
-        from opentelemetry import _logs, _events
-        from opentelemetry.sdk._logs import LoggerProvider  # pylint: disable=import-error,no-name-in-module
-        from opentelemetry.sdk._events import EventLoggerProvider  # pylint: disable=import-error,no-name-in-module
-        from opentelemetry.sdk._logs.export import (
-            SimpleLogRecordProcessor,
-        )  # pylint: disable=import-error,no-name-in-module
-
-        if not isinstance(_logs.get_logger_provider(), LoggerProvider):
-            logger_provider = LoggerProvider()
-            _logs.set_logger_provider(logger_provider)
-
-        # get_logger_provider returns opentelemetry._logs.LoggerProvider
-        # however, we have opentelemetry.sdk._logs.LoggerProvider, which implements
-        # add_log_record_processor method, though we need to cast it to fix type checking.
-        logger_provider = cast(LoggerProvider, _logs.get_logger_provider())
-        logger_provider.add_log_record_processor(SimpleLogRecordProcessor(log_exporter))
-        _events.set_event_logger_provider(EventLoggerProvider(logger_provider))
-    except Exception as ex:  # pylint: disable=broad-exception-caught
-        # since OTel logging is still in beta in Python, we're going to swallow any errors
-        # and just warn about them.
-        logger.warning("Failed to configure OpenTelemetry logging.", exc_info=ex)
-
-
-def enable_telemetry(destination: Union[TextIO, str, None] = None, **kwargs) -> None:  # pylint: disable=unused-argument
-    """Enable tracing and logging to console (sys.stdout), or to an OpenTelemetry Protocol (OTLP) endpoint.
-
-    :param destination: `sys.stdout` to print telemetry to console or a string holding the
-        OpenTelemetry protocol (OTLP) endpoint.
-        If not provided, this method enables instrumentation, but does not configure OpenTelemetry
-        SDK to export traces and logs.
-    :type destination: Union[TextIO, str, None]
-    """
-    span_exporter = _get_trace_exporter(destination)
-    _configure_tracing(span_exporter)
-
-    log_exporter = _get_log_exporter(destination)
-    _configure_logging(log_exporter)
-
-    try:
-        from azure.ai.agents.telemetry import AIAgentsInstrumentor
-
-        agents_instrumentor = AIAgentsInstrumentor()
-        if not agents_instrumentor.is_instrumented():
-            agents_instrumentor.instrument()
-    except Exception as exc:  # pylint: disable=broad-exception-caught
-        logger.warning("Could not call `AIAgentsInstrumentor().instrument()`", exc_info=exc)

sdk/ai/azure-ai-agents/samples/agents_multiagent/utils/agent_trace_configurator.py

@@ -9,7 +9,6 @@
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor, ConsoleSpanExporter
 from azure.ai.agents import AgentsClient
-from azure.ai.agents.telemetry import enable_telemetry
 from azure.monitor.opentelemetry import configure_azure_monitor
 
 
@@ -26,7 +25,13 @@ def enable_azure_monitor_tracing(self):
             print("Enable it via the 'Tracing' tab in your AI Foundry project page.")
             exit()
         configure_azure_monitor(connection_string=application_insights_connection_string)
-        enable_telemetry()
+        try:
+            from azure.ai.agents.telemetry import AIAgentsInstrumentor
+            agents_instrumentor = AIAgentsInstrumentor()
+            if not agents_instrumentor.is_instrumented():
+                agents_instrumentor.instrument()
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
 
     def enable_console_tracing_without_genai(self):
         exporter = ConsoleSpanExporter()
@@ -37,7 +42,18 @@ def enable_console_tracing_without_genai(self):
         print("Console tracing enabled without agent traces.")
 
     def enable_console_tracing_with_agent(self):
-        enable_telemetry(destination=sys.stdout)
+        span_exporter = ConsoleSpanExporter()
+        tracer_provider = TracerProvider()
+        tracer_provider.add_span_processor(SimpleSpanProcessor(span_exporter))
+        trace.set_tracer_provider(tracer_provider)
+        tracer = trace.get_tracer(__name__)
+        try:
+            from azure.ai.agents.telemetry import AIAgentsInstrumentor
+            agents_instrumentor = AIAgentsInstrumentor()
+            if not agents_instrumentor.is_instrumented():
+                agents_instrumentor.instrument()
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")        
         print("Console tracing enabled with agent traces.")
 
     def display_menu(self):

sdk/ai/azure-ai-agents/samples/agents_telemetry/sample_agents_basics_async_with_azure_monitor_tracing.py

@@ -52,10 +52,13 @@ async def main() -> None:
         application_insights_connection_string = os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"]
         configure_azure_monitor(connection_string=application_insights_connection_string)
 
-        # enable additional instrumentations
-        from azure.ai.agents.telemetry import enable_telemetry
-
-        enable_telemetry()
+        try:
+            from azure.ai.agents.telemetry import AIAgentsInstrumentor
+            agents_instrumentor = AIAgentsInstrumentor()
+            if not agents_instrumentor.is_instrumented():
+                agents_instrumentor.instrument()
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
 
         with tracer.start_as_current_span(scenario):
             async with agents_client:

sdk/ai/azure-ai-agents/samples/agents_telemetry/sample_agents_basics_async_with_console_tracing.py

@@ -37,7 +37,6 @@
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor, ConsoleSpanExporter
 from azure.ai.agents.aio import AgentsClient
 from azure.ai.agents.models import ListSortOrder, MessageTextContent
-from azure.ai.agents.telemetry import enable_telemetry
 from azure.identity.aio import DefaultAzureCredential
 from opentelemetry import trace
 import os

sdk/ai/azure-ai-agents/samples/agents_telemetry/sample_agents_basics_with_azure_monitor_tracing.py

@@ -46,10 +46,13 @@
 application_insights_connection_string = os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"]
 configure_azure_monitor(connection_string=application_insights_connection_string)
 
-# enable additional instrumentations
-from azure.ai.agents.telemetry import enable_telemetry
-
-enable_telemetry()
+try:
+    from azure.ai.agents.telemetry import AIAgentsInstrumentor
+    agents_instrumentor = AIAgentsInstrumentor()
+    if not agents_instrumentor.is_instrumented():
+        agents_instrumentor.instrument()
+except Exception as exc:  # pylint: disable=broad-exception-caught
+    print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
 
 scenario = os.path.basename(__file__)
 tracer = trace.get_tracer(__name__)

sdk/ai/azure-ai-agents/samples/agents_telemetry/sample_agents_stream_eventhandler_with_azure_monitor_tracing.py

@@ -82,14 +82,17 @@ def on_unhandled_event(self, event_type: str, event_data: Any) -> None:
 application_insights_connection_string = os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"]
 configure_azure_monitor(connection_string=application_insights_connection_string)
 
+try:
+    from azure.ai.agents.telemetry import AIAgentsInstrumentor
+    agents_instrumentor = AIAgentsInstrumentor()
+    if not agents_instrumentor.is_instrumented():
+        agents_instrumentor.instrument()
+except Exception as exc:  # pylint: disable=broad-exception-caught
+    print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
+
 scenario = os.path.basename(__file__)
 tracer = trace.get_tracer(__name__)
 
-# enable additional instrumentations
-from azure.ai.agents.telemetry import enable_telemetry
-
-enable_telemetry()
-
 with tracer.start_as_current_span(scenario):
     with agents_client:
         # Create an agent and run stream with event handler

sdk/ai/azure-ai-agents/samples/agents_telemetry/sample_agents_stream_eventhandler_with_console_tracing.py

@@ -46,7 +46,6 @@
     ThreadRun,
     RunStep,
 )
-from azure.ai.agents.telemetry import enable_telemetry
 from typing import Any
 from azure.ai.agents.telemetry import AIAgentsInstrumentor
 

sdk/ai/azure-ai-agents/samples/agents_telemetry/sample_agents_toolset_with_azure_monitor_tracing.py

@@ -39,7 +39,7 @@
 )
 from opentelemetry import trace
 from azure.monitor.opentelemetry import configure_azure_monitor
-from azure.ai.agents.telemetry import trace_function, enable_telemetry
+from azure.ai.agents.telemetry import trace_function
 
 agents_client = AgentsClient(
     endpoint=os.environ["PROJECT_ENDPOINT"],
@@ -50,8 +50,13 @@
 application_insights_connection_string = os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"]
 configure_azure_monitor(connection_string=application_insights_connection_string)
 
-# enable additional instrumentations if needed
-enable_telemetry()
+try:
+    from azure.ai.agents.telemetry import AIAgentsInstrumentor
+    agents_instrumentor = AIAgentsInstrumentor()
+    if not agents_instrumentor.is_instrumented():
+        agents_instrumentor.instrument()
+except Exception as exc:  # pylint: disable=broad-exception-caught
+    print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
 
 scenario = os.path.basename(__file__)
 tracer = trace.get_tracer(__name__)