monocle-apptrace 0.3.0b1__py3-none-any.whl → 0.3.0b3__py3-none-any.whl

monocle_apptrace/instrumentor.py

@@ -1,121 +0,0 @@
-import logging, os
-from typing import Collection, List
-from wrapt import wrap_function_wrapper
-from opentelemetry.trace import get_tracer
-from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
-from opentelemetry.instrumentation.utils import unwrap
-from opentelemetry.sdk.trace import TracerProvider, Span
-from opentelemetry.sdk.trace.export import BatchSpanProcessor, SpanProcessor
-from opentelemetry.sdk.resources import SERVICE_NAME, Resource
-from opentelemetry import trace
-from opentelemetry.context import get_value, attach, set_value
-from monocle_apptrace.utils import process_wrapper_method_config
-from monocle_apptrace.wrap_common import SESSION_PROPERTIES_KEY
-from monocle_apptrace.wrapper import INBUILT_METHODS_LIST, WrapperMethod
-from monocle_apptrace.exporters.monocle_exporters import get_monocle_exporter
-
-logger = logging.getLogger(__name__)
-
-_instruments = ()
-
-class MonocleInstrumentor(BaseInstrumentor):
-    workflow_name: str = ""
-    user_wrapper_methods: list[WrapperMethod] = []
-    instrumented_method_list: list[object] = []
-
-    def __init__(
-            self,
-            user_wrapper_methods: list[WrapperMethod] = None) -> None:
-        self.user_wrapper_methods = user_wrapper_methods or []
-        super().__init__()
-
-    def instrumentation_dependencies(self) -> Collection[str]:
-        return _instruments
-
-    def _instrument(self, **kwargs):
-        tracer_provider: TracerProvider = kwargs.get("tracer_provider")
-        tracer = get_tracer(instrumenting_module_name="monocle_apptrace", tracer_provider=tracer_provider)
-
-        user_method_list = [
-            {
-                "package": method.package,
-                "object": method.object,
-                "method": method.method,
-                "span_name": method.span_name,
-                "wrapper": method.wrapper,
-                "output_processor": method.output_processor
-            } for method in self.user_wrapper_methods]
-        process_wrapper_method_config(user_method_list)
-        final_method_list = user_method_list + INBUILT_METHODS_LIST
-
-        for wrapped_method in final_method_list:
-            try:
-                wrap_package = wrapped_method.get("package")
-                wrap_object = wrapped_method.get("object")
-                wrap_method = wrapped_method.get("method")
-                wrapper = wrapped_method.get("wrapper")
-                wrap_function_wrapper(
-                    wrap_package,
-                    f"{wrap_object}.{wrap_method}" if wrap_object else wrap_method,
-                    wrapper(tracer, wrapped_method),
-                )
-                self.instrumented_method_list.append(wrapped_method)
-            except Exception as ex:
-                if wrapped_method in user_method_list:
-                    logger.error(f"""_instrument wrap Exception: {str(ex)}
-                                for package: {wrap_package},
-                                object:{wrap_object},
-                                method:{wrap_method}""")
-
-    def _uninstrument(self, **kwargs):
-        for wrapped_method in self.instrumented_method_list:
-            try:
-                wrap_package = wrapped_method.get("package")
-                wrap_object = wrapped_method.get("object")
-                wrap_method = wrapped_method.get("method")
-                unwrap(
-                    f"{wrap_package}.{wrap_object}" if wrap_object else wrap_package,
-                    wrap_method,
-                )
-            except Exception as ex:
-                logger.error(f"""_instrument unwrap Exception: {str(ex)}
-                             for package: {wrap_package},
-                             object:{wrap_object},
-                             method:{wrap_method}""")
-
-def setup_monocle_telemetry(
-        workflow_name: str,
-        span_processors: List[SpanProcessor] = None,
-        wrapper_methods: List[WrapperMethod] = None):
-    resource = Resource(attributes={
-        SERVICE_NAME: workflow_name
-    })
-    span_processors = span_processors or [BatchSpanProcessor(get_monocle_exporter())]
-    trace_provider = TracerProvider(resource=resource)
-    attach(set_value("workflow_name", workflow_name))
-    tracer_provider_default = trace.get_tracer_provider()
-    provider_type = type(tracer_provider_default).__name__
-    is_proxy_provider = "Proxy" in provider_type
-    for processor in span_processors:
-        processor.on_start = on_processor_start
-        if not is_proxy_provider:
-            tracer_provider_default.add_span_processor(processor)
-        else:
-            trace_provider.add_span_processor(processor)
-    if is_proxy_provider:
-        trace.set_tracer_provider(trace_provider)
-    instrumentor = MonocleInstrumentor(user_wrapper_methods=wrapper_methods or [])
-    # instrumentor.app_name = workflow_name
-    if not instrumentor.is_instrumented_by_opentelemetry:
-        instrumentor.instrument(trace_provider=trace_provider)
-
-def on_processor_start(span: Span, parent_context):
-    context_properties = get_value(SESSION_PROPERTIES_KEY)
-    if context_properties is not None:
-        for key, value in context_properties.items():
-            span.set_attribute(
-                f"{SESSION_PROPERTIES_KEY}.{key}", value
-            )
-
-def set_context_properties(properties: dict) -> None:
-    attach(set_value(SESSION_PROPERTIES_KEY, properties))

monocle_apptrace/langchain/__init__.py

@@ -1,9 +0,0 @@
-import os
-from monocle_apptrace.utils import get_wrapper_methods_config
-
-parent_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
-LANGCHAIN_METHODS = get_wrapper_methods_config(
-    wrapper_methods_config_path=os.path.join(parent_dir, 'metamodel', 'maps', 'langchain_methods.json'),
-    attributes_config_base_path=os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
-

monocle_apptrace/llamaindex/__init__.py

@@ -1,16 +0,0 @@
-# pylint: disable=protected-access
-import os
-from monocle_apptrace.utils import get_wrapper_methods_config
-
-
-def get_llm_span_name_for_openai(instance):
-    if (hasattr(instance, "_is_azure_client")
-            and callable(getattr(instance, "_is_azure_client"))
-            and instance._is_azure_client()):
-        return "llamaindex.azure_openai"
-    return "llamaindex.openai"
-
-parent_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
-LLAMAINDEX_METHODS = get_wrapper_methods_config(
-    wrapper_methods_config_path=os.path.join(parent_dir, 'metamodel', 'maps', 'llamaindex_methods.json'),
-    attributes_config_base_path=os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))

monocle_apptrace/message_processing.py

@@ -1,80 +0,0 @@
-"""
-This module provides utility functions for extracting system, user,
-and assistant messages from various input formats.
-"""
-
-import logging
-from monocle_apptrace.utils import get_attribute
-DATA_INPUT_KEY = "data.input"
-
-logger = logging.getLogger(__name__)
-def extract_messages(args):
-    """Extract system and user messages"""
-    try:
-        messages = []
-        args_input = get_attribute(DATA_INPUT_KEY)
-        if args_input:
-            messages.append(args_input)
-            return messages
-        if args and isinstance(args, tuple) and len(args) > 0:
-            if hasattr(args[0], "messages") and isinstance(args[0].messages, list):
-                for msg in args[0].messages:
-                    if hasattr(msg, 'content') and hasattr(msg, 'type'):
-                        messages.append({msg.type: msg.content})
-            elif isinstance(args[0], list):  #llama
-                for msg in args[0]:
-                    if hasattr(msg, 'content') and hasattr(msg, 'role'):
-                        if hasattr(msg.role, 'value'):
-                            role = msg.role.value
-                        else:
-                            role = msg.role
-                        if msg.role == "system":
-                            messages.append({role: msg.content})
-                        elif msg.role in ["user", "human"]:
-                            user_message = extract_query_from_content(msg.content)
-                            messages.append({role: user_message})
-        return messages
-    except Exception as e:
-        logger.warning("Warning: Error occurred in extract_messages: %s", str(e))
-        return []
-
-
-def extract_assistant_message(response):
-    try:
-        if isinstance(response, str):
-            return [response]
-        if hasattr(response, "content"):
-            return [response.content]
-        if hasattr(response, "message") and hasattr(response.message, "content"):
-            return [response.message.content]
-        if "replies" in response:
-            reply = response["replies"][0]
-            if hasattr(reply, 'content'):
-                return [reply.content]
-            return [reply]
-        if isinstance(response, dict):
-            return [response]
-        return []
-    except Exception as e:
-        logger.warning("Warning: Error occurred in extract_assistant_message: %s", str(e))
-        return []
-
-
-def extract_query_from_content(content):
-    try:
-        query_prefix = "Query:"
-        answer_prefix = "Answer:"
-        query_start = content.find(query_prefix)
-        if query_start == -1:
-            return None
-
-        query_start += len(query_prefix)
-        answer_start = content.find(answer_prefix, query_start)
-        if answer_start == -1:
-            query = content[query_start:].strip()
-        else:
-            query = content[query_start:answer_start].strip()
-        return query
-    except Exception as e:
-        logger.warning("Warning: Error occurred in extract_query_from_content: %s", str(e))
-        return ""

monocle_apptrace/metamodel/README.md

@@ -1,47 +0,0 @@
-# Monocle metamodel
-
-## Overview 
-Monocle metamodel is the way to manage standardization across all supported GenAI component stack. It includes the list of components that Monocle can identify and extract metadata. This help understanding and analyzing the traces from applications that include multiple components and can evolve over time. This is one of core value that Monocle provides to it's user community.
-
-## Meta model
-The Monocle metamodel comprises of three things, 
-- Entity types, definitions of technology types and supported vendor implementations.
-- A JSON format that overlays on top of Open Telemetry tracing format that includes the common attributes for each entity type.
-- Map of component menthods to trace with instrumentation methods provided by Monocle.
-
-### Entity type
-The entity type defines the type of GenAI component that Monocle understand. The monocle instrumentation can extract the relevenat information for this entity. There are a fixed set of [entity types](./entity_types.py) that are defined by Monocle out of the box, eg workflow, model etc. As the GenAI landscape evolves, the Monocle community will introduce a new entity type if the current entities won't represent a new technology component.
-Each entity types has number of supported technology components that Monocle handles out of the box, eg. LlamaIndex is a supported workflow. Monocle community will continue to expand the breadth of the project by adding more components.
-
-### Span types
-The GenAI application have specific [types of spans](./spans/README.md#span-types-and-events) where diffrent entities integrate. Monocle metamodel defines these types and specifies format for tracing data and metadata generated in such spans. 
-
-### Consistent trace format
-Monocle generates [traces](../../../Monocle_User_Guide.md#traces) which comprises of [spans](../../../Monocle_User_Guide.md#spans). Note that Monocle trace is [OpenTelemetry format](https://opentelemetry.io/docs/concepts/signals/traces/) compatible. Each span is essentially a step in the execution that interacts with one of more GenAI technology components. The please refer to the [full spec of the json format](./span_format.json) and a detailed [example](./span_example.json). 
-The ```attribute``` section of the span includes a list of such entities that are used in that span.
-The runtime data and metadata collected during the execution of that span are included in the ```events``` section of the trace (as per the Otel spec). Each entry in the event corrosponds to the entity involved in that trace execution if it has produced any runtime outputs. 
-Please see the [span format](./spans/README.md) for details.
-
-### Instrumentation method map
-The map dectates what Monocle tracing method is relevant for the a given GenAI tech component method/API. It also specifies the name for that span to set in the trace output.
-```python
-    {
-        "package": "llama_index.core.base.base_query_engine",
-        "object": "BaseQueryEngine",
-        "method": "query",
-        "span_name": "llamaindex.query",
-        "wrapper_package": "wrap_common",
-        "wrapper_method": "task_wrapper"
-    }
-```
-
-## Extending the meta model
-Monocle is highly extensible. This section describe when one would need to extend the meta model. Please refer to Monocle [User guide](../../../Monocle_User_Guide.md) and [Contributor guide](../../../Monocle_contributor_guide.md) for detailed steps.
-### Trace a new method/API
-If you have overloaded an existing functionality in one of the supported components by creating a new function. Monocle doesn't know that this function should be traced, say because it's calling an LLM. You could define a new mapping so Monocle instrumentation can trace this function the say way it handles other LLM invocation functions.
-
-### Adding a new component provider
-Let's say there's a new database that supports vector search capability which is not supported by the Monocle. In this case, first you'll need to add that database under the ``MonocleEntity.VectorDB`` list. Then you'll need to extend the method map and test if the existing Monocle tracing functions has logic to effectively trace the new component. If not, then you might need to implement new method to cover the gap and update the mapping table according.
-
-### Support new type of entity
-If there's new component that can't be mapped to any of the existing entity types, then it'll require extending the metamodel and implement new instrumetation to support it. We recommend you initiate a discussion with Monocle community to add the support.

monocle_apptrace/metamodel/entities/README.md

@@ -1,77 +0,0 @@
-# Monocle Entities
-The entity type defines the type of GenAI component that Monocle understand. The monocle instrumentation can extract the relevenat information for this entity. There are a fixed set of [entity types](./entity_types.py) that are defined by Monocle out of the box, eg workflow, model etc. As the GenAI landscape evolves, the Monocle community will introduce a new entity type if the current entities won't represent a new technology component.
-
-## Entities
-Following attributes are supported for all entities
-| Name | Description | Required |
-| - | - | - |
-| name | Entity name generated by Monocle | Required |
-| type | entity.category.type | True |
-
-### MonocleEntity.Workflow
-Workflow ie the core application code. 
-#### Workflow types
-- generic
-- langchain
-- llamaindex
-- haystack
-
-### MonocleEntity.Model
-GenAI models. It has following sub categories
-- generic
-- llm
-- embedding
-#### Model types
-- gpt3
-- gpt-3.5
-- gpt-3.5-turbo
-- gpt4
-- gpt4o
-- gpt4o-mini
-- ollama
-
-Following attributes are supported for all model type entities
-| Name | Description | Required |
-| - | - | - |
-| parameters | model parameters | false |
-| algorithm | model algorithm | false |
-
-### MonocleEntity.AppHosting
-Application host services where the workflow code is run.
-#### AppHosting types
-- generic
-- aws_lambda
-- aws_sagemaker
-- azure_func
-- github_codespace
-- azure_mlw
-
-### MonocleEntity.Inference
-The model hosting infrastructure services.
-Following attributes are supported for inference type entities
-| Name | Description | Required |
-| - | - | - |
-| inference_endpoint | connection endpoint for inference service | false |
-#### Inference types
-- generic
-- nvidia_triton
-- openai
-- azure_oai
-- aws_sagemaker
-- aws_bedrock
-- hugging_face
-
-Following attributes are supported for inference type entities
-| Name | Description | Inference type | Required |
-| - | - | - | - |
-| deployment | model deployment name | azure_oai | false |
-
-
-### MonocleEntity.VectorStore
-Vector search data stores.
-#### VectorStore types
-- generic
-- chroma
-- aws_es
-- milvus
-- pinecone

monocle_apptrace/metamodel/entities/app_hosting_types.json

@@ -1,29 +0,0 @@
-{
-    "entity" : "app_hosting",
-    "types": [
-        {
-            "name": "aws_lambda",
-            "attributes" : []
-        },
-        {
-            "name": "aws_sagemaker",
-            "attributes" : []
-        },
-        {
-            "name": "azure_func",
-            "attributes" : []
-        },
-        {
-            "name": "azure_mlw",
-            "attributes" : []
-        },
-        {
-            "name": "github_codespace",
-            "attributes" : []
-        },
-        {
-            "name": "generic",
-            "attributes" : []
-        }
-    ]
-}

monocle_apptrace/metamodel/entities/entities.json

@@ -1,49 +0,0 @@
-{
-    "description": "Monocle entities represents kinds GenAI technology components and their implementations supported by Monocle",
-    "monocle_entities": [
-        {
-            "name": "workflow",
-            "attributes" : [],
-            "categories": []
-        },
-        {
-            "name": "model",
-            "attributes" : [
-                {
-                    "attribute_name": "model_name",
-                    "attribute_description": "Model name",
-                    "required": true
-                }
-            ],
-            "categories": [
-                {
-                    "name": "llm",
-                    "attributes" : []
-                },
-                {
-                    "name": "embedding",
-                    "attributes" : []
-                },
-                {
-                    "name": "generic",
-                    "attributes" : []
-                }
-            ]
-        },
-        {
-            "name": "vector_store",
-            "attributes" : [],
-            "categories": []
-        },
-        {
-            "name": "app_hosting",
-            "attributes" : [],
-            "categories": []
-        },
-        {
-            "name": "inference",
-            "attributes" : [],
-            "categories": []
-        }
-    ]
-}

monocle_apptrace/metamodel/entities/inference_types.json

@@ -1,33 +0,0 @@
-{
-    "entity" : "vector_store",
-    "types": [
-        {
-            "name": "aws_sagemaker",
-            "attributes" : []
-        },
-        {
-            "name": "aws_bedrock",
-            "attributes" : []
-        },
-        {
-            "name": "azure_oai",
-            "attributes" : []
-        },
-        {
-            "name": "openai",
-            "attributes" : []
-        },
-        {
-            "name": "nvidia_triton",
-            "attributes" : []
-        },
-        {
-            "name": "hugging_face",
-            "attributes" : []
-        },
-        {
-            "name": "generic",
-            "attributes" : []
-        }
-    ]
-}

monocle_apptrace/metamodel/entities/model_types.json

@@ -1,41 +0,0 @@
-{
-    "entity" : "model",
-    "types": [
-        {
-            "name": "gpt3",
-            "attributes" : []
-        },
-        {
-            "name": "gpt-3.5",
-            "attributes" : []
-        },
-        {
-            "name": "gpt-3.5-turbo",
-            "attributes" : []
-        },
-        {
-            "name": "gpt-3.5",
-            "attributes" : []
-        },
-        {
-            "name": "gpt4",
-            "attributes" : []
-        },
-        {
-            "name": "gpt4o",
-            "attributes" : []
-        },
-        {
-            "name": "gpt4o-mini",
-            "attributes" : []
-        },
-        {
-            "name": "ollama",
-            "attributes" : []
-        },
-        {
-            "name": "generic",
-            "attributes" : []
-        }
-    ]
-}

monocle_apptrace/metamodel/entities/vector_store_types.json

@@ -1,25 +0,0 @@
-{
-    "entity" : "vector_store",
-    "types": [
-        {
-            "name": "chroma",
-            "attributes" : []
-        },
-        {
-            "name": "aws_es",
-            "attributes" : []
-        },
-        {
-            "name": "milvus",
-            "attributes" : []
-        },
-        {
-            "name": "pinecone",
-            "attributes" : []
-        },
-        {
-            "name": "generic",
-            "attributes" : []
-        }
-    ]
-}

monocle_apptrace/metamodel/entities/workflow_types.json

@@ -1,22 +0,0 @@
-{
-    "entity" : "workflow",
-    "types": [
-        {
-            "name": "llama_index",
-            "attributes" : []
-        },
-        {
-            "name": "langchain",
-            "attributes" : []
-        },
-        {
-            "name": "haystack",
-            "attributes" : []
-        },
-        {
-            "name": "generic",
-            "attributes" : []
-        }
-
-    ]
-}

monocle_apptrace/metamodel/maps/attributes/inference/botocore_entities.json

@@ -1,27 +0,0 @@
-{
-  "type": "inference",
-  "attributes": [
-    [
-      {
-        "_comment": "provider type  , inference_endpoint",
-        "attribute": "type",
-        "accessor": "lambda arguments:'inference.aws_sagemaker'"
-      },
-      {
-        "attribute": "inference_endpoint",
-        "accessor": "lambda arguments: resolve_from_alias(arguments['instance'].__dict__, ['azure_endpoint', 'api_base']) or arguments['instance'].meta.endpoint_url"
-      }
-    ],
-    [
-      {
-        "_comment": "LLM Model",
-        "attribute": "name",
-        "accessor": "lambda arguments: resolve_from_alias(arguments['instance'].__dict__, ['model', 'model_name']) or arguments['kwargs'].get('EndpointName', '')"
-      },
-      {
-        "attribute": "type",
-        "accessor": "lambda arguments: 'model.llm.' + (resolve_from_alias(arguments['instance'].__dict__, ['model', 'model_name']) or arguments['kwargs'].get('EndpointName', ''))"
-      }
-    ]
-  ]
-}

monocle_apptrace/metamodel/maps/attributes/inference/haystack_entities.json

@@ -1,57 +0,0 @@
-{
-  "type": "inference",
-  "attributes": [
-    [
-      {
-        "_comment": "provider type ,name , deployment , inference_endpoint",
-        "attribute": "type",
-        "accessor": "lambda arguments:'inference.azure_oai'"
-      },
-      {
-        "attribute": "provider_name",
-        "accessor": "lambda arguments:arguments['kwargs']['provider_name']"
-      },
-      {
-        "attribute": "deployment",
-        "accessor": "lambda arguments: resolve_from_alias(arguments['instance'].__dict__, ['engine', 'azure_deployment', 'deployment_name', 'deployment_id', 'deployment'])"
-      },
-      {
-        "attribute": "inference_endpoint",
-        "accessor": "lambda arguments: resolve_from_alias(arguments['instance'].__dict__, ['azure_endpoint', 'api_base'])  or arguments['kwargs']['inference_endpoint']"
-      }
-    ],
-    [
-      {
-        "_comment": "LLM Model",
-        "attribute": "name",
-        "accessor": "lambda arguments: resolve_from_alias(arguments['instance'].__dict__, ['model', 'model_name'])"
-      },
-      {
-        "attribute": "type",
-        "accessor": "lambda arguments: 'model.llm.'+resolve_from_alias(arguments['instance'].__dict__, ['model', 'model_name'])"
-      }
-    ]
-  ],
-  "events": [
-    { "name":"data.input",
-      "attributes": [
-
-        {
-            "_comment": "this is instruction and user query to LLM",
-            "attribute": "input",
-            "accessor": "lambda arguments: extract_messages(arguments['args'])"
-        }
-      ]
-    },
-    {
-      "name":"data.output",
-      "attributes": [
-        {
-            "_comment": "this is response from LLM",
-            "attribute": "response",
-            "accessor": "lambda response: extract_assistant_message(response)"
-        }
-      ]
-   }
-  ]
-}