Skip to content

Same agent Smaller bill. The tools and infrastructure to get more work from your AI. Fewer tokens. Less compute. Lower cost.

feat: add OpenTelemetry tracing PROMPTFLOW (ISSUE #842) (#959)

psbuildscc32e72b97e4
diff --git a/sdk/python/src/openlit/__init__.py b/sdk/python/src/openlit/__init__.py
index 6b814aac..0cb992f8 100644
--- a/sdk/python/src/openlit/__init__.py
+++ b/sdk/python/src/openlit/__init__.py
@@ -17,6 +17,8 @@ import requests
from opentelemetry import trace as t
from opentelemetry.trace import SpanKind, Status, StatusCode, Span
from opentelemetry.sdk.resources import SERVICE_NAME, DEPLOYMENT_ENVIRONMENT
+
+
from openlit.semcov import SemanticConvention
from openlit.otel.tracing import setup_tracing
from openlit.otel.metrics import setup_meter
@@ -34,6 +36,9 @@ import openlit.evals
# Set up logging for error and information messages.
logger = logging.getLogger(__name__)
+tracer = t.get_tracer(__name__)
+
+
class OpenlitConfig:
"""
@@ -88,7 +93,7 @@ class OpenlitConfig:
cls,
environment,
application_name,
- tracer,
+ otel_tracer,
event_provider,
otlp_endpoint,
otlp_headers,
@@ -107,7 +112,7 @@ class OpenlitConfig:
Args:
environment (str): Deployment environment.
application_name (str): Application name.
- tracer: Tracer instance.
+ otel_tracer: Tracer instance.
event_provider: Event logger provider instance.
meter: Metric Instance
otlp_endpoint (str): OTLP endpoint.
@@ -124,7 +129,7 @@ class OpenlitConfig:
cls.environment = environment
cls.application_name = application_name
cls.pricing_info = fetch_pricing_info(pricing_json)
- cls.tracer = tracer
+ cls.tracer = otel_tracer
cls.event_provider = event_provider
cls.metrics_dict = metrics_dict
cls.otlp_endpoint = otlp_endpoint
@@ -214,7 +219,7 @@ def init(
environment="default",
application_name="default",
service_name="default",
- tracer=None,
+ otel_tracer=None,
event_logger=None,
otlp_endpoint=None,
otlp_headers=None,
@@ -239,7 +244,7 @@ def init(
Args:
environment (str): Deployment environment.
application_name (str): Application name.
- tracer: Tracer instance (Optional).
+ otel_tracer: Tracer instance (Optional).
event_logger: EventLoggerProvider instance (Optional).
meter: OpenTelemetry Metrics Instance (Optional).
otlp_endpoint (str): OTLP endpoint for exporter (Optional).
@@ -327,16 +332,16 @@ def init(
config = OpenlitConfig()
# Setup tracing based on the provided or default configuration.
- tracer = setup_tracing(
+ configured_tracer = setup_tracing(
application_name=final_service_name,
environment=environment,
- tracer=tracer,
+ tracer=otel_tracer,
otlp_endpoint=otlp_endpoint,
otlp_headers=otlp_headers,
disable_batch=disable_batch,
)
- if not tracer:
+ if not configured_tracer:
logger.error("OpenLIT tracing setup failed. Tracing will not be available.")
return
@@ -380,7 +385,7 @@ def init(
config.update_config(
environment,
final_service_name,
- tracer,
+ otel_tracer,
event_provider,
otlp_endpoint,
otlp_headers,
@@ -533,25 +538,37 @@ def get_secrets(url=None, api_key=None, key=None, tags=None, should_set_env=None
# Prepare headers
headers = {"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"}
- try:
- # Make the POST request to the API with headers
- response = requests.post(endpoint, json=payload, headers=headers, timeout=120)
+ with tracer.start_as_current_span("promptflow.request") as span:
+ span.set_attribute("http.method", "POST")
+ span.set_attribute("http.url", endpoint)
- # Check if the response is successful
- response.raise_for_status()
+ try:
+ response = requests.post(
+ endpoint,
+ json=payload,
+ headers=headers,
+ timeout=120
+ )
- # Return the JSON response
- vault_response = response.json()
+ span.set_attribute("http.status_code", response.status_code)
- res = vault_response.get("res", [])
+ response.raise_for_status()
+ vault_response = response.json()
+
+ res = vault_response.get("res", [])
+
+ if should_set_env is True:
+ for token, value in res.items():
+ os.environ[token] = str(value)
+
+ return vault_response
+
+ except requests.RequestException as error:
+ span.record_exception(error)
+ span.set_status(Status(StatusCode.ERROR))
+ logger.error("Error fetching secrets: '%s'", error)
+ return None
- if should_set_env is True:
- for token, value in res.items():
- os.environ[token] = str(value)
- return vault_response
- except requests.RequestException as error:
- logger.error("Error fetching secrets: '%s'", error)
- return None
def trace(wrapped):
@@ -565,7 +582,7 @@ def trace(wrapped):
try:
__trace = t.get_tracer_provider()
- tracer = __trace.get_tracer(__name__)
+ otel_tracer = __trace.get_tracer(__name__)
except Exception as tracer_exception:
logging.error(
"Failed to initialize tracer: %s", tracer_exception, exc_info=True
@@ -574,7 +591,7 @@ def trace(wrapped):
@wraps(wrapped)
def wrapper(*args, **kwargs):
- with tracer.start_as_current_span(
+ with otel_tracer.start_as_current_span(
name=wrapped.__name__,
kind=SpanKind.CLIENT,
) as span:
diff --git a/sdk/python/src/openlit/instrumentation/agno/agno.py b/sdk/python/src/openlit/instrumentation/agno/agno.py
index 12d8e288..b4643f01 100644
--- a/sdk/python/src/openlit/instrumentation/agno/agno.py
+++ b/sdk/python/src/openlit/instrumentation/agno/agno.py
@@ -45,6 +45,10 @@ def agent_run_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract agent name for span naming with fallback to agent_id
agent_name = (
getattr(instance, "name", None)
@@ -110,6 +114,10 @@ def agent_run_tool_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract tool information for span naming
tool = args[1] if len(args) > 1 else None # tool: ToolExecution
tool_name = "unknown_tool"
@@ -174,6 +182,10 @@ def agent_continue_run_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
agent_name = getattr(instance, "name", "unknown")
span_name = f"continue {agent_name}"
@@ -231,6 +243,10 @@ def agent_add_tool_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
agent_name = getattr(instance, "name", "unknown")
span_name = f"agent {agent_name}"
@@ -288,6 +304,10 @@ def session_memory_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract method name from endpoint
method_name = gen_ai_endpoint.split(".")[-1]
span_name = f"memory {method_name.replace('get_', '').replace('_', ' ')}"
@@ -350,6 +370,10 @@ def model_run_function_call_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract function call information for span naming
function_call = args[0] if args else kwargs.get("function_call", None)
function_name = None
@@ -424,6 +448,10 @@ def function_call_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract function information
function_name = getattr(
instance, "name", getattr(instance, "__name__", "unknown_function")
@@ -485,6 +513,10 @@ def toolkit_run_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract toolkit information
toolkit_name = getattr(
instance,
@@ -549,6 +581,10 @@ def function_entrypoint_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract function information for span naming
function_name = getattr(instance, "name", None) or getattr(
instance, "__name__", "unknown_function"
@@ -610,6 +646,10 @@ def function_execute_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract function information
function_name = getattr(instance.function, "name", "unknown_function")
span_name = f"tool {function_name}"
@@ -741,6 +781,10 @@ def reasoning_tool_wrap(
if context_api.get_value(context_api._SUPPRESS_INSTRUMENTATION_KEY):
return wrapped(*args, **kwargs)
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
# Extract tool name from endpoint
tool_name = gen_ai_endpoint.split(".")[-1]
span_name = f"reasoning {tool_name}"
diff --git a/sdk/python/src/openlit/instrumentation/agno/async_agno.py b/sdk/python/src/openlit/instrumentation/agno/async_agno.py
index 8155c900..79ea9a78 100644
--- a/sdk/python/src/openlit/instrumentation/agno/async_agno.py
+++ b/sdk/python/src/openlit/instrumentation/agno/async_agno.py
@@ -40,6 +40,10 @@ def async_agent_run_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
# Extract agent name for span naming with fallback to agent_id
agent_name = (
getattr(instance, "name", None)
@@ -100,6 +104,10 @@ def async_agent_continue_run_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
agent_name = getattr(instance, "name", "unknown")
span_name = f"continue {agent_name}"
@@ -154,6 +162,10 @@ def async_model_run_function_call_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
# Extract function call information for span naming
function_call = args[0] if args else kwargs.get("function_call", None)
function_name = None
@@ -225,6 +237,12 @@ def async_agent_run_stream_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ async for item in wrapped(*args, **kwargs):
+ yield item
+ return
+
# Extract agent name for span naming with fallback to agent_id
agent_name = (
getattr(instance, "name", None)
@@ -319,6 +337,12 @@ def async_model_run_function_calls_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ async for item in wrapped(*args, **kwargs):
+ yield item
+ return
+
# Extract function calls information for span naming
function_calls = args[0] if args else []
function_names = []
@@ -399,6 +423,10 @@ def async_function_entrypoint_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
# Extract function information for span naming
function_name = getattr(instance, "name", None) or getattr(
instance, "__name__", "unknown_function"
@@ -456,6 +484,10 @@ def async_function_call_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
# Extract function information
function_name = getattr(
instance, "name", getattr(instance, "__name__", "unknown_function")
@@ -514,6 +546,9 @@ def async_memory_add_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
span_name = "memory add"
with tracer.start_as_current_span(span_name, kind=SpanKind.INTERNAL) as span:
@@ -566,6 +601,9 @@ def async_memory_search_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
span_name = "memory search"
with tracer.start_as_current_span(span_name, kind=SpanKind.INTERNAL) as span:
@@ -619,6 +657,9 @@ def async_vectordb_search_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
span_name = "vectordb search"
with tracer.start_as_current_span(span_name, kind=SpanKind.CLIENT) as span:
@@ -672,6 +713,9 @@ def async_knowledge_search_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
span_name = "knowledge search"
with tracer.start_as_current_span(span_name, kind=SpanKind.INTERNAL) as span:
@@ -728,6 +772,17 @@ def async_workflow_run_wrap(
"""
async def wrapper(wrapped, instance, args, kwargs):
+ # Check if tracer is available
+ if not tracer:
+ # Just call and handle async iterator if needed
+ result = wrapped(*args, **kwargs)
+ if hasattr(result, "__aiter__"):
+ async for event in result:
+ yield event
+ else:
+ return await result
+ return
+
workflow_name = getattr(instance, "name", "unknown_workflow")
span_name = f"workflow {workflow_name}"
diff --git a/sdk/python/src/openlit/instrumentation/openai/async_openai.py b/sdk/python/src/openlit/instrumentation/openai/async_openai.py
index 677458ca..d7a41d37 100644
--- a/sdk/python/src/openlit/instrumentation/openai/async_openai.py
+++ b/sdk/python/src/openlit/instrumentation/openai/async_openai.py
@@ -108,6 +108,10 @@ def async_chat_completions(
"""
streaming = kwargs.get("stream", False)
+
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -247,6 +251,10 @@ def async_responses(
"""
streaming = kwargs.get("stream", False)
+
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -312,6 +320,10 @@ def async_chat_completions_parse(
Wraps the OpenAI async chat completions parse call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -368,6 +380,10 @@ def async_embedding(
Wraps the OpenAI async embeddings call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -426,6 +442,10 @@ def async_image_generate(
Wraps the OpenAI async image generation call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -484,6 +504,10 @@ def async_image_variations(
Wraps the OpenAI async image variations call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -542,6 +566,10 @@ def async_audio_create(
Wraps the OpenAI async audio creation call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return await wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
diff --git a/sdk/python/src/openlit/instrumentation/openai/openai.py b/sdk/python/src/openlit/instrumentation/openai/openai.py
index 25fa4634..96bae118 100644
--- a/sdk/python/src/openlit/instrumentation/openai/openai.py
+++ b/sdk/python/src/openlit/instrumentation/openai/openai.py
@@ -108,6 +108,10 @@ def chat_completions(
"""
streaming = kwargs.get("stream", False)
+
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -248,6 +252,10 @@ def responses(
"""
streaming = kwargs.get("stream", False)
+
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -313,6 +321,10 @@ def chat_completions_parse(
Wraps the OpenAI chat completions parse call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -370,6 +382,10 @@ def embedding(
Wraps the OpenAI embeddings call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -429,6 +445,10 @@ def image_generate(
Wraps the OpenAI image generation call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -487,6 +507,10 @@ def image_variatons(
Wraps the OpenAI image variations call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)
@@ -545,6 +569,10 @@ def audio_create(
Wraps the OpenAI audio creation call.
"""
+ # Check if tracer is available
+ if not tracer:
+ return wrapped(*args, **kwargs)
+
server_address, server_port = set_server_address_and_port(
instance, "api.openai.com", 443
)