monocle-apptrace 0.3.0b6__py3-none-any.whl → 0.3.1__py3-none-any.whl

monocle_apptrace/instrumentation/common/instrumentor.py

@@ -3,6 +3,7 @@ import inspect
 from typing import Collection, Dict, List, Union
 import random
 import uuid
+import inspect
 from opentelemetry import trace
 from contextlib import contextmanager
 from opentelemetry.context import attach, get_value, set_value, get_current, detach
@@ -13,21 +14,22 @@ from opentelemetry.sdk.trace import TracerProvider, Span, id_generator
 from opentelemetry.sdk.resources import SERVICE_NAME, Resource
 from opentelemetry.sdk.trace import Span, TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor, SpanProcessor
+from opentelemetry.sdk.trace.export import SpanExporter
 from opentelemetry.trace import get_tracer
 from wrapt import wrap_function_wrapper
 from opentelemetry.trace.propagation import set_span_in_context, _SPAN_KEY
 from monocle_apptrace.exporters.monocle_exporters import get_monocle_exporter
-from monocle_apptrace.instrumentation.common.span_handler import SpanHandler
+from monocle_apptrace.instrumentation.common.span_handler import SpanHandler, NonFrameworkSpanHandler
 from monocle_apptrace.instrumentation.common.wrapper_method import (
     DEFAULT_METHODS_LIST,
     WrapperMethod,
     MONOCLE_SPAN_HANDLERS
 )
-from monocle_apptrace.instrumentation.common.wrapper import scope_wrapper, ascope_wrapper
+from monocle_apptrace.instrumentation.common.wrapper import scope_wrapper, ascope_wrapper, wrapper_processor
 from monocle_apptrace.instrumentation.common.utils import (
     set_scope, remove_scope, http_route_handler, load_scopes, async_wrapper, http_async_route_handler
 )
-from monocle_apptrace.instrumentation.common.constants import MONOCLE_INSTRUMENTOR, WORKFLOW_TYPE_KEY
+from monocle_apptrace.instrumentation.common.constants import MONOCLE_INSTRUMENTOR, WORKFLOW_TYPE_GENERIC
 from functools import wraps
 logger = logging.getLogger(__name__)
 
@@ -39,19 +41,22 @@ monocle_tracer_provider: TracerProvider = None
 
 class MonocleInstrumentor(BaseInstrumentor):
     workflow_name: str = ""
-    user_wrapper_methods: list[Union[dict,WrapperMethod]] = []
+    user_wrapper_methods: list[Union[dict,WrapperMethod]] = [],
+    exporters: list[SpanExporter] = [],
     instrumented_method_list: list[object] = []
-    handlers:Dict[str,SpanHandler] = {} # dict of handlers
+    handlers:Dict[str,SpanHandler] = None # dict of handlers
     union_with_default_methods: bool = False
 
     def __init__(
             self,
             handlers,
             user_wrapper_methods: list[Union[dict,WrapperMethod]] = None,
+            exporters: list[SpanExporter] = None,
             union_with_default_methods: bool = True
             ) -> None:
         self.user_wrapper_methods = user_wrapper_methods or []
         self.handlers = handlers
+        self.exporters = exporters
         if self.handlers is not None:
             for key, val in MONOCLE_SPAN_HANDLERS.items():
                 if key not in self.handlers:
@@ -65,13 +70,11 @@ class MonocleInstrumentor(BaseInstrumentor):
         def instrumented_endpoint_invoke(to_wrap,wrapped, span_name, instance,fn):
             @wraps(fn)
             def with_instrumentation(*args, **kwargs):
-                handler = SpanHandler()
-                with tracer.start_as_current_span(span_name) as span:
-                    response = fn(*args, **kwargs)
-                    handler.hydrate_span(to_wrap, wrapped=wrapped, instance=instance, args=args, kwargs=kwargs,
-                                         result=response, span=span)
-                    return response
-
+                async_task = inspect.iscoroutinefunction(fn)
+                boto_method_to_wrap = to_wrap.copy()
+                boto_method_to_wrap['skip_span'] = False
+                return wrapper_processor(async_task, tracer, NonFrameworkSpanHandler(),
+                            boto_method_to_wrap, fn, instance, args, kwargs)
             return with_instrumentation
         return instrumented_endpoint_invoke
 
@@ -157,11 +160,35 @@ def setup_monocle_telemetry(
         span_processors: List[SpanProcessor] = None,
         span_handlers: Dict[str,SpanHandler] = None,
         wrapper_methods: List[Union[dict,WrapperMethod]] = None,
-        union_with_default_methods: bool = True) -> None:
+        union_with_default_methods: bool = True,
+        monocle_exporters_list:str = None) -> None:
+    """
+    Set up Monocle telemetry for the application.
+
+    Parameters
+    ----------
+    workflow_name : str
+        The name of the workflow to be used as the service name in telemetry.
+    span_processors : List[SpanProcessor], optional
+        Custom span processors to use instead of the default ones. If None, 
+        BatchSpanProcessors with Monocle exporters will be used. This can't be combined with `monocle_exporters_list`.
+    span_handlers : Dict[str, SpanHandler], optional
+        Dictionary of span handlers to be used by the instrumentor, mapping handler names to handler objects.
+    wrapper_methods : List[Union[dict, WrapperMethod]], optional
+        Custom wrapper methods for instrumentation. If None, default methods will be used.
+    union_with_default_methods : bool, default=True
+        If True, combine the provided wrapper_methods with the default methods.
+        If False, only use the provided wrapper_methods.
+    monocle_exporters_list : str, optional
+        Comma-separated list of exporters to use. This will override the env setting MONOCLE_EXPORTERS.
+        Supported exporters are: s3, blob, okahu, file, memory, console. This can't be combined with `span_processors`.
+    """
     resource = Resource(attributes={
         SERVICE_NAME: workflow_name
     })
-    exporters = get_monocle_exporter()
+    if span_processors and monocle_exporters_list:
+        raise ValueError("span_processors and monocle_exporters_list can't be used together")
+    exporters:List[SpanExporter] = get_monocle_exporter(monocle_exporters_list)
     span_processors = span_processors or [BatchSpanProcessor(exporter) for exporter in exporters]
     set_tracer_provider(TracerProvider(resource=resource))
     attach(set_value("workflow_name", workflow_name))
@@ -176,7 +203,7 @@ def setup_monocle_telemetry(
             get_tracer_provider().add_span_processor(processor)
     if is_proxy_provider:
         trace.set_tracer_provider(get_tracer_provider())
-    instrumentor = MonocleInstrumentor(user_wrapper_methods=wrapper_methods or [], 
+    instrumentor = MonocleInstrumentor(user_wrapper_methods=wrapper_methods or [], exporters=exporters,
                                        handlers=span_handlers, union_with_default_methods = union_with_default_methods)
     # instrumentor.app_name = workflow_name
     if not instrumentor.is_instrumented_by_opentelemetry:
@@ -196,19 +223,37 @@ def set_context_properties(properties: dict) -> None:
     attach(set_value(SESSION_PROPERTIES_KEY, properties))
 
 def start_trace():
+    """
+    Starts a new trace. All the spans created after this call will be part of the same trace. 
+    Returns:
+        Token: A token representing the attached context for the workflow span.
+                      This token is to be used later to stop the current trace.
+                      Returns None if tracing fails.
+    
+    Raises:
+        Exception: The function catches all exceptions internally and logs a warning.
+    """
     try:
         tracer = get_tracer(instrumenting_module_name= MONOCLE_INSTRUMENTOR, tracer_provider= get_tracer_provider())
         span = tracer.start_span(name = "workflow")
         updated_span_context = set_span_in_context(span=span)
         SpanHandler.set_default_monocle_attributes(span)
         SpanHandler.set_workflow_properties(span)
-        token = SpanHandler.attach_workflow_type(context=updated_span_context)
+        token = attach(updated_span_context)
         return token
     except:
         logger.warning("Failed to start trace")
         return None
 
 def stop_trace(token) -> None:
+    """
+    Stop the active trace and detach workflow type if token is provided. All the spans created after this will not be part of the trace.
+    Args:
+        token: The token that was returned when the trace was started. Used to detach 
+               workflow type. Can be None in which case only the span is ended.
+    Returns:
+        None
+    """
     try:
         _parent_span_context = get_current()
         if _parent_span_context is not None:
@@ -216,7 +261,7 @@ def stop_trace(token) -> None:
             if parent_span is not None:
                 parent_span.end()
         if token is not None:
-            SpanHandler.detach_workflow_type(token)
+            detach(token)
     except:
         logger.warning("Failed to stop trace")
 
@@ -229,32 +274,67 @@ def is_valid_trace_id_uuid(traceId: str) -> bool:
     return False
 
 def start_scope(scope_name: str, scope_value:str = None) -> object:
+    """
+    Start a new scope with the given name and and optional value. If no value is provided, a random UUID will be generated.
+    All the spans, across traces created after this call will have the scope attached until the scope is stopped.
+    Args:
+        scope_name: The name of the scope.
+        scope_value: Optional value of the scope. If None, a random UUID will be generated.
+    Returns:
+        Token: A token representing the attached context for the scope. This token is to be used later to stop the current scope.
+    """
     return set_scope(scope_name, scope_value)
 
 def stop_scope(token:object) -> None:
+    """
+    Stop the active scope. All the spans created after this will not have the scope attached.
+    Args:
+        token: The token that was returned when the scope was started.
+    Returns:
+        None
+    """
     remove_scope(token)
     return
 
+@contextmanager
+def monocle_trace():
+    """
+    Context manager to start and stop a scope. All the spans, across traces created within the encapsulated code will have same trace ID
+    """
+    token = start_trace()
+    try:
+        yield
+    finally:
+        stop_trace(token)
+
 @contextmanager
 def monocle_trace_scope(scope_name: str, scope_value:str = None):
+    """
+    Context manager to start and stop a scope. All the spans, across traces created within the encapsulated code will have the scope attached.
+    Args:
+        scope_name: The name of the scope.
+        scope_value: Optional value of the scope. If None, a random UUID will be generated."""
     token = start_scope(scope_name, scope_value)
     try:
         yield
     finally:
         stop_scope(token)
     
-def monocle_trace_scope_method(scope_name: str):
+def monocle_trace_scope_method(scope_name: str, scope_value:str=None):
+    """
+    Decorator to start and stop a scope for a method. All the spans, across traces created in the method will have the scope attached.
+    """
     def decorator(func):
         if inspect.iscoroutinefunction(func):
             @wraps(func)
             async def wrapper(*args, **kwargs):
-                result = async_wrapper(func, scope_name, None, *args, **kwargs)
+                result = async_wrapper(func, scope_name, scope_value, None, *args, **kwargs)
                 return result
             return wrapper
         else:
             @wraps(func)
             def wrapper(*args, **kwargs):
-                token = start_scope(scope_name)
+                token = start_scope(scope_name, scope_value)
                 try:
                     result = func(*args, **kwargs)
                     return result
@@ -264,6 +344,10 @@ def monocle_trace_scope_method(scope_name: str):
     return decorator
 
 def monocle_trace_http_route(func):
+    """
+    Decorator to start and stop a continue traces and scope for a http route. It will also initiate new scopes from the http headers if configured in ``monocle_scopes.json``
+    All the spans, across traces created in the route will have the scope attached.
+    """
     if inspect.iscoroutinefunction(func):
         @wraps(func)
         async def wrapper(*args, **kwargs):
@@ -286,3 +370,4 @@ class FixedIdGenerator(id_generator.IdGenerator):
 
     def generate_trace_id(self) -> int:
         return self.trace_id
+

monocle_apptrace/instrumentation/common/span_handler.py

@@ -1,16 +1,16 @@
 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
 from monocle_apptrace.instrumentation.common.constants import (
     QUERY,
     service_name_map,
     service_type_map,
-    MONOCLE_SDK_VERSION
+    MONOCLE_SDK_VERSION, MONOCLE_SDK_LANGUAGE
 )
-from monocle_apptrace.instrumentation.common.utils import set_attribute, get_scopes
+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__)
@@ -39,9 +39,9 @@ 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, args, kwargs) -> bool:
         return False
 
     def pre_task_processing(self, to_wrap, wrapped, instance, args,kwargs, span):
@@ -51,11 +51,8 @@ class SpanHandler:
     @staticmethod
     def set_default_monocle_attributes(span: Span):
         """ 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")
         for scope_key, scope_value in get_scopes().items():
             span.set_attribute(f"scope.{scope_key}", scope_value)
 
@@ -65,8 +62,17 @@ class SpanHandler:
         SpanHandler.set_workflow_attributes(to_wrap, span)
         SpanHandler.set_app_hosting_identifier_attribute(span)
 
-    def post_task_processing(self, to_wrap, wrapped, instance, args, kwargs, result, span):
-        pass
+        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)
+
+    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)
 
     def hydrate_span(self, to_wrap, wrapped, instance, args, kwargs, result, span):
         self.hydrate_attributes(to_wrap, wrapped, instance, args, kwargs, result, span)
@@ -76,7 +82,8 @@ class SpanHandler:
         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 not self.skip_processor(to_wrap, wrapped, instance, args, kwargs) and (
+                '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'])
@@ -95,6 +102,8 @@ class SpanHandler:
                                 result = accessor(arguments)
                                 if result and isinstance(result, (str, list)):
                                     span.set_attribute(attribute_name, result)
+                            except MonocleSpanException as e:
+                                span.set_status(StatusCode.ERROR, e.message)
                             except Exception as e:
                                 logger.debug(f"Error processing accessor: {e}")
                         else:
@@ -102,6 +111,8 @@ class SpanHandler:
                     span_index += 1
             else:
                 logger.debug("attributes not found or incorrect written in entity json")
+        else:
+            span.set_attribute("span.type", "generic")
 
         # set scopes as attributes by calling get_scopes()
         # scopes is a Mapping[str:object], iterate directly with .items()
@@ -113,7 +124,8 @@ class SpanHandler:
 
 
     def hydrate_events(self, to_wrap, wrapped, instance, args, kwargs, result, span):
-        if 'output_processor' in to_wrap and to_wrap["output_processor"] is not None:
+        if not self.skip_processor(to_wrap, wrapped, instance, args, kwargs) and (
+                '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:
@@ -131,6 +143,8 @@ class SpanHandler:
                                     event_attributes[attribute_key] = accessor(arguments)
                                 else:
                                     event_attributes.update(accessor(arguments))
+                            except MonocleSpanException as e:
+                                span.set_status(StatusCode.ERROR, e.message)
                             except Exception as e:
                                 logger.debug(f"Error evaluating accessor for attribute '{attribute_key}': {e}")
                     span.add_event(name=event_name, attributes=event_attributes)
@@ -140,6 +154,7 @@ class SpanHandler:
         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)
@@ -179,26 +194,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
@@ -206,8 +214,18 @@ class SpanHandler:
         if token:
             return detach(token)
 
+    @staticmethod
+    @contextmanager
+    def workflow_type(to_wrap=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:
+    # If the language framework is being executed, then skip generating direct openAI attributes and events
+    def skip_processor(self, to_wrap, wrapped, instance, args, kwargs) -> bool:
         return get_value(WORKFLOW_TYPE_KEY) in WORKFLOW_TYPE_MAP.values()

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

@@ -9,7 +9,8 @@ from opentelemetry.trace.propagation import _SPAN_KEY
 from opentelemetry.sdk.trace import id_generator, TracerProvider
 from opentelemetry.propagate import inject, 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')
@@ -21,6 +22,27 @@ 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):
+        """
+        Monocle exeption to indicate error in span processing.        
+        Parameters:
+        - err_message (str): Error message.
+        - status (str): Status code
+        """
+        super().__init__(err_message)
+        self.message = err_message
+
+    def __str__(self):
+        """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
@@ -81,8 +103,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
 
@@ -221,6 +243,7 @@ def set_scopes_from_baggage(baggage_context:Context):
 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:
@@ -252,35 +275,62 @@ async def http_async_route_handler(func, *args, **kwargs):
         headers = kwargs['req'].headers
     else:
         headers = None
-    return async_wrapper(func, None, headers, *args, **kwargs)
+    return async_wrapper(func, None, None, headers, *args, **kwargs)
 
-def run_async_with_scope(method, scope_name, headers, *args, **kwargs):
+def run_async_with_scope(method, current_context, exceptions, *args, **kwargs):
     token = None
-    if scope_name:
-        token = set_scope(scope_name)
-    elif headers:
-        token = extract_http_headers(headers)
     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:
-            remove_scope(token)
+            detach(token)
 
-def async_wrapper(method, scope_name=None, headers=None, *args, **kwargs):
+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 run_loop and run_loop.is_running():
-        results = []
-        thread = threading.Thread(target=lambda: results.append(run_async_with_scope(method, scope_name, headers, *args, **kwargs)))
-        thread.start()
-        thread.join()
-        return_value = results[0] if len(results) > 0 else None
-        return return_value
+    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 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:
-        return run_async_with_scope(method, scope_name, headers, *args, **kwargs)
+        headers['tracestate'] = monocle_trace_state
 
 class Option(Generic[T]):
     def __init__(self, value: Optional[T]):
@@ -314,14 +364,8 @@ def try_option(func: Callable[..., T], *args, **kwargs) -> Option[T]:
 
 def get_llm_type(instance):
     try:
+        t_name = type(instance).__name__.lower()
         llm_type = llm_type_map.get(type(instance).__name__.lower())
         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