Skip to main content

OpenTelemetry openai instrumentation

Project description

opentelemetry-instrument-openai

It's OpenTelemetry instrumentation (python) for OpenAI's library.

Project site: https://github.com/cartermp/opentelemetry-instrument-openai-py

Supported APIs:

  • Chat
  • Embeddings
  • Moderation
  • Image (generation, edit, variation)
  • Audio (transcribe, translate)
  • Completion (GPT-3)
  • Edit (GPT-3)

How to use it

Simple! First, install this package.

Usage

With autoinstrumentation agent:

poetry add opentelemetry-instrument-openai
poetry run opentelemetry-bootstrap -a install
poetry run opentelemetry-instrument python your_app.py

If you prefer to do it in code, you can do that too:

import openai
from dotenv import load_dotenv
from opentelemetry.instrument.openai import OpenAIInstrumentor

OpenAIInstrumentor().instrument()

load_dotenv()
openai.api_key = os.getenv("OPENAI_API_KEY")

openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[{"role":"user", "content":"Tell me a joke about opentelemetry"}],
)

You can then run your app normally with your own opentelemetry initialization.

How to develop

Get poetry.

Now install and run tests:

poetry install
poetry run pytest

Now you can develop and run tests as you go!

How to run the example

Click the example folder and read the README.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opentelemetry_instrument_openai-0.7.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file opentelemetry_instrument_openai-0.7.0.tar.gz.

File metadata

File hashes

Hashes for opentelemetry_instrument_openai-0.7.0.tar.gz
Algorithm Hash digest
SHA256 baae28ae7ddcf553cc86558f20ad0fb8ffdab52b5c09840440331ae209f45b14
MD5 93d6bfeb164f5dc030b6990a90541294
BLAKE2b-256 050ce4d8d42f671b595554a58e47186d2b65215db627fd8b96349ba38a5949ba

See more details on using hashes here.

File details

Details for the file opentelemetry_instrument_openai-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_instrument_openai-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4d45c208eb4d0998447e89a5142e2a62e698253f2a86a8368615f06903e0efe
MD5 37ac7d1c09896d5da8c4c3ca6fff251b
BLAKE2b-256 8ad465c10013b016632227c2a5c3d1740473866d2de30fab7562b1ea5daea485

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page