tmam 1.3__tar.gz

tmam-1.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tmam-1.3/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: tmam
+Version: 1.3
+Summary: OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications and GPUs, facilitating the integration of observability into your GenAI-driven projects
+License: Apache-2.0
+License-File: LICENSE
+Keywords: OpenTelemetry,otel,otlp,llm,tracing,openai,anthropic,claude,cohere,llm monitoring,observability,monitoring,gpt,Generative AI,chatGPT,gpu
+Author: Tmam
+Requires-Python: >=3.12.1,<4.0.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: anthropic (>=0.49.0,<0.50.0)
+Requires-Dist: boto3 (>=1.37.21,<2.0.0)
+Requires-Dist: botocore (>=1.37.21,<2.0.0)
+Requires-Dist: openai (>=1.68.2,<2.0.0)
+Requires-Dist: opentelemetry-api (>=1.31.1,<2.0.0)
+Requires-Dist: opentelemetry-exporter-otlp (>=1.31.1,<2.0.0)
+Requires-Dist: opentelemetry-instrumentation (>=0.52b1,<0.53)
+Requires-Dist: opentelemetry-sdk (>=1.31.1,<2.0.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: schedule (>=1.2.2,<2.0.0)
+Requires-Dist: xmltodict (>=0.14.2,<0.15.0)
+Project-URL: Homepage, https://github.com/python
+Project-URL: Repository, https://github.com/python
+Description-Content-Type: text/markdown
+
+<!-- FOR TESTS -->
+
+cd tmam/sdk/python
+source .venv/bin/activate
+
+pip install pytest pytest-mock pytest-asyncio
+
+pip install wrapt -q
+pip install opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp opentelemetry-instrumentation pydantic requests
+pip install anthropic openai
+
+python -m pytest tests/

tmam-1.3/README.md

@@ -0,0 +1,12 @@
+<!-- FOR TESTS -->
+
+cd tmam/sdk/python
+source .venv/bin/activate
+
+pip install pytest pytest-mock pytest-asyncio
+
+pip install wrapt -q
+pip install opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp opentelemetry-instrumentation pydantic requests
+pip install anthropic openai
+
+python -m pytest tests/

tmam-1.3/pyproject.toml

@@ -0,0 +1,31 @@
+[tool.poetry]
+name = "tmam"
+version = "1.3"
+description = "OpenTelemetry-native Auto instrumentation library for monitoring LLM Applications and GPUs, facilitating the integration of observability into your GenAI-driven projects"
+authors = ["Tmam"]
+license = "Apache-2.0"
+repository = "https://github.com/python"
+readme = "README.md"
+homepage = "https://github.com/python"
+keywords = ["OpenTelemetry", "otel", "otlp","llm", "tracing", "openai", "anthropic", "claude", "cohere", "llm monitoring", "observability", "monitoring", "gpt", "Generative AI", "chatGPT", "gpu"]
+
+packages = [{ include = "tmam", from = "src" }]
+
+[tool.poetry.dependencies]
+python = "^3.12.1"
+requests = "^2.32.3"
+schedule = "^1.2.2"
+pydantic = "^2.10.6"
+xmltodict = "^0.14.2"
+boto3 = "^1.37.21"
+botocore = "^1.37.21"
+opentelemetry-api = "^1.31.1"
+opentelemetry-sdk = "^1.31.1"
+opentelemetry-exporter-otlp = "^1.31.1"
+opentelemetry-instrumentation = "^0.52b1"
+openai = "^1.68.2"
+anthropic = "^0.49.0"
+
+[build-system]
+requires = ["poetry-core>=2.1.1"]
+build-backend = "poetry.core.masonry.api"

tmam-1.3/src/tmam/__helpers.py

@@ -0,0 +1,278 @@
+# pylint: disable=bare-except, broad-exception-caught
+"""
+This module has functions to calculate model costs based on tokens and to fetch pricing information.
+"""
+import os
+import json
+import logging
+from urllib.parse import urlparse
+from typing import Any, Dict, List, Tuple
+import math
+import requests
+from opentelemetry.sdk.resources import SERVICE_NAME, TELEMETRY_SDK_NAME, DEPLOYMENT_ENVIRONMENT
+from opentelemetry.trace import Status, StatusCode
+from opentelemetry._events import Event
+from tmam.semcov import SemanticConvetion
+
+# Set up logging
+logger = logging.getLogger(__name__)
+
+def response_as_dict(response):
+    """
+    Return parsed response as a dict
+    """
+
+    # pylint: disable=no-else-return
+    if isinstance(response, dict):
+        return response
+    if hasattr(response, 'model_dump'):
+        return response.model_dump()
+    elif hasattr(response, 'parse'):
+        return response_as_dict(response.parse())
+    else:
+        return response
+
+def get_env_variable(name, arg_value, error_message):
+    """
+    Retrieve an environment variable if the argument is not provided
+    """
+
+    if arg_value is not None:
+        return arg_value
+    value = os.getenv(name)
+    if not value:
+        logging.error(error_message)
+        raise RuntimeError(error_message)
+    return value
+
+def general_tokens(text):
+    """
+    Calculate the number of tokens a given text would take up.
+    """
+
+    return math.ceil(len(text) / 2)
+
+def get_chat_model_cost(model, pricing_info, prompt_tokens, completion_tokens):
+    """
+    Retrieve the cost of processing for a given model based on prompt and tokens.
+    """
+
+    try:
+        cost = ((prompt_tokens / 1000) * pricing_info['chat'][model]['promptPrice']) + \
+            ((completion_tokens / 1000) * pricing_info['chat'][model]['completionPrice'])
+    except:
+        cost = 0
+    return cost
+
+def get_embed_model_cost(model, pricing_info, prompt_tokens):
+    """
+    Retrieve the cost of processing for a given model based on prompt tokens.
+    """
+
+    try:
+        cost = (prompt_tokens / 1000) * pricing_info['embeddings'][model]
+    except:
+        cost = 0
+    return cost
+
+def get_image_model_cost(model, pricing_info, size, quality):
+    """
+    Retrieve the cost of processing for a given model based on image size and quailty.
+    """
+
+    try:
+        cost = pricing_info['images'][model][quality][size]
+    except:
+        cost = 0
+    return cost
+
+def get_audio_model_cost(model, pricing_info, prompt, duration=None):
+    """
+    Retrieve the cost of processing for a given model based on prompt.
+    """
+
+    try:
+        if prompt:
+            cost = (len(prompt) / 1000) * pricing_info['audio'][model]
+        else:
+            cost = duration * pricing_info['audio'][model]
+    except:
+        cost = 0
+    return cost
+
+def fetch_pricing_info(pricing_json=None):
+    """
+    Fetches pricing information from a specified URL or File Path.
+    """
+
+    if pricing_json:
+        is_url = urlparse(pricing_json).scheme != ''
+        if is_url:
+            pricing_url = pricing_json
+        else:
+            try:
+                with open(pricing_json, mode='r', encoding='utf-8') as f:
+                    return json.load(f)
+            except FileNotFoundError:
+                logger.error('Pricing information file not found: %s', pricing_json)
+            except json.JSONDecodeError:
+                logger.error('Error decoding JSON from file: %s', pricing_json)
+            except Exception as file_err:
+                logger.error('Unexpected error occurred while reading file: %s', file_err)
+            return {}
+    else:
+        pricing_url = 'https://raw.githubusercontent.com/tmam-dev/assets/main/pricing.json'
+    try:
+        # Set a timeout of 10 seconds for both the connection and the read
+        response = requests.get(pricing_url, timeout=20)
+        response.raise_for_status()
+        return response.json()
+    except requests.HTTPError as http_err:
+        logger.error('HTTP error occured while fetching pricing info: %s', http_err)
+    except Exception as err:
+        logger.error('Unexpected error occurred while fetching pricing info: %s', err)
+    return {}
+
+def handle_exception(span,e):
+    """Handles Exception when LLM Function fails or trace creation fails."""
+
+    span.record_exception(e)
+    span.set_status(Status(StatusCode.ERROR))
+
+def calculate_ttft(timestamps: List[float], start_time: float) -> float:
+    """
+    Calculate the time to the first tokens.
+    """
+
+    if timestamps:
+        return timestamps[0] - start_time
+    return 0.0
+
+def calculate_tbt(timestamps: List[float]) -> float:
+    """
+    Calculate the average time between tokens.
+    """
+
+    if len(timestamps) > 1:
+        time_diffs = [timestamps[i] - timestamps[i - 1] for i in range(1, len(timestamps))]
+        return sum(time_diffs) / len(time_diffs)
+    return 0.0
+
+def create_metrics_attributes(
+    service_name: str,
+    deployment_environment: str,
+    operation: str,
+    system: str,
+    request_model: str,
+    server_address: str,
+    server_port: int,
+    response_model: str,
+) -> Dict[Any, Any]:
+    """
+    Returns OTel metrics attributes
+    """
+
+    return {
+        TELEMETRY_SDK_NAME: 'tmam',
+        SERVICE_NAME: service_name,
+        DEPLOYMENT_ENVIRONMENT: deployment_environment,
+        SemanticConvetion.GEN_AI_OPERATION: operation,
+        SemanticConvetion.GEN_AI_SYSTEM: system,
+        SemanticConvetion.GEN_AI_REQUEST_MODEL: request_model,
+        SemanticConvetion.SERVER_ADDRESS: server_address,
+        SemanticConvetion.SERVER_PORT: server_port,
+        SemanticConvetion.GEN_AI_RESPONSE_MODEL: response_model
+    }
+
+def set_server_address_and_port(client_instance: Any,
+    default_server_address: str, default_server_port: int) -> Tuple[str, int]:
+    """
+    Determines and returns the server address and port based on the provided client's `base_url`,
+    using defaults if none found or values are None.
+    """
+
+    # Try getting base_url from multiple potential attributes
+    base_client = getattr(client_instance, '_client', None)
+    base_url = getattr(base_client, 'base_url', None)
+
+    if not base_url:
+        # Attempt to get endpoint from instance._config.endpoint if base_url is not set
+        config = getattr(client_instance, '_config', None)
+        base_url = getattr(config, 'endpoint', None)
+
+    if not base_url:
+        # Attempt to get server_url from instance.sdk_configuration.server_url
+        config = getattr(client_instance, 'sdk_configuration', None)
+        base_url = getattr(config, 'server_url', None)
+
+    if base_url:
+        if isinstance(base_url, str):
+            url = urlparse(base_url)
+            server_address = url.hostname or default_server_address
+            server_port = url.port if url.port is not None else default_server_port
+        else:  # base_url might not be a str; handle as an object.
+            server_address = getattr(base_url, 'host', None) or default_server_address
+            port_attr = getattr(base_url, 'port', None)
+            server_port = port_attr if port_attr is not None else default_server_port
+    else:  # no base_url or endpoint provided; use defaults.
+        server_address = default_server_address
+        server_port = default_server_port
+
+    return server_address, server_port
+
+def otel_event(name, attributes, body):
+    """
+    Returns an OpenTelemetry Event object
+    """
+
+    return Event(
+        name=name,
+        attributes=attributes,
+        body=body,
+    )
+
+def extract_and_format_input(messages):
+    """
+    Process a list of messages to extract content and categorize
+    them into fixed roles like 'user', 'assistant', 'system', 'tool'.
+    """
+
+    fixed_roles = ['user', 'assistant', 'system', 'tool', 'developer']
+    formatted_messages = {role_key: {'role': '', 'content': ''} for role_key in fixed_roles}
+
+    for message in messages:
+        message = response_as_dict(message)
+
+        role = message.get('role')
+        if role not in fixed_roles:
+            continue
+
+        content = message.get('content', '')
+
+        # Prepare content as a string, handling both list and str
+        if isinstance(content, list):
+            content_str = ", ".join(str(item) for item in content)
+        else:
+            content_str = content
+
+        # Set the role in the formatted message and concatenate content
+        if not formatted_messages[role]['role']:
+            formatted_messages[role]['role'] = role
+
+        if formatted_messages[role]['content']:
+            formatted_messages[role]['content'] += ' ' + content_str
+        else:
+            formatted_messages[role]['content'] = content_str
+
+    return formatted_messages
+
+# To be removed one the change to log events (from span events) is complete
+def concatenate_all_contents(formatted_messages):
+    """
+    Concatenate all 'content' fields into a single strin
+    """
+    return ' '.join(
+        message_data['content']
+        for message_data in formatted_messages.values()
+        if message_data['content']
+    )