cancontech-tracing 0.0.1__tar.gz

cancontech_tracing-0.0.1/.env

@@ -0,0 +1 @@
+PYPI_TOKEN=pypi-AgEIcHlwaS5vcmcCJGQ1MGVkNDI2LTczMjQtNGM0My04MWY0LWIxMDYzZTZjODA4YwACKlszLCJmMzdlMWU2Mi05NzBhLTQ1YzItODUwOC0wZWM4NWFjYjNkYjQiXQAABiCOzWKHmDZBmRsROGu8wGkV5TrU7zz7AnPsfHH1nEpOpQ

cancontech_tracing-0.0.1/.env.example

@@ -0,0 +1,7 @@
+PHOENIX_DEFAULT_ADMIN_INITIAL_PASSWORD=phoenix
+PHOENIX_SQL_DATABASE_URL=
+PHOENIX_SECRET=
+
+PHOENIX_PORT=6006
+PHOENIX_GRPC_PORT=4317
+PHOENIX_PROM_PORT=9090

cancontech_tracing-0.0.1/.gitignore

@@ -0,0 +1,9 @@
+.idea/
+.DS_Store
+__pycache__/
+*.pyc
+dist/
+build/
+*.egg-info/
+.venv/
+.uv/

cancontech_tracing-0.0.1/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.

cancontech_tracing-0.0.1/Makefile

@@ -0,0 +1,24 @@
+PYPI_REPOSITORY_URL ?= https://upload.pypi.org/legacy/
+PYPI_TOKEN ?= $(TOKEN)
+
+.PHONY: clean build_package check_package publish test
+
+clean:
+	rm -rf dist build *.egg-info
+
+build_package: clean
+	uvx --from build pyproject-build --installer uv
+
+check_package: build_package
+	uvx twine check dist/*
+
+publish: check_package
+	uvx twine upload \
+		--repository-url "$(PYPI_REPOSITORY_URL)" \
+		--username __token__ \
+		--password "$(PYPI_TOKEN)" \
+		dist/* \
+		--verbose
+
+test:
+	uv run pytest

cancontech_tracing-0.0.1/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: cancontech_tracing
+Version: 0.0.1
+Summary: cancontech tracing library
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.111.0
+Requires-Dist: openinference-instrumentation-anthropic==0.1.20
+Requires-Dist: openinference-instrumentation-google-genai>=0.1.12
+Requires-Dist: openinference-instrumentation-openai==0.1.41
+Requires-Dist: openinference-instrumentation==0.1.41
+Requires-Dist: opentelemetry-api>=1.39.0
+Requires-Dist: opentelemetry-exporter-otlp>=1.39.0
+Requires-Dist: opentelemetry-instrumentation-aiohttp-client==0.60b0
+Requires-Dist: opentelemetry-sdk>=1.39.0
+Requires-Dist: pydantic>=2.12.3
+Description-Content-Type: text/markdown
+
+# **What is it?**
+
+## CanConTech Tracing
+
+Collection of tracing utility functions
+
+
+### Installation
+
+* Install **uv**:
+	* Windows: `powershell -c "irm https://astral.sh/uv/install.ps1 | iex"`
+	* macOS/Linux: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+* Set env var `UV_NATIVE_TLS=true` to avoid certificate errors
+* Sync environment: `uv sync`. This will create a new default virtual environment (.venv) if it doesn't exist
+
+
+### Testing
+
+#### unit tests
+`uv run pytest src/tests/unit`
+
+#### integration tests
+```
+ARIZE_CONTAINER_ID=$(docker run --rm -d -p 6006:6006 -p 4317:4317 -i -t arizephoenix/phoenix:latest)
+
+uv run pytest src/tests/integration
+
+docker stop $ARIZE_CONTAINER_ID
+
+```

cancontech_tracing-0.0.1/README.md

@@ -0,0 +1,30 @@
+# **What is it?**
+
+## CanConTech Tracing
+
+Collection of tracing utility functions
+
+
+### Installation
+
+* Install **uv**:
+	* Windows: `powershell -c "irm https://astral.sh/uv/install.ps1 | iex"`
+	* macOS/Linux: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+* Set env var `UV_NATIVE_TLS=true` to avoid certificate errors
+* Sync environment: `uv sync`. This will create a new default virtual environment (.venv) if it doesn't exist
+
+
+### Testing
+
+#### unit tests
+`uv run pytest src/tests/unit`
+
+#### integration tests
+```
+ARIZE_CONTAINER_ID=$(docker run --rm -d -p 6006:6006 -p 4317:4317 -i -t arizephoenix/phoenix:latest)
+
+uv run pytest src/tests/integration
+
+docker stop $ARIZE_CONTAINER_ID
+
+```

cancontech_tracing-0.0.1/docker-compose.yml

@@ -0,0 +1,26 @@
+services:
+  phoenix:
+    image: arizephoenix/phoenix:latest
+    container_name: arize_phoenix
+    restart: unless-stopped
+    environment:
+      PHOENIX_SQL_DATABASE_URL: ${PHOENIX_SQL_DATABASE_URL:-postgresql://phoenix:phoenix@phoenix_postgres:5432/phoenix}
+      PHOENIX_ENABLE_AUTH: "true"
+      PHOENIX_SECRET: ${PHOENIX_SECRET}
+      PHOENIX_DEFAULT_ADMIN_INITIAL_PASSWORD: ${PHOENIX_DEFAULT_ADMIN_INITIAL_PASSWORD}
+      PHOENIX_WORKING_DIR: /mnt/data
+    ports:
+      - "${PHOENIX_PORT:-6006}:6006" # UI + OTLP HTTP
+      - "${PHOENIX_GRPC_PORT:-4317}:4317" # OTLP gRPC
+      - "${PHOENIX_PROM_PORT:-9090}:9090" # Optional Prometheus
+    volumes:
+      - phoenix_data:/mnt/data
+    networks:
+      - dokploy-network
+
+volumes:
+  phoenix_data:
+
+networks:
+  dokploy-network:
+    external: true

cancontech_tracing-0.0.1/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "cancontech_tracing"
+version = "0.0.1"
+description = "cancontech tracing library"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "openinference-instrumentation-openai==0.1.41",
+    "openinference-instrumentation-google-genai>=0.1.12",
+    "openinference-instrumentation-anthropic==0.1.20",
+    "openinference-instrumentation==0.1.41",
+    "opentelemetry-instrumentation-aiohttp-client==0.60b0",
+    "opentelemetry-api>=1.39.0",
+    "opentelemetry-exporter-otlp>=1.39.0",
+    "opentelemetry-sdk>=1.39.0",
+    "pydantic>=2.12.3",
+    "fastapi>=0.111.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+src = ["src"]
+target-version = "py311"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "I"]
+[tool.uv]
+dev-dependencies = [
+    "pytest==8.3.2",
+    "pytest-asyncio==1.2.0",
+    "ruff>=0.13.0",
+]

cancontech_tracing-0.0.1/src/cancontech_tracing/__init__.py

@@ -0,0 +1,14 @@
+from openinference.semconv.trace import OpenInferenceSpanKindValues
+
+from .add_span_attributes import add_current_span_attributes, add_span_attributes
+from .init_tracing import init_tracing
+from .traceable import ML_TRACEPARENT_HEADER_NAME, traceable
+
+__all__ = [
+    "traceable",
+    "ML_TRACEPARENT_HEADER_NAME",
+    "add_span_attributes",
+    "add_current_span_attributes",
+    "init_tracing",
+    "OpenInferenceSpanKindValues",
+]

cancontech_tracing-0.0.1/src/cancontech_tracing/_with_span.py

@@ -0,0 +1,70 @@
+import logging
+import traceback
+from typing import Optional
+
+from opentelemetry import trace as trace_api
+from opentelemetry.util.types import Attributes
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+
+class _WithSpan:
+    def __init__(
+        self,
+        span: trace_api.Span,
+    ) -> None:
+        self._span = span
+        try:
+            self._is_finished = not self._span.is_recording()
+        except Exception:
+            logger.exception("Failed to check if span is recording")
+            self._is_finished = True
+
+    @property
+    def is_finished(self) -> bool:
+        return self._is_finished
+
+    def record_exception(self, exception: Exception) -> None:
+        if self._is_finished:
+            return
+        try:
+            self._span.record_exception(exception)
+            self._span.set_attribute("exception.stacktrace", traceback.format_exc())
+        except Exception:
+            logger.exception("Failed to record exception on span")
+
+    def add_event(self, name: str) -> None:
+        if self._is_finished:
+            return
+        try:
+            self._span.add_event(name)
+        except Exception:
+            logger.exception("Failed to add event to span")
+
+    def finish_tracing(
+        self,
+        status: Optional[trace_api.Status] = None,
+        attributes: Attributes = None,
+    ) -> None:
+        if attributes is None:
+            attributes = {}
+        if self._is_finished:
+            return
+        for key, value in attributes.items():
+            if value is None:
+                continue
+            try:
+                self._span.set_attribute(key, value)
+            except Exception:
+                logger.exception("Failed to set attribute on span")
+        if status is not None:
+            try:
+                self._span.set_status(status=status)
+            except Exception:
+                logger.exception("Failed to set status code on span")
+        try:
+            self._span.end()
+        except Exception:
+            logger.exception("Failed to end span")
+        self._is_finished = True

cancontech_tracing-0.0.1/src/cancontech_tracing/add_span_attributes.py

@@ -0,0 +1,67 @@
+from typing import Any, Dict
+
+from opentelemetry import trace as trace_api
+from opentelemetry.sdk.trace import Span
+
+
+def add_span_attributes(span: Span, attributes: Dict[str, Any]):
+    """
+    Adds the specified attributes to the given span.
+
+    This function sets key-value attributes to a tracing span.
+    If the span is invalid (i.e., not actively traced), the function does nothing.
+
+    Parameters
+    ----------
+    span : Span
+        The span to which the attributes will be added.
+
+    attributes : Dict[str, Any]
+        A dictionary containing the attributes to be added to the span.
+        Each key is the name of the attribute, and each value is the corresponding value to be set.
+
+    Example
+    -------
+    .. code-block:: python
+
+        from ytracing import add_span_attributes
+
+        span = get_current_span()
+        attributes = {"user_id": "12345", "request_id": "abcde"}
+        add_span_attributes(span, attributes)
+    """
+    if span is not trace_api.INVALID_SPAN:
+        for key, value in attributes.items():
+            span.set_attribute(key, value)
+
+
+def add_current_span_attributes(attributes: Dict[str, Any]):
+    """
+    Adds the specified attributes to the current span.
+
+    This function retrieves the current active tracing span and assigns the given key-value attributes to it.
+    It internally uses the `add_span_attributes` function to set these attributes.
+    If there is no valid current span, the function does nothing.
+
+    Parameters
+    ----------
+    attributes : Dict[str, Any]
+        A dictionary containing the attributes to be added to the current span.
+        Each key is the name of the attribute, and each value is the corresponding value to be set.
+
+    Example
+    -------
+    .. code-block:: python
+
+        from ytracing import add_current_span_attributes
+
+        attributes = {"method": "GET", "status_code": 200}
+        add_current_span_attributes(attributes)
+
+    Notes
+    -----
+    It is a convenience wrapper around the `add_span_attributes` function,
+    which allows you to avoid manually fetching the current span.
+
+    """
+    add_span_attributes(trace_api.get_current_span(), attributes)

cancontech_tracing-0.0.1/src/cancontech_tracing/ctracing_otl_span_exporter.py

@@ -0,0 +1,24 @@
+from typing import Dict, Optional
+
+import requests
+from opentelemetry.exporter.otlp.proto.http import Compression
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+
+
+class CtracingOTLSpanExporter(OTLPSpanExporter):
+    def __init__(
+        self,
+        user_agent: str,
+        endpoint: Optional[str] = None,
+        certificate_file: Optional[str] = None,
+        headers: Optional[Dict[str, str]] = None,
+        timeout: Optional[int] = None,
+        compression: Optional[Compression] = None,
+        session: Optional[requests.Session] = None,
+    ):
+        super().__init__(endpoint, certificate_file, headers, timeout, compression, session)
+        self._session.headers.update(
+            {
+                "User-Agent": user_agent,
+            }
+        )

cancontech_tracing-0.0.1/src/cancontech_tracing/helpers.py

@@ -0,0 +1,69 @@
+import copy
+import dataclasses
+import inspect
+import json
+from typing import Any, AsyncGenerator, Generator, Optional
+
+from pydantic_core import to_jsonable_python
+
+
+def _show_repr_str(obj: Any) -> Optional[str]:
+    if isinstance(obj, (Generator, AsyncGenerator)):
+        return f"<{obj.__class__.__qualname__} object>"
+    if callable(obj):
+        try:
+            return f"<{obj.__qualname__}{str(inspect.signature(obj))}>"
+        except BaseException:
+            return f"<{obj.__class__.__qualname__} object>"
+    return None
+
+
+def _asdict(obj: Any) -> Any:
+    """
+    This is a copy of Python's `_asdict_inner` function (linked below) but modified primarily to
+    not throw exceptions for objects that cannot be deep-copied, e.g. Generators.
+    https://github.com/python/cpython/blob/b134f47574c36e842253266ecf0d144fb6f3b546/Lib/dataclasses.py#L1332
+    """  # noqa: E501
+    if dataclasses.is_dataclass(obj):
+        result = []
+        for f in dataclasses.fields(obj):
+            value = _asdict(getattr(obj, f.name))
+            result.append((f.name, value))
+        return dict(result)
+    elif isinstance(obj, tuple) and hasattr(obj, "_fields"):
+        return type(obj)(*[_asdict(v) for v in obj])
+    elif isinstance(obj, (list, tuple)):
+        return type(obj)(_asdict(v) for v in obj)
+    elif isinstance(obj, dict):
+        return type(obj)((_asdict(k), _asdict(v)) for k, v in obj.items())
+    else:
+        if repr_str := _show_repr_str(obj):
+            return repr_str
+        try:
+            return copy.deepcopy(obj)
+        except BaseException:
+            return repr(obj)
+
+
+def _encoder(obj: Any) -> Any:
+    if repr_str := _show_repr_str(obj):
+        return repr_str
+    if dataclasses.is_dataclass(obj):
+        return _asdict(obj)
+    try:
+        return to_jsonable_python(obj)
+    except BaseException:
+        return repr(obj)
+
+
+class _Encoder(json.JSONEncoder):
+    def __init__(self, **kwargs: Any) -> None:
+        kwargs.pop("default", None)
+        super().__init__()
+
+    def default(self, obj: Any) -> Any:
+        return _encoder(obj)
+
+
+def safe_json_dumps(obj: Any, **kwargs: Any) -> str:
+    return json.dumps(obj, default=str, ensure_ascii=False, **kwargs)