monocle-apptrace 0.5.3__py3-none-any.whl → 0.6.6__py3-none-any.whl

monocle_apptrace/exporters/file_exporter.py

@@ -55,6 +55,9 @@ class FileSpanExporter(SpanExporterBase):
         else:
             return self._process_spans(spans, is_root_span=is_root_span)
 
+    def set_service_name(self, service_name: str) -> None:
+        self.service_name = service_name
+
     def _cleanup_expired_handles(self) -> None:
         """Close and remove file handles that have exceeded the timeout."""
         current_time = datetime.now()
@@ -130,7 +133,10 @@ class FileSpanExporter(SpanExporterBase):
         
         # Process spans for each trace
         for trace_id, trace_spans in spans_by_trace.items():
-            service_name = trace_spans[0].resource.attributes.get(SERVICE_NAME, "unknown")
+            if self.service_name is not None:
+                service_name = self.service_name
+            else:
+                service_name = trace_spans[0].resource.attributes.get(SERVICE_NAME, "unknown")
             handle, file_path, is_first_span = self._get_or_create_handle(trace_id, service_name)
             
             if handle is None:

monocle_apptrace/instrumentation/common/constants.py

@@ -92,6 +92,9 @@ CHILD_ERROR_CODE = "child.error.code"
 
 AGENT_PREFIX_KEY = "monocle.agent.prefix"
 
+MONOCLE_SKIP_EXECUTIONS = "monocle.skip_executions"
+SKIPPED_EXECUTION = "monocle.skipped_execution"
+
 # agentic sub types
 INFERENCE_AGENT_DELEGATION = "delegation"
 INFERENCE_TOOL_CALL = "tool_call"
@@ -178,3 +181,8 @@ MAP_ATTRIBUTES_TO_SPAN_SUBTYPE = {
     
     
 }
+
+PROVIDER_BASE_URLS = {
+    "deepseek": "https://api.deepseek.com",
+    # Add more providers here later
+}

monocle_apptrace/instrumentation/common/instrumentor.py

@@ -165,7 +165,7 @@ def setup_monocle_telemetry(
         span_handlers: Dict[str,SpanHandler] = None,
         wrapper_methods: List[Union[dict,WrapperMethod]] = None,
         union_with_default_methods: bool = True,
-        monocle_exporters_list:str = None) -> None:
+        monocle_exporters_list:str = None) -> MonocleInstrumentor:
     """
     Set up Monocle telemetry for the application.
 

monocle_apptrace/instrumentation/common/span_handler.py

@@ -1,6 +1,7 @@
 import logging
 import os
 from contextlib import contextmanager
+from typing import Union
 from opentelemetry.context import get_value, set_value, attach, detach
 from opentelemetry.sdk.trace import Span
 from opentelemetry.trace.status import Status, StatusCode
@@ -10,8 +11,8 @@ from monocle_apptrace.instrumentation.common.constants import (
     service_type_map,
     MONOCLE_SDK_VERSION, MONOCLE_SDK_LANGUAGE, MONOCLE_DETECTED_SPAN_ERROR
 )
-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, CHILD_ERROR_CODE
+from monocle_apptrace.instrumentation.common.utils import set_attribute, get_scopes, MonocleSpanException, get_monocle_version, replace_placeholders
+from monocle_apptrace.instrumentation.common.constants import WORKFLOW_TYPE_KEY, WORKFLOW_TYPE_GENERIC, CHILD_ERROR_CODE, MONOCLE_SKIP_EXECUTIONS, SKIPPED_EXECUTION
 
 logger = logging.getLogger(__name__)
 
@@ -26,7 +27,8 @@ WORKFLOW_TYPE_MAP = {
     "anthropic": "workflow.anthropic",
     "gemini": "workflow.gemini",
     "litellm": "workflow.litellm",
-    "mistralai": "workflow.mistral"
+    "mistralai": "workflow.mistral",
+    "huggingface_hub": "workflow.huggingface"
 }
 
 FRAMEWORK_WORKFLOW_LIST = [
@@ -48,7 +50,7 @@ class SpanHandler:
         pass
 
     def pre_tracing(self, to_wrap, wrapped, instance, args, kwargs):
-        pass
+        return None, None
 
     def post_tracing(self, to_wrap, wrapped, instance, args, kwargs, return_value, token=None):
         pass
@@ -66,8 +68,6 @@ class SpanHandler:
             span.set_attribute("span.type", span_type)
         else:
             logger.warning("type of span not found or incorrect written in entity json")
-        if "subtype" in output_processor:
-            span.set_attribute("span.subtype", output_processor["subtype"])
         return span_type
 
     def pre_task_processing(self, to_wrap, wrapped, instance, args,kwargs, span):
@@ -102,28 +102,32 @@ class SpanHandler:
     def post_task_processing(self, to_wrap, wrapped, instance, args, kwargs, result, ex, span:Span, parent_span:Span):
         pass
 
-    def should_skip(self, processor, instance, args, kwargs) -> bool:
+    def should_skip(self, processor, instance, span, parent_span, args, kwargs) -> bool:
         should_skip = False
         accessor = processor.get('should_skip')
         if accessor:
-            arguments = {"instance":instance, "args":args, "kwargs":kwargs}
-            should_skip = accessor(arguments)
-            if not isinstance(should_skip, bool):
-                logger.warning("Warning: 'should_skip' accessor did not return a boolean value")
-                return True
+            arguments = {"instance":instance, "span":span, "parent_span":parent_span, "args":args, "kwargs":kwargs}
+            try:
+                should_skip = accessor(arguments)
+                if not isinstance(should_skip, bool):
+                    logger.warning("Warning: 'should_skip' accessor did not return a boolean value")
+                    return False
+            except Exception as e:
+                logger.warning("Warning: Error occurred in 'should_skip' accessor: %s", str(e))
         return should_skip
 
-    def hydrate_span(self, to_wrap, wrapped, instance, args, kwargs, result, span, parent_span = None, ex:Exception = None) -> bool:
+    def hydrate_span(self, to_wrap, wrapped, instance, args, kwargs, result, span, parent_span = None,
+                    ex:Exception = None, is_post_exec:bool= False) -> bool:
         try:
-            detected_error_in_attribute = self.hydrate_attributes(to_wrap, wrapped, instance, args, kwargs, result, span, parent_span)
-            detected_error_in_event = self.hydrate_events(to_wrap, wrapped, instance, args, kwargs, result, span, parent_span, ex)
+            detected_error_in_attribute = self.hydrate_attributes(to_wrap, wrapped, instance, args, kwargs, result, span, parent_span, is_post_exec)
+            detected_error_in_event = self.hydrate_events(to_wrap, wrapped, instance, args, kwargs, result, span, parent_span, ex, is_post_exec)
             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:
+            if is_post_exec and 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:Span, parent_span:Span) -> bool:
+    def hydrate_attributes(self, to_wrap, wrapped, instance, args, kwargs, result, span:Span, parent_span:Span, is_post_exec:bool) -> bool:
         detected_error:bool = False
         span_index = 0
         if SpanHandler.is_root_span(span):
@@ -132,7 +136,6 @@ class SpanHandler:
             output_processor=to_wrap['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:
                 arguments = {"instance":instance, "args":args, "kwargs":kwargs, "result":result, "parent_span":parent_span, "span":span}
                 for processors in output_processor["attributes"]:
@@ -143,9 +146,10 @@ class SpanHandler:
                         if attribute and accessor:
                             attribute_name = f"entity.{span_index+1}.{attribute}"
                             try:
-                                processor_result = accessor(arguments)
-                                if processor_result and isinstance(processor_result, (str, list)):
-                                    span.set_attribute(attribute_name, processor_result)
+                                if (not is_post_exec and processor.get('phase', '') != 'post_execution') or (is_post_exec and processor.get('phase', '') == 'post_execution'):
+                                    processor_result = accessor(arguments)
+                                    if processor_result and isinstance(processor_result, (str, list)):
+                                        span.set_attribute(attribute_name, processor_result)
                             except MonocleSpanException as e:
                                 span.set_status(StatusCode.ERROR, e.message)
                                 detected_error = True
@@ -164,13 +168,27 @@ class SpanHandler:
             span.set_attribute("entity.count", span_index)
         return detected_error
 
-    def hydrate_events(self, to_wrap, wrapped, instance, args, kwargs, ret_result, span: Span, parent_span=None, ex:Exception=None) -> bool:
+    def hydrate_events(self, to_wrap, wrapped, instance, args, kwargs, ret_result, span: Span, parent_span=None, ex:Exception=None,
+                       is_post_exec: bool = False) -> 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']
-            skip_processors:list[str] = self.skip_processor(to_wrap, wrapped, instance, span, args, kwargs) or []
-
+            if is_post_exec:
+                skip_events:list[str] = ['events.data.input']
+            else:
+                skip_events:list[str] = ['events.data.output', 'events.metadata']
+            skip_processors:list[str] = list(set(self.skip_processor(to_wrap, wrapped, instance, span, args, kwargs) or []).union(set(skip_events)))
             arguments = {"instance": instance, "args": args, "kwargs": kwargs, "result": ret_result, "exception":ex, "parent_span":parent_span, "span": span}
+            subtype = output_processor.get('subtype')
+            if subtype:
+                if callable(subtype):
+                    try:
+                        subtype_result = subtype(arguments)
+                        span.set_attribute("span.subtype", subtype_result)
+                    except Exception as e:
+                        logger.debug(f"Error processing subtype: {e}")
+                else:
+                    span.set_attribute("span.subtype", subtype)
             # 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):
@@ -199,6 +217,13 @@ class SpanHandler:
                                         event_attributes[attribute_key] = result
                                     else:
                                         event_attributes.update(result)
+                                if not is_post_exec and event_name == "data.input" and attribute_key == "input" and result:
+                                    # append memory to input if available
+                                    # update the result with new input
+                                    pass
+                                elif not detected_error and is_post_exec and event_name == "data.output" and attribute_key == "response" and result:
+                                    # capture memory
+                                    pass
                             except Exception as e:
                                 logger.debug(f"Error evaluating accessor for attribute '{attribute_key}': {e}")
                     matching_timestamp = getattr(ret_result, "timestamps", {}).get(event_name, None)
@@ -298,6 +323,32 @@ class SpanHandler:
         finally:
             SpanHandler.detach_workflow_type(token)
 
+    @staticmethod
+    def get_iput_entity_type(span: Span) -> str:
+        for event in span.events:
+            if event.name == "data.input":
+                return event.attributes.get("entity.type", "")
+
+    @staticmethod
+    def skip_execution(span:Span) -> tuple[bool, Union[dict, list, str, None]]:
+        skip_execs = get_value(MONOCLE_SKIP_EXECUTIONS)
+        if skip_execs is not None:
+            skip_exec_entity = skip_execs.get(span.attributes.get("entity.1.name", ""),{})
+            if ((span.attributes.get("span.type") is not None and skip_exec_entity.get("span.type", "") == span.attributes.get("span.type")) and
+                (span.attributes.get("entity.1.type") is not None and skip_exec_entity.get("entity.type", "") == span.attributes.get("entity.1.type"))):
+                span.set_attribute(SKIPPED_EXECUTION, True)
+                if skip_exec_entity.get("raise_error", False):
+                    raise MonocleSpanException(skip_exec_entity.get("error_message", ""))
+                response = skip_exec_entity.get("response", None)
+                response = replace_placeholders(response, span)
+                return True, response
+        return False, None
+
+    @staticmethod
+    def replace_placeholders_in_response(response: Union[dict, list, str], span:Span) -> Union[dict, list, str]:
+        if span.attributes.get(SKIPPED_EXECUTION, False):
+            return replace_placeholders(response, span)
+        return response
 
 class NonFrameworkSpanHandler(SpanHandler):
     # If the language framework is being executed, then skip generating direct openAI attributes and events

monocle_apptrace/instrumentation/common/utils.py

@@ -1,7 +1,8 @@
+import ast
 import logging, json
 import os
 import traceback
-from typing import Callable, Generic, Optional, TypeVar, Mapping
+from typing import Callable, Generic, Optional, TypeVar, Mapping, Union
 
 from opentelemetry.context import attach, detach, get_current, get_value, set_value, Context
 from opentelemetry.trace import NonRecordingSpan, Span
@@ -217,13 +218,16 @@ def remove_scopes(token:object) -> None:
     if token is not None:
         detach(token)
 
-def get_scopes() -> dict[str, object]:
+def get_scopes(scope_name: Optional[str] = None) -> dict[str, object]:
     monocle_scopes:dict[str, object] = {}
     for key, val in baggage.get_all().items():
-        if key.startswith(MONOCLE_SCOPE_NAME_PREFIX):
+        if key.startswith(MONOCLE_SCOPE_NAME_PREFIX) and (scope_name is None or key == f"{MONOCLE_SCOPE_NAME_PREFIX}{scope_name}"):
             monocle_scopes[key[len(MONOCLE_SCOPE_NAME_PREFIX):]] = val
     return monocle_scopes
 
+def is_scope_set(scepe_name: str) -> bool:
+    return len(get_scopes(scepe_name)) > 0
+
 def get_baggage_for_scopes():
     baggage_context:Context = None
     for scope_key, scope_value in get_scopes():
@@ -357,7 +361,7 @@ class Option(Generic[T]):
 
     def and_then(self, func: Callable[[T], 'Option[U]']) -> 'Option[U]':
         if self.is_some():
-            return func(self.value)
+            return Option(func(self.value))
         return Option(None)
 
 # Example usage
@@ -409,7 +413,7 @@ def get_error_message(arguments):
 
 
 def get_status_code(arguments):
-    if arguments["exception"] is not None:
+    if "exception" in arguments and arguments["exception"] is not None:
         return get_exception_status_code(arguments)
     elif hasattr(arguments["result"], "status"):
         return arguments["result"].status
@@ -467,4 +471,57 @@ def get_current_monocle_span(context: Optional[Context] = None) -> Span:
     span = get_value(_MONOCLE_SPAN_KEY, context=context)
     if span is None or not isinstance(span, Span):
         return INVALID_SPAN
-    return span
+    return span
+
+def get_input_event_from_span(events: list[dict], search_key:str) -> Optional[Mapping]:
+    """Extract the 'data.input' event from the span if it exists.
+
+    Args:
+        span: The Span to extract the event from.
+
+    Returns:
+        The 'data.input' event if it exists, None otherwise.
+    """
+    input_request = None
+    for event in events:
+        if event.name == "data.input":
+            try:
+                #load the input attribute as dictionary from string
+                try:
+                    input_dict = json.loads(event.attributes.get("input", "{}"))
+                except Exception as e:
+                    if isinstance(e, json.JSONDecodeError):
+                        input_dict = ast.literal_eval(event.attributes.get("input", {}))
+                    else:
+                        raise
+                if search_key in input_dict:
+                    input_request = input_dict[search_key]
+            except Exception as e:
+                logger.debug(f"Error parsing input event attribute: {e}")
+            break
+    return input_request
+
+def replace_placeholders(obj: Union[dict, list, str], span: Span) -> Union[dict, list, str]:
+    """Replace placeholders in strings with span context values."""
+    if isinstance(obj, dict):
+        return {k: replace_placeholders(v, span) for k, v in obj.items()}
+    elif isinstance(obj, list):
+        return [replace_placeholders(item, span) for item in obj]
+    elif isinstance(obj, str):
+        startIndex = 0
+        while True:
+            start = obj.find("{{", startIndex)
+            end = obj.find("}}", start + 2)
+            if start == -1 or end == -1:
+                break
+            key = obj[start + 2:end].strip()
+            value = get_input_event_from_span(span.events, key)
+            if value is not None:
+                obj = obj[:start] + str(value) + obj[end + 2:]
+            startIndex = start + len(str(value))
+            if startIndex >= len(obj):
+                break
+        return obj
+    else:
+        return obj
+