monocle-apptrace 0.3.1b1__py3-none-any.whl → 0.4.0__py3-none-any.whl

monocle_apptrace/instrumentation/common/span_handler.py

@@ -1,6 +1,6 @@
 import logging
 import os
-from importlib.metadata import version
+from contextlib import contextmanager
 from opentelemetry.context import get_value, set_value, attach, detach
 from opentelemetry.sdk.trace import Span
 from opentelemetry.trace.status import Status, StatusCode
@@ -8,9 +8,9 @@ from monocle_apptrace.instrumentation.common.constants import (
     QUERY,
     service_name_map,
     service_type_map,
-    MONOCLE_SDK_VERSION
+    MONOCLE_SDK_VERSION, MONOCLE_SDK_LANGUAGE, MONOCLE_DETECTED_SPAN_ERROR
 )
-from monocle_apptrace.instrumentation.common.utils import set_attribute, get_scopes, MonocleSpanException
+from monocle_apptrace.instrumentation.common.utils import set_attribute, get_scopes, MonocleSpanException, get_monocle_version
 from monocle_apptrace.instrumentation.common.constants import WORKFLOW_TYPE_KEY, WORKFLOW_TYPE_GENERIC
 
 logger = logging.getLogger(__name__)
@@ -18,7 +18,8 @@ logger = logging.getLogger(__name__)
 WORKFLOW_TYPE_MAP = {
     "llama_index": "workflow.llamaindex",
     "langchain": "workflow.langchain",
-    "haystack": "workflow.haystack"
+    "haystack": "workflow.haystack",
+    "teams.ai": "workflow.teams_ai",
 }
 
 class SpanHandler:
@@ -39,23 +40,30 @@ class SpanHandler:
         pass
 
     def skip_span(self, to_wrap, wrapped, instance, args, kwargs) -> bool:
-        # If this is a workflow span type and a workflow span is already generated, then skip generating this span
-        if to_wrap.get('span_type') == "workflow" and self.is_workflow_span_active():
-            return True
         return False
 
+    def skip_processor(self, to_wrap, wrapped, instance, span, args, kwargs) -> list[str]:
+        return []
+    
+    def set_span_type(self, to_wrap, wrapped, instance, output_processor, span:Span, args, kwargs) -> str:
+        span_type:str = None
+        if 'type' in output_processor:
+            span_type = output_processor['type']
+            span.set_attribute("span.type", span_type)
+        else:
+            logger.warning("type of span not found or incorrect written in entity json")
+        return span_type
+
     def pre_task_processing(self, to_wrap, wrapped, instance, args,kwargs, span):
         if "pipeline" in to_wrap['package']:
             set_attribute(QUERY, args[0]['prompt_builder']['question'])
 
     @staticmethod
-    def set_default_monocle_attributes(span: Span):
+    def set_default_monocle_attributes(span: Span, source_path = "" ):
         """ Set default monocle attributes for all spans """
-        try:
-            sdk_version = version("monocle_apptrace")
-            span.set_attribute(MONOCLE_SDK_VERSION, sdk_version)
-        except Exception as e:
-            logger.warning("Exception finding monocle-apptrace version.")
+        span.set_attribute(MONOCLE_SDK_VERSION, get_monocle_version())
+        span.set_attribute(MONOCLE_SDK_LANGUAGE, "python")
+        span.set_attribute("span_source", source_path)
         for scope_key, scope_value in get_scopes().items():
             span.set_attribute(f"scope.{scope_key}", scope_value)
 
@@ -64,28 +72,38 @@ class SpanHandler:
         """ Set attributes of workflow if this is a root span"""
         SpanHandler.set_workflow_attributes(to_wrap, span)
         SpanHandler.set_app_hosting_identifier_attribute(span)
-        span.set_status(StatusCode.OK)
 
+    @staticmethod
+    def set_non_workflow_properties(span: Span, to_wrap = None):
+        workflow_name = SpanHandler.get_workflow_name(span=span)
+        if workflow_name:
+            span.set_attribute("workflow.name", workflow_name)
+        span.set_attribute("span.type", "generic")
 
     def post_task_processing(self, to_wrap, wrapped, instance, args, kwargs, result, span:Span):
-        if span.status.status_code == StatusCode.UNSET:
-            span.set_status(StatusCode.OK)
+        pass
 
-    def hydrate_span(self, to_wrap, wrapped, instance, args, kwargs, result, span):
-        self.hydrate_attributes(to_wrap, wrapped, instance, args, kwargs, result, span)
-        self.hydrate_events(to_wrap, wrapped, instance, args, kwargs, result, span)
+    def hydrate_span(self, to_wrap, wrapped, instance, args, kwargs, result, span, parent_span = None, ex:Exception = None) -> bool:
+        try:
+            detected_error_in_attribute = self.hydrate_attributes(to_wrap, wrapped, instance, args, kwargs, result, span)
+            detected_error_in_event = self.hydrate_events(to_wrap, wrapped, instance, args, kwargs, result, span, parent_span, ex)
+            if detected_error_in_attribute or detected_error_in_event:
+                span.set_attribute(MONOCLE_DETECTED_SPAN_ERROR, True)
+        finally:
+            if span.status.status_code == StatusCode.UNSET and ex is None:
+                span.set_status(StatusCode.OK)
 
-    def hydrate_attributes(self, to_wrap, wrapped, instance, args, kwargs, result, span):
+    def hydrate_attributes(self, to_wrap, wrapped, instance, args, kwargs, result, span:Span) -> bool:
+        detected_error:bool = False
         span_index = 0
         if SpanHandler.is_root_span(span):
             span_index = 2 # root span will have workflow and hosting entities pre-populated
-        if 'output_processor' in to_wrap and to_wrap["output_processor"] is not None:    
+        if 'output_processor' in to_wrap and to_wrap["output_processor"] is not None:
             output_processor=to_wrap['output_processor']
-            if 'type' in output_processor:
-                        span.set_attribute("span.type", output_processor['type'])
-            else:
-                logger.warning("type of span not found or incorrect written in entity json")
-            if 'attributes' in output_processor:
+            self.set_span_type(to_wrap, wrapped, instance, output_processor, span, args, kwargs)
+            skip_processors:list[str] = self.skip_processor(to_wrap, wrapped, instance, span, args, kwargs) or []
+
+            if 'attributes' in output_processor and 'attributes' not in skip_processors:
                 for processors in output_processor["attributes"]:
                     for processor in processors:
                         attribute = processor.get('attribute')
@@ -100,13 +118,12 @@ class SpanHandler:
                                     span.set_attribute(attribute_name, result)
                             except MonocleSpanException as e:
                                 span.set_status(StatusCode.ERROR, e.message)
+                                detected_error = True
                             except Exception as e:
                                 logger.debug(f"Error processing accessor: {e}")
                         else:
                             logger.debug(f"{' and '.join([key for key in ['attribute', 'accessor'] if not processor.get(key)])} not found or incorrect in entity JSON")
                     span_index += 1
-            else:
-                logger.debug("attributes not found or incorrect written in entity json")
 
         # set scopes as attributes by calling get_scopes()
         # scopes is a Mapping[str:object], iterate directly with .items()
@@ -115,16 +132,23 @@ class SpanHandler:
         
         if span_index > 0:
             span.set_attribute("entity.count", span_index)
+        return detected_error
 
-
-    def hydrate_events(self, to_wrap, wrapped, instance, args, kwargs, result, span):
+    def hydrate_events(self, to_wrap, wrapped, instance, args, kwargs, ret_result, span, parent_span=None, ex:Exception=None) -> bool:
+        detected_error:bool = False
         if 'output_processor' in to_wrap and to_wrap["output_processor"] is not None:
             output_processor=to_wrap['output_processor']
-            arguments = {"instance": instance, "args": args, "kwargs": kwargs, "result": result}
-            if 'events' in output_processor:
+            skip_processors:list[str] = self.skip_processor(to_wrap, wrapped, instance, span, args, kwargs) or []
+
+            arguments = {"instance": instance, "args": args, "kwargs": kwargs, "result": ret_result, "exception":ex}
+            # Process events if they are defined in the output_processor.
+            # In case of inference.modelapi skip the event processing unless the span has an exception
+            if 'events' in output_processor and ('events' not in skip_processors or ex is not None):
                 events = output_processor['events']
                 for event in events:
                     event_name = event.get("name")
+                    if 'events.'+event_name in skip_processors and ex is None:
+                        continue
                     event_attributes = {}
                     attributes = event.get("attributes", [])
                     for attribute in attributes:
@@ -132,21 +156,32 @@ class SpanHandler:
                         accessor = attribute.get("accessor")
                         if accessor:
                             try:
-                                if attribute_key is not None:
-                                    event_attributes[attribute_key] = accessor(arguments)
-                                else:
-                                    event_attributes.update(accessor(arguments))
+                                result = accessor(arguments)
+                                if result and isinstance(result, dict):
+                                    result = dict((key, value) for key, value in result.items() if value is not None)
+                                if result and isinstance(result, (str, list, dict)):
+                                    if attribute_key is not None:
+                                        event_attributes[attribute_key] = result
+                                    else:
+                                        event_attributes.update(result)
                             except MonocleSpanException as e:
                                 span.set_status(StatusCode.ERROR, e.message)
+                                detected_error = True
                             except Exception as e:
                                 logger.debug(f"Error evaluating accessor for attribute '{attribute_key}': {e}")
-                    span.add_event(name=event_name, attributes=event_attributes)
+                    matching_timestamp = getattr(ret_result, "timestamps", {}).get(event_name, None)
+                    if isinstance(matching_timestamp, int):
+                        span.add_event(name=event_name, attributes=event_attributes, timestamp=matching_timestamp)
+                    else:
+                        span.add_event(name=event_name, attributes=event_attributes)
+        return detected_error
 
     @staticmethod
     def set_workflow_attributes(to_wrap, span: Span):
         span_index = 1
         workflow_name = SpanHandler.get_workflow_name(span=span)
         if workflow_name:
+            span.update_name("workflow")
             span.set_attribute("span.type", "workflow")
             span.set_attribute(f"entity.{span_index}.name", workflow_name)
         workflow_type = SpanHandler.get_workflow_type(to_wrap)
@@ -186,26 +221,19 @@ class SpanHandler:
     @staticmethod
     def is_root_span(curr_span: Span) -> bool:
         try:
-            if curr_span is not None and hasattr(curr_span, "parent"):
+            if curr_span is not None and hasattr(curr_span, "parent") or  curr_span.context.trace_state:
                 return curr_span.parent is None
         except Exception as e:
             logger.warning(f"Error finding root span: {e}")
 
-    def is_non_workflow_root_span(self, curr_span: Span, to_wrap) -> bool:
-        return SpanHandler.is_root_span(curr_span) and to_wrap.get("span_type") != "workflow"
-    
-    def is_workflow_span_active(self):
-        return get_value(WORKFLOW_TYPE_KEY) is not None
-
     @staticmethod
     def attach_workflow_type(to_wrap=None, context=None): 
         token = None
         if to_wrap:
-            if to_wrap.get('span_type') == "workflow":
+            workflow_type = SpanHandler.get_workflow_type(to_wrap)
+            if workflow_type != WORKFLOW_TYPE_GENERIC:
                 token = attach(set_value(WORKFLOW_TYPE_KEY,
                                         SpanHandler.get_workflow_type(to_wrap), context))
-        else:
-            token = attach(set_value(WORKFLOW_TYPE_KEY, WORKFLOW_TYPE_GENERIC, context))
         return token
 
     @staticmethod
@@ -213,8 +241,32 @@ class SpanHandler:
         if token:
             return detach(token)
 
+    @staticmethod
+    @contextmanager
+    def workflow_type(to_wrap=None, span:Span=None):
+        token = SpanHandler.attach_workflow_type(to_wrap)
+        try:
+            yield
+        finally:
+            SpanHandler.detach_workflow_type(token)
+
+
 class NonFrameworkSpanHandler(SpanHandler):
 
-    # If the language framework is being executed, then skip generating direct openAI spans
-    def skip_span(self, to_wrap, wrapped, instance, args, kwargs) -> bool:
-        return get_value(WORKFLOW_TYPE_KEY) in WORKFLOW_TYPE_MAP.values()
+    def get_workflow_name_in_progress(self) -> str:
+        return get_value(WORKFLOW_TYPE_KEY)
+
+    def is_framework_span_in_progess(self) -> bool:
+        return self.get_workflow_name_in_progress() in WORKFLOW_TYPE_MAP.values()
+
+    # If the language framework is being executed, then skip generating direct openAI attributes and events
+    def skip_processor(self, to_wrap, wrapped, instance, span, args, kwargs) -> list[str]:
+        if self.is_framework_span_in_progess():
+            return ["attributes", "events"]
+    
+    def set_span_type(self, to_wrap, wrapped, instance, output_processor, span:Span, args, kwargs) -> str:
+        span_type = super().set_span_type(to_wrap, wrapped, instance, output_processor, span, args, kwargs)
+        if self.is_framework_span_in_progess() and span_type is not None:
+            span_type = span_type+".modelapi"
+            span.set_attribute("span.type", span_type)
+        return span_type

monocle_apptrace/instrumentation/common/tracing.md

@@ -0,0 +1,68 @@
+# Monocle tracing: concepts and principles
+
+## Span
+Span is an observation of a code/method executed. Each span has a unique ID. It records the start time and end time of the code's execution along with additional information relevant to that operation. Before the code execution starts, a span object is created in the memory of the host process executing this code. It'll capture the current time as start of time of span. At this stage the span is considered active. It'll stay active till the code execution ends. Once the code execution is complete, it'll record the current time as end time, capture any additional relevant information (eg argument, return value, environment setttings etc.). Now the span is marked as closed and it will be queued to be saved to some configured storage. 
+Note that the code that generated this span could in turn call other methods that are also instrumented. Those will generate spans of their own. These will be "child" spans which will refer to the span ID of the calling code as "parent" span. An initial span which has no parent is referred as "root" span.
+
+## Trace
+A trace is a collection of spans with a common ID called traceID. When the first active span gets created, a new unique traceID is generated and assigned to that span. All the child spans generated by execution of other instrumented code/methods will share the same traceID. Once this top span ends, this trace ends. This way all the code executed as part of the top level instrumented code will have a common traceID to group them together. For example, consider following sequence where `f1()` is the first instrumented method is executed, it calls other instrumented methods `f2(),f3(),f4() and f5()`
+```
+f1()--> f2() --> f3()
+    --> f4() --> f5()
+```
+In the above sequence, all method execution will generate a span each and they all will have a common traceID. Now if a new instrumented methods is executed after f1() finishes, it will be the first active span in the process's execution context and a will get a new traceID.
+
+### Trace ID propogation
+Each child span inherits the parent's trace ID. When spans running in same process, it captures it from process memory/context etc. But consider the above example again, where the `f4()-->f5()` code is not part of the process that executing f1(). It's a remote call, say over REST. From the overall application's point of view, the work done if `f4()` and `f5()` is part of `f1()` and you want same traceID associated with all spans. You want the instrumentation to seamlessly pass the tracedID over such remote calls and continue that instead of generating a new one. It's the responsibility of Monocle to provide such mechanism to make thsi trace ID propogation transparent to the application logic and architecture.
+
+## Propogation
+When the execution logic spans mulitple processes using remote calling mechanisms like REST, you want the trace ID also to propogate from process that originated it to the one that's continueing the remote execution. Monocle supports seamlessly propogating traceID over REST if both the sides for the trace execution are instrumented.
+
+## Types of spans in Monocle
+Monocle extends these generic span types by enriching additional attributes/data for genAI specific operations.
+### GenAI spans
+There are the core spans that capture details of genAI component operations like call to an LLM or vectore store. The purpose of these spans is to capture the details the applications interaction with core genAI comoponents. These spans are triggered by pre-instrumented methods that handle such operations. 
+- Inference span
+Represents interaction with LLMs, captures details like model, prompts, response and other metadata (eg tokens)
+- Retrieval span
+Represents interactions with vector stores like embedding creating, vector retrieval etc. Captures the model, search query, response, vector embedding etc.
+
+### anchor spans
+These are the spans that are created by a top level method that anchors a higher level of abstraction for underlying core genAI APIs. For example a langchain.invoke() which under the cover calls langchain.llm_invoke() or langchain.vector_retrieval(). Consider following psuedo code of a langchain rag pattern API,
+```
+response = rag_chain.invoke(prompt)
+            --> cleaned_prompt = llm1.chat(prompt)
+            --> context = vector_store.retrieve(cleaned_prompt)
+            --> response = llm2.chat(system_prompt+context+cleaned_prompt)
+            --> return response
+```
+If we only instrument the top level invoke call, then we'll trace the top level prompt and response interaction between application and langchain. But we'll miss the details like how a system prompt was added and send to mulitple LLMs and what context was extracted from a vector store etc. On the other hand, if we only instrument the low level calls to LLM and vector, then we'll miss the fact that those are part of same RAG. Hence we instrument all of them. This exaple would genearte an anchor spna for `invoke()` method, a retrieval span for `retrieve()` method and two inference spans for each `chat()` method. All of these will have common traceID.
+The anchor spans also provides an observation window of your application interaction with an high level SDK or service. It will illustrate facts such as how much time take by the genAI service invocation compared to other local logic.
+
+### Workflow spans
+Workflow spans are synthetic spans that are created to trace the full trace. It captures the summary of the full trace including the time window, the process running this code (set as `workflow_name` in the API to enab le Monocle instrumentation) and runtime environment details such as hosting service (Azure function, Lambda function etc). 
+The workflow spans is generated when a new trace starts or when a trace is propogated. They provide the base line observation window for the entire trace or a fragment of trace executed in a process.
+Consider following example,
+```
+setup_monocle_telemetry(workflow='bot')
+rag_chain.invoke()
+                --> context = retrieval() 
+                --> new_prompt = REST --> azure.func.chat(prompt) --> 
+                                                                setup_monocle_telemetry(workflow='moderator')
+                                                                return llm(moderator_system_prompt+prompt)
+                --> response = llm(new_prompt)
+```
+This will generate following spans:
+```
+Span{name='workflow.bot', type= workflow, traceID = xx1, spanID = yy0, parentID=None} ==> Workflow for new trace start
+Span{name='chain.invoke', type=anchor, traceID = xx1, spanID = yy1, parentID=yy0} ==> anchor span for chain invoke
+Span{name='chain.retrieval', type=retrieval, traceID = xx1, spanID = yy2, parentID = yy1} ==> Retrieval API span
+Span{name='workflow.moderator', type=workflow, traceID = xx1, spanID = zz1, parentID=yy1} ==> Workflow for propogated trace fragement
+Span{name='az.func.chat', type=anchor, traceID = xx1, spanID = zz2, parentID=zz1} ==> anchor span for az function invoke
+Span{name='chain.infer', type=inference, traceID = xx1, spanID = zz2, parentID=zz2} ==> inference
+Span{name='chain.infer',type=inference, traceID = xx1, spanID = yy3, parentID=yy1} ==> inference
+```
+
+## Scopes
+Scope is an way of grouping across traces. It's a tag with a value that can either be specified or auto generated (GUID) by Monocle. There can be any number of scopes active in an application code at a given point in time. All the active scopes are recorded in every span that's emmitted.
+

monocle_apptrace/instrumentation/common/utils.py

@@ -1,26 +1,32 @@
 import logging, json
 import os
+import traceback
 from typing import Callable, Generic, Optional, TypeVar, Mapping
-import threading, asyncio
 
 from opentelemetry.context import attach, detach, get_current, get_value, set_value, Context
-from opentelemetry.trace import NonRecordingSpan, Span, get_tracer
+from opentelemetry.trace import NonRecordingSpan, Span
 from opentelemetry.trace.propagation import _SPAN_KEY
 from opentelemetry.sdk.trace import id_generator, TracerProvider
-from opentelemetry.propagate import inject, extract
+from opentelemetry.propagate import extract
 from opentelemetry import baggage
-from monocle_apptrace.instrumentation.common.constants import MONOCLE_SCOPE_NAME_PREFIX, SCOPE_METHOD_FILE, SCOPE_CONFIG_PATH, llm_type_map
+from monocle_apptrace.instrumentation.common.constants import MONOCLE_SCOPE_NAME_PREFIX, SCOPE_METHOD_FILE, SCOPE_CONFIG_PATH, llm_type_map, MONOCLE_SDK_VERSION, ADD_NEW_WORKFLOW
+from importlib.metadata import version
 
 T = TypeVar('T')
 U = TypeVar('U')
 
 logger = logging.getLogger(__name__)
 
-monocle_tracer_provider: TracerProvider = None
 embedding_model_context = {}
 scope_id_generator = id_generator.RandomIdGenerator()
 http_scopes:dict[str:str] = {}
 
+try:
+    monocle_sdk_version = version("monocle_apptrace")
+except Exception as e:
+    monocle_sdk_version = "unknown"
+    logger.warning("Exception finding monocle-apptrace version.")
+
 class MonocleSpanException(Exception):
     def __init__(self, err_message:str):
         """
@@ -36,14 +42,6 @@ class MonocleSpanException(Exception):
         """String representation of the exception."""
         return f"[Monocle Span Error: {self.message} {self.status}"
 
-def set_tracer_provider(tracer_provider: TracerProvider):
-    global monocle_tracer_provider
-    monocle_tracer_provider = tracer_provider
-
-def get_tracer_provider() -> TracerProvider:
-    global monocle_tracer_provider
-    return monocle_tracer_provider
-
 def set_span_attribute(span, name, value):
     if value is not None:
         if value != "":
@@ -86,7 +84,12 @@ def with_tracer_wrapper(func):
             except Exception as e:
                 logger.error("Exception in attaching parent context: %s", e)
 
-            val = func(tracer, handler, to_wrap, wrapped, instance, args, kwargs)
+            if traceback.extract_stack().__len__() > 2:
+                filename, line_number, _, _ = traceback.extract_stack()[-2]
+                source_path = f"{filename}:{line_number}"
+            else:
+                source_path = ""
+            val = func(tracer, handler, to_wrap, wrapped, instance, source_path, args, kwargs)
             return val
 
         return wrapper
@@ -96,8 +99,8 @@ def with_tracer_wrapper(func):
 def resolve_from_alias(my_map, alias):
     """Find a alias that is not none from list of aliases"""
 
-    for i in alias and my_map[i] is not None:
-        if i in my_map.keys():
+    for i in alias:
+        if i in my_map.keys() and my_map[i] is not None:
             return my_map[i]
     return None
 
@@ -233,9 +236,17 @@ def set_scopes_from_baggage(baggage_context:Context):
             scope_name = scope_key[len(MONOCLE_SCOPE_NAME_PREFIX):]
             set_scope(scope_name, scope_value)
 
+def get_parent_span() -> Span:
+    parent_span: Span = None
+    _parent_span_context = get_current()
+    if _parent_span_context is not None and _parent_span_context.get(_SPAN_KEY, None):
+        parent_span = _parent_span_context.get(_SPAN_KEY, None)    
+    return parent_span
+
 def extract_http_headers(headers) -> object:
     global http_scopes
     trace_context:Context = extract(headers, context=get_current())
+    trace_context = set_value(ADD_NEW_WORKFLOW, True, trace_context)
     imported_scope:dict[str, object] = {}
     for http_header, http_scope in http_scopes.items():
         if http_header in headers:
@@ -267,49 +278,57 @@ async def http_async_route_handler(func, *args, **kwargs):
         headers = kwargs['req'].headers
     else:
         headers = None
-    return async_wrapper(func, None, None, headers, *args, **kwargs)
-
-def run_async_with_scope(method, current_context, exceptions, *args, **kwargs):
-    token = None
     try:
-        if current_context:
-            token = attach(current_context)
-        return asyncio.run(method(*args, **kwargs))
-    except Exception as e:
-        exceptions['exception'] = e
-        raise e
+        if headers is not None:
+            token = extract_http_headers(headers)
+        return await func(*args, **kwargs)
     finally:
-        if token:
-            detach(token)
-
-def async_wrapper(method, scope_name=None, scope_value=None, headers=None, *args, **kwargs):
-    try:
-        run_loop = asyncio.get_running_loop()
-    except RuntimeError:
-        run_loop = None
+        if token is not None:
+            clear_http_scopes(token)
 
-    token = None
-    exceptions = {}
-    if scope_name:
-        token = set_scope(scope_name, scope_value)
-    elif headers:
-        token = extract_http_headers(headers)
-    current_context = get_current()
-    try:
-        if run_loop and run_loop.is_running():
-            results = []
-            thread = threading.Thread(target=lambda: results.append(run_async_with_scope(method, current_context, exceptions, *args, **kwargs)))
-            thread.start()
-            thread.join()
-            if 'exception' in exceptions:
-                raise exceptions['exception']
-            return_value = results[0] if len(results) > 0 else None
-            return return_value
-        else:
-            return run_async_with_scope(method, None, exceptions, *args, **kwargs)
-    finally:
-        if token:
-            remove_scope(token)
+# def run_async_with_scope(method, current_context, exceptions, *args, **kwargs):
+#     token = None
+#     try:
+#         if current_context:
+#             token = attach(current_context)
+#         return asyncio.run(method(*args, **kwargs))
+#     except Exception as e:
+#         exceptions['exception'] = e
+#         raise e
+#     finally:
+#         if token:
+#             detach(token)
+
+# async def async_wrapper(method, headers=None, *args, **kwargs):
+#     current_context = get_current()
+#     try:
+#         if run_loop and run_loop.is_running():
+#             results = []
+#             thread = threading.Thread(target=lambda: results.append(run_async_with_scope(method, current_context, exceptions, *args, **kwargs)))
+#             thread.start()
+#             thread.join()
+#             if 'exception' in exceptions:
+#                 raise exceptions['exception']
+#             return_value = results[0] if len(results) > 0 else None
+#             return return_value
+#         else:
+#             return run_async_with_scope(method, None, exceptions, *args, **kwargs)
+#     finally:
+#         if token:
+#             remove_scope(token)
+
+def get_monocle_version() -> str:
+    global monocle_sdk_version
+    return monocle_sdk_version
+
+def add_monocle_trace_state(headers:dict[str:str]) -> None:
+    if headers is None:
+        return
+    monocle_trace_state = f"{MONOCLE_SDK_VERSION}={get_monocle_version()}"
+    if 'tracestate' in headers:
+        headers['tracestate'] = f"{headers['tracestate']},{monocle_trace_state}"
+    else:
+        headers['tracestate'] = monocle_trace_state
 
 class Option(Generic[T]):
     def __init__(self, value: Optional[T]):
@@ -343,14 +362,46 @@ def try_option(func: Callable[..., T], *args, **kwargs) -> Option[T]:
 
 def get_llm_type(instance):
     try:
-        llm_type = llm_type_map.get(type(instance).__name__.lower())
+        t_name = type(instance).__name__.lower()
+        t_name = t_name.replace("async", "") if "async" in t_name else t_name
+        llm_type = llm_type_map.get(t_name)
         return llm_type
     except:
         pass
 
-def resolve_from_alias(my_map, alias):
-    """Find a alias that is not none from list of aliases"""
-    for i in alias:
-        if i in my_map.keys():
-            return my_map[i]
-    return None
+def get_status(arguments):
+    if arguments['exception'] is not None:
+        return 'error'
+    else:
+        return 'success'
+
+def get_exception_status_code(arguments):
+    if arguments['exception'] is not None and hasattr(arguments['exception'], 'code'):
+        return arguments['exception'].code
+    else:
+        return 'error'
+
+def get_exception_message(arguments):
+    if arguments['exception'] is not None:
+        if hasattr(arguments['exception'], 'message'):
+            return arguments['exception'].message
+        else:
+            return arguments['exception'].__str__()
+    else:
+        return ''
+
+def patch_instance_method(obj, method_name, func):
+    """
+    Patch a special method (like __iter__) for a single instance.
+
+    Args:
+        obj: the instance to patch
+        method_name: the name of the method (e.g., '__iter__')
+        func: the new function, expecting (self, ...)
+    """
+    cls = obj.__class__
+    # Dynamically create a new class that inherits from obj's class
+    new_cls = type(f"Patched{cls.__name__}", (cls,), {
+        method_name: func
+    })
+    obj.__class__ = new_cls