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.5.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrument_openai-0.5.0.tar.gz
Algorithm Hash digest
SHA256 cf1ea24a15001da45c16f7e602f863b7f51be2a342e0ddf77bc0a5bb05fd1b87
MD5 a90a504f2faee6b1e33fd293129d12ee
BLAKE2b-256 b1ad6e8d45500f99c28e896c0fd08a4965cdf153df4a65f342b7014ac5b22331

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrument_openai-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a5a08e8600adff29a2435c62f75b8d6aee9e0a9ef6fc25fa0d32d0a811b80605
MD5 51f6a4efc989a1e2142565df21f71d20
BLAKE2b-256 bbdee8b32e61acd816140da718a4211610e7dc16a5a4068578fc2116ee37dec8

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