payi 0.1.0a35__py3-none-any.whl → 0.1.0a37__py3-none-any.whl

payi/lib/instrument.py

@@ -0,0 +1,522 @@
+import json
+import uuid
+import asyncio
+import inspect
+import logging
+import traceback
+from typing import Any, Set, Union, Callable, Optional
+
+from wrapt import ObjectProxy  # type: ignore
+
+from payi import Payi, AsyncPayi
+from payi.types import IngestUnitsParams
+
+from .Stopwatch import Stopwatch
+from .Instruments import Instruments
+
+
+class PayiInstrumentor:
+    def __init__(
+        self,
+        payi: Union[Payi, AsyncPayi, None] = None,
+        instruments: Union[Set[Instruments], None] = None,
+        log_prompt_and_response: bool = True,
+        prompt_and_response_logger: Optional[
+            Callable[[str, "dict[str, str]"], None]
+        ] = None,  # (request id, dict of data to store) -> None
+    ):
+        self._payi: Union[Payi, AsyncPayi, None] = payi
+        self._context_stack: list[dict[str, Any]] = []  # Stack of context dictionaries
+        self._log_prompt_and_response: bool = log_prompt_and_response
+        self._prompt_and_response_logger: Optional[Callable[[str, dict[str, str]], None]] = prompt_and_response_logger
+
+        self._blocked_limits: set[str] = set()
+        self._exceeded_limits: set[str] = set()
+
+        if instruments is None or Instruments.ALL in instruments:
+            self._instrument_all()
+        else:
+            self._instrument_specific(instruments)
+
+    def _instrument_all(self) -> None:
+        self._instrument_openai()
+        self._instrument_anthropic()
+
+    def _instrument_specific(self, instruments: Set[Instruments]) -> None:
+        if Instruments.OPENAI in instruments:
+            self._instrument_openai()
+        if Instruments.ANTHROPIC in instruments:
+            self._instrument_anthropic()
+
+    def _instrument_openai(self) -> None:
+        from .OpenAIInstrumentor import OpenAiInstrumentor
+
+        try:
+            OpenAiInstrumentor.instrument(self)
+
+        except Exception as e:
+            logging.error(f"Error instrumenting OpenAI: {e}")
+
+    def _instrument_anthropic(self) -> None:
+        from .AnthropicInstrumentor import AnthropicIntrumentor
+
+        try:
+            AnthropicIntrumentor.instrument(self)
+
+        except Exception as e:
+            logging.error(f"Error instrumenting Anthropic: {e}")
+
+    def _ingest_units(self, ingest_units: IngestUnitsParams) -> None:
+        # return early if there are no units to ingest and on a successul ingest request
+        if int(ingest_units.get("http_status_code") or 0) < 400:
+            units = ingest_units.get("units", {})
+            if not units or all(unit.get("input", 0) == 0 and unit.get("output", 0) == 0 for unit in units.values()):
+                logging.error(
+                    'No units to ingest.  For OpenAI streaming calls, make sure you pass stream_options={"include_usage": True}'
+                )
+                return
+
+        try:
+            if isinstance(self._payi, AsyncPayi):
+                loop = asyncio.new_event_loop()
+                asyncio.set_event_loop(loop)
+                try:
+                    ingest_result = loop.run_until_complete(self._payi.ingest.units(**ingest_units))
+                finally:
+                    loop.close()
+            elif isinstance(self._payi, Payi):
+                ingest_result = self._payi.ingest.units(**ingest_units)
+            else:
+                logging.error("No payi instance to ingest units")
+                return
+
+            if ingest_result.xproxy_result.limits:
+                for limit_id, state in ingest_result.xproxy_result.limits.items():
+                    removeBlockedId: bool = False
+
+                    if state.state == "blocked":
+                        self._blocked_limits.add(limit_id)
+                    elif state.state == "exceeded":
+                        self._exceeded_limits.add(limit_id)
+                        removeBlockedId = True
+                    elif state.state == "ok":
+                        removeBlockedId = True
+
+                    # opportunistically remove blocked limits
+                    if removeBlockedId:
+                        self._blocked_limits.discard(limit_id)
+
+            if self._log_prompt_and_response and self._prompt_and_response_logger:
+                request_id = ingest_result.xproxy_result.request_id
+
+                log_data = {}
+                response_json = ingest_units.pop("provider_response_json", None)
+                request_json = ingest_units.pop("provider_request_json", None)
+                stack_trace = ingest_units.get("properties", {}).pop("system.stack_trace", None)  # type: ignore
+
+                if response_json is not None:
+                    # response_json is a list of strings, convert a single json string
+                    log_data["provider_response_json"] = json.dumps(response_json)
+                if request_json is not None:
+                    log_data["provider_request_json"] = request_json
+                if stack_trace is not None:
+                    log_data["stack_trace"] = stack_trace
+
+                self._prompt_and_response_logger(request_id, log_data)  # type: ignore
+
+        except Exception as e:
+            logging.error(f"Error Pay-i ingesting result: {e}")
+
+    def _call_func(
+        self,
+        func: Any,
+        proxy: bool,
+        limit_ids: Optional["list[str]"],
+        request_tags: Optional["list[str]"],
+        experience_name: Optional[str],
+        experience_id: Optional[str],
+        user_id: Optional[str],
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if len(self._context_stack) > 0:
+            # copy current context into the upcoming context
+            context = self._context_stack[-1].copy()
+            context.pop("proxy", None)
+            previous_experience_name = context["experience_name"]
+            previous_experience_id = context["experience_id"]
+        else:
+            context = {}
+            previous_experience_name = None
+            previous_experience_id = None
+
+        with self:
+            context["proxy"] = proxy
+
+            # Handle experience name and ID logic
+            if not experience_name:
+                # If no experience_name specified, use previous values
+                context["experience_name"] = previous_experience_name
+                context["experience_id"] = previous_experience_id
+            else:
+                # If experience_name is specified
+                if experience_name == previous_experience_name:
+                    # Same experience name, use previous ID unless new one specified
+                    context["experience_name"] = experience_name
+                    context["experience_id"] = experience_id if experience_id else previous_experience_id
+                else:
+                    # Different experience name, use specified ID or generate one
+                    context["experience_name"] = experience_name
+                    context["experience_id"] = experience_id if experience_id else str(uuid.uuid4())
+
+            # set any values explicitly passed by the caller, otherwise use what is already in the context
+            if limit_ids:
+                context["limit_ids"] = limit_ids
+            if request_tags:
+                context["request_tags"] = request_tags
+            if user_id:
+                context["user_id"] = user_id
+
+            self.set_context(context)
+
+            return func(*args, **kwargs)
+
+    def __enter__(self) -> Any:
+        # Push a new context dictionary onto the stack
+        self._context_stack.append({})
+        return self
+
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        # Pop the current context off the stack
+        if self._context_stack:
+            self._context_stack.pop()
+
+    def set_context(self, context: "dict[str, Any]") -> None:
+        # Update the current top of the stack with the provided context
+        if self._context_stack:
+            self._context_stack[-1].update(context)
+
+    def get_context(self) -> Optional["dict[str, Any]"]:
+        # Return the current top of the stack
+        return self._context_stack[-1] if self._context_stack else None
+
+    def chat_wrapper(
+        self,
+        category: str,
+        process_chunk: Callable[[Any, IngestUnitsParams], None],
+        process_synchronous_response: Optional[Callable[[Any, IngestUnitsParams, bool], None]],
+        wrapped: Any,
+        instance: Any,
+        args: Any,
+        kwargs: Any,
+    ) -> Any:
+        context = self.get_context()
+
+        if not context:
+            # should not happen
+            return wrapped(*args, **kwargs)
+
+        # after _udpate_headers, all metadata to add to ingest is in extra_headers, keyed by the xproxy-xxx header name
+        extra_headers = kwargs.get("extra_headers", {})
+        self._update_headers(context, extra_headers)
+
+        if context.get("proxy", True):
+            if "extra_headers" not in kwargs:
+                kwargs["extra_headers"] = extra_headers
+
+            return wrapped(*args, **kwargs)
+
+        ingest: IngestUnitsParams = {"category": category, "resource": kwargs.get("model"), "units": {}}
+
+        # blocked_limit = next((limit for limit in (context.get('limit_ids') or []) if limit in self._blocked_limits), None)
+        # if blocked_limit:
+        #      raise Exception(f"Limit {blocked_limit} is blocked")
+        current_frame = inspect.currentframe()
+        # f_back excludes the current frame, strip() cleans up whitespace and newlines
+        stack = [frame.strip() for frame in traceback.format_stack(current_frame.f_back)]  # type: ignore
+
+        # TODO add back once feature is in prod
+        # ingest['properties'] = { 'system.stack_trace': json.dumps(stack) }
+
+        sw = Stopwatch()
+        stream = kwargs.get("stream", False)
+
+        try:
+            limit_ids = extra_headers.pop("xProxy-Limit-IDs", None)
+            request_tags = extra_headers.pop("xProxy-Request-Tags", None)
+            experience_name = extra_headers.pop("xProxy-Experience-Name", None)
+            experience_id = extra_headers.pop("xProxy-Experience-ID", None)
+            user_id = extra_headers.pop("xProxy-User-ID", None)
+
+            if limit_ids:
+                ingest["limit_ids"] = limit_ids.split(",")
+            if request_tags:
+                ingest["request_tags"] = request_tags.split(",")
+            if experience_name:
+                ingest["experience_name"] = experience_name
+            if experience_id:
+                ingest["experience_id"] = experience_id
+            if user_id:
+                ingest["user_id"] = user_id
+
+            if len(extra_headers) > 0:
+                ingest["provider_request_headers"] = {k: [v] for k, v in extra_headers.items()}  # type: ignore
+
+            provider_prompt = {}
+            for k, v in kwargs.items():
+                if k == "messages":
+                    provider_prompt[k] = [m.model_dump() if hasattr(m, "model_dump") else m for m in v]
+                elif k in ["extra_headers", "extra_query"]:
+                    pass
+                else:
+                    provider_prompt[k] = v
+
+            if self._log_prompt_and_response:
+                ingest["provider_request_json"] = json.dumps(provider_prompt)
+
+            sw.start()
+            response = wrapped(*args, **kwargs.copy())
+
+        except Exception as e:  # pylint: disable=broad-except
+            sw.stop()
+            duration = sw.elapsed_ms_int()
+
+            # TODO ingest error
+
+            raise e
+
+        if stream:
+            return ChatStreamWrapper(
+                response=response,
+                instance=instance,
+                instrumentor=self,
+                log_prompt_and_response=self._log_prompt_and_response,
+                ingest=ingest,
+                stopwatch=sw,
+                process_chunk=process_chunk,
+            )
+
+        sw.stop()
+        duration = sw.elapsed_ms_int()
+        ingest["end_to_end_latency_ms"] = duration
+        ingest["http_status_code"] = 200
+
+        if process_synchronous_response:
+            process_synchronous_response(response, ingest, self._log_prompt_and_response)
+
+        self._ingest_units(ingest)
+
+        return response
+
+    @staticmethod
+    def _update_headers(
+        context: "dict[str, Any]",
+        extra_headers: "dict[str, str]",
+    ) -> None:
+        limit_ids: Optional[list[str]] = context.get("limit_ids")
+        request_tags: Optional[list[str]] = context.get("request_tags")
+        experience_name: Optional[str] = context.get("experience_name")
+        experience_id: Optional[str] = context.get("experience_id")
+        user_id: Optional[str] = context.get("user_id")
+
+        # Merge limits from the decorator and extra headers
+        if limit_ids is not None:
+            existing_limit_ids = extra_headers.get("xProxy-Limit-IDs", None)
+            
+            if not existing_limit_ids:
+                extra_headers["xProxy-Limit-IDs"] = ",".join(limit_ids)
+            else:
+                existing_ids = existing_limit_ids.split(',')
+                combined_ids = list(set(existing_ids + limit_ids))
+                extra_headers["xProxy-Limit-IDs"] = ",".join(combined_ids)
+
+        # Merge request from the decorator and extra headers
+        if request_tags is not None:
+            existing_request_tags = extra_headers.get("xProxy-Request-Tags", None)
+
+            if not existing_request_tags:
+                extra_headers["xProxy-Request-Tags"] = ",".join(request_tags)
+            else:
+                existing_tags = existing_request_tags.split(',')
+                combined_tags = list(set(existing_tags + request_tags))
+                extra_headers["xProxy-Request-Tags"] = ",".join(combined_tags)
+
+        # inner extra_headers user_id takes precedence over outer decorator user_id
+        if user_id is not None and extra_headers.get("xProxy-User-ID", None) is None:
+            extra_headers["xProxy-User-ID"] = user_id   
+
+        # inner extra_headers experience_name and experience_id take precedence over outer decorator experience_name and experience_id
+        # if either inner value is specified, ignore outer decorator values
+        if extra_headers.get("xProxy-Experience-Name", None) is None and extra_headers.get("xProxy-Experience-ID", None) is None:
+            if experience_name is not None:
+                extra_headers["xProxy-Experience-Name"] = experience_name
+
+            if experience_id is not None:
+                extra_headers["xProxy-Experience-ID"] = experience_id
+
+    @staticmethod
+    def payi_wrapper(func: Any) -> Any:
+        def _payi_wrapper(o: Any) -> Any:
+            def wrapper(wrapped: Any, instance: Any, args: Any, kwargs: Any) -> Any:
+                return func(
+                    o,
+                    wrapped,
+                    instance,
+                    args,
+                    kwargs,
+                )
+
+            return wrapper
+
+        return _payi_wrapper
+
+
+class ChatStreamWrapper(ObjectProxy):  # type: ignore
+    def __init__(
+        self,
+        response: Any,
+        instance: Any,
+        instrumentor: PayiInstrumentor,
+        ingest: IngestUnitsParams,
+        stopwatch: Stopwatch,
+        process_chunk: Optional[Callable[[Any, IngestUnitsParams], None]] = None,
+        log_prompt_and_response: bool = True,
+    ) -> None:
+        super().__init__(response)  # type: ignore
+
+        self._response = response
+        self._instance = instance
+
+        self._instrumentor = instrumentor
+        self._stopwatch: Stopwatch = stopwatch
+        self._ingest: IngestUnitsParams = ingest
+        self._log_prompt_and_response: bool = log_prompt_and_response
+        self._responses: list[str] = []
+
+        self._process_chunk: Optional[Callable[[Any, IngestUnitsParams], None]] = process_chunk
+
+        self._first_token: bool = True
+
+    def __enter__(self) -> Any:
+        return self
+
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None: 
+        self.__wrapped__.__exit__(exc_type, exc_val, exc_tb)  # type: ignore
+
+    async def __aenter__(self) -> Any:
+        return self
+
+    async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        await self.__wrapped__.__aexit__(exc_type, exc_val, exc_tb)  # type: ignore
+
+    def __iter__(self) -> Any:
+        return self
+
+    def __aiter__(self) -> Any:
+        return self
+
+    def __next__(self) -> Any:
+        try:
+            chunk: Any = self.__wrapped__.__next__()  # type: ignore
+        except Exception as e:
+            if isinstance(e, StopIteration):
+                self._stop_iteration()
+            raise e
+        else:
+            self._evaluate_chunk(chunk)
+            return chunk
+
+    async def __anext__(self) -> Any:
+        try:
+            chunk: Any = await self.__wrapped__.__anext__()  # type: ignore
+        except Exception as e:
+            if isinstance(e, StopAsyncIteration):
+                self._stop_iteration()
+            raise e
+        else:
+            self._evaluate_chunk(chunk)
+            return chunk
+
+    def _evaluate_chunk(self, chunk: Any) -> None:
+        if self._first_token:
+            self._ingest["time_to_first_token_ms"] = self._stopwatch.elapsed_ms_int()
+            self._first_token = False
+
+        if self._log_prompt_and_response:
+            self._responses.append(chunk.to_json())
+
+        if self._process_chunk:
+            self._process_chunk(chunk, self._ingest)
+
+    def _stop_iteration(self) -> None:
+        self._stopwatch.stop()
+        self._ingest["end_to_end_latency_ms"] = self._stopwatch.elapsed_ms_int()
+        self._ingest["http_status_code"] = 200
+
+        if self._log_prompt_and_response:
+            self._ingest["provider_response_json"] = self._responses
+
+        self._instrumentor._ingest_units(self._ingest)
+
+
+global _instrumentor
+_instrumentor: PayiInstrumentor
+
+
+def payi_instrument(
+    payi: Optional[Union[Payi, AsyncPayi]] = None,
+    instruments: Optional[Set[Instruments]] = None,
+    log_prompt_and_response: bool = True,
+    prompt_and_response_logger: Optional[Callable[[str, "dict[str, str]"], None]] = None,
+) -> None:
+    global _instrumentor
+    _instrumentor = PayiInstrumentor(
+        payi=payi,
+        instruments=instruments,
+        log_prompt_and_response=log_prompt_and_response,
+        prompt_and_response_logger=prompt_and_response_logger,
+    )
+
+
+def ingest(
+    limit_ids: Optional["list[str]"] = None,
+    request_tags: Optional["list[str]"] = None,
+    experience_name: Optional[str] = None,
+    experience_id: Optional[str] = None,
+    user_id: Optional[str] = None,
+) -> Any:
+    def _ingest(func: Any) -> Any:
+        def _ingest_wrapper(*args: Any, **kwargs: Any) -> Any:
+            return _instrumentor._call_func(
+                func,
+                False,  # false -> ingest
+                limit_ids,
+                request_tags,
+                experience_name,
+                experience_id,
+                user_id,
+                *args,
+                **kwargs,
+            )
+
+        return _ingest_wrapper
+
+    return _ingest
+
+
+def proxy(
+    limit_ids: Optional["list[str]"] = None,
+    request_tags: Optional["list[str]"] = None,
+    experience_name: Optional[str] = None,
+    experience_id: Optional[str] = None,
+    user_id: Optional[str] = None,
+) -> Any:
+    def _proxy(func: Any) -> Any:
+        def _proxy_wrapper(*args: Any, **kwargs: Any) -> Any:
+            return _instrumentor._call_func(
+                func, True, limit_ids, request_tags, experience_name, experience_id, user_id, *args, **kwargs
+            )
+
+        return _proxy_wrapper
+
+    return _proxy

payi/resources/billing_models.py

@@ -32,7 +32,7 @@ class BillingModelsResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> BillingModelsResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
@@ -226,7 +226,7 @@ class AsyncBillingModelsResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncBillingModelsResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers

payi/resources/categories/categories.py

@@ -38,7 +38,7 @@ class CategoriesResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> CategoriesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
@@ -184,7 +184,7 @@ class AsyncCategoriesResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncCategoriesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers

payi/resources/categories/resources.py

@@ -32,7 +32,7 @@ class ResourcesResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ResourcesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
@@ -218,7 +218,7 @@ class AsyncResourcesResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncResourcesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers

payi/resources/experiences/experiences.py

@@ -47,7 +47,7 @@ class ExperiencesResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ExperiencesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
@@ -175,7 +175,7 @@ class AsyncExperiencesResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncExperiencesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers

payi/resources/experiences/properties.py

@@ -30,7 +30,7 @@ class PropertiesResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> PropertiesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
@@ -86,7 +86,7 @@ class AsyncPropertiesResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncPropertiesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers

payi/resources/experiences/types.py

@@ -31,7 +31,7 @@ class TypesResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> TypesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers
@@ -238,7 +238,7 @@ class AsyncTypesResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncTypesResourceWithRawResponse:
         """
-        This property can be used as a prefix for any HTTP method call to return the
+        This property can be used as a prefix for any HTTP method call to return
         the raw response object instead of the parsed content.
 
         For more information, see https://www.github.com/Pay-i/pay-i-python#accessing-raw-response-data-eg-headers