Metadata-Version: 2.1
Name: syntrac-opentelemetry-instrumentation-openai
Version: 0.0.1
Summary: OpenTelemetry OpenAI instrumentation
Home-page: https://github.com/syntracAI/syntrac/tree/main/packages/python/opentelemetry-instrumentation-openai
License: Apache-2.0
Author: Vuong Ngo
Author-email: vuongngo.pd@gmail.com
Requires-Python: >=3.9,<4
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: instruments
Requires-Dist: deprecated (==1.2.14) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: importlib-metadata (==6.11.0) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: opentelemetry-api (==1.23.0) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: opentelemetry-instrumentation (==0.44b0) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: opentelemetry-semantic-conventions (==0.44b0) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: setuptools (==69.2.0) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: syntrac-opentelemetry-semantic-conventions-ai (==0.0.1) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: wrapt (==1.16.0) ; python_version >= "3.9" and python_version < "4"
Requires-Dist: zipp (==3.18.1) ; python_version >= "3.9" and python_version < "4"
Project-URL: Repository, https://github.com/syntracAI/syntrac/tree/main/packages/python/opentelemetry-instrumentation-openai
Description-Content-Type: text/markdown

# OpenTelemetry OpenAI Instrumentation

<a href="https://pypi.org/project/syntrac-opentelemetry-instrumentation-openai/">
    <img src="https://badge.fury.io/py/syntrac-opentelemetry-instrumentation-openai.svg">
</a>

This library allows tracing OpenAI prompts and completions sent with the official [OpenAI library](https://github.com/openai/openai-python).

## Installation

```bash
pip install syntrac-opentelemetry-instrumentation-openai
```

## Example usage

```python
from syntrac_opentelemetry.instrumentation.openai import OpenAIInstrumentor

OpenAIInstrumentor().instrument()
```

## Privacy

**By default, this instrumentation logs prompts, completions, and embeddings to span attributes**. This gives you a clear visibility into how your LLM application is working, and can make it easy to debug and evaluate the quality of the outputs.

However, you may want to disable this logging for privacy reasons, as they may contain highly sensitive data from your users. You may also simply want to reduce the size of your traces.

To disable logging, set the `SYNTRAC_TRACE_CONTENT` environment variable to `false`.

```bash
SYNTRAC_TRACE_CONTENT=false
```

