Skip to main content

Raindrop observability integration for Azure OpenAI

Project description

raindrop-azure-openai

Raindrop observability integration for Azure OpenAI (Python). Automatically captures chat.completions.create() calls by wrapping AzureOpenAI and AsyncAzureOpenAI clients.

Installation

pip install raindrop-azure-openai openai

Quick Start

from raindrop_azure_openai import RaindropAzureOpenAI
from openai import AzureOpenAI

raindrop = RaindropAzureOpenAI(
    api_key="rk_...",
    user_id="user-123",
    debug=False,  # set True for verbose logging
)

client = AzureOpenAI(
    azure_endpoint="https://your-resource.openai.azure.com",
    api_key="...",
    api_version="2024-10-21",
)
wrapped = raindrop.wrap(client)

response = wrapped.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello!"}],
)

raindrop.shutdown()

Debug Mode

raindrop = RaindropAzureOpenAI(api_key="rk_...", debug=True)

When debug=True, verbose logs are emitted to the raindrop_azure_openai logger at DEBUG level.

Async Support

from raindrop_azure_openai import RaindropAzureOpenAI
from openai import AsyncAzureOpenAI

raindrop = RaindropAzureOpenAI(api_key="rk_...", user_id="user-123")

client = AsyncAzureOpenAI(
    azure_endpoint="https://your-resource.openai.azure.com",
    api_key="...",
    api_version="2024-10-21",
)
wrapped = raindrop.wrap(client)

response = await wrapped.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello!"}],
)

raindrop.shutdown()

User Identification

raindrop.identify("user-123", traits={"plan": "pro", "name": "Alice"})

Tracking Signals

raindrop.track_signal(
    event_id="evt-abc",
    name="thumbs_up",
    signal_type="feedback",
    sentiment="POSITIVE",
    comment="Great response!",
)

Flushing and Shutdown

raindrop.flush()     # flush pending data
raindrop.shutdown()  # flush + release resources

Factory Function (Backwards-Compatible)

from raindrop_azure_openai import create_raindrop_azure_openai

raindrop = create_raindrop_azure_openai(api_key="rk_...", user_id="user-123")
# raindrop is now a RaindropAzureOpenAI instance with .wrap(), .flush(), .shutdown()

What Gets Captured

  • Chat completions — input messages, output text, model, token usage
  • Finish reasonazure_openai.finish_reason (stop, length, content_filter, tool_calls)
  • Extended tokensai.usage.cached_tokens (prompt cache hits) and ai.usage.thoughts_tokens (reasoning tokens for o1/o3 models)
  • Errors — error type and message captured as properties, then re-raised to the caller
  • Async support — both sync (AzureOpenAI) and async (AsyncAzureOpenAI) clients are instrumented

Configuration

Option Type Default Description
api_key str | None None Raindrop API key. None disables telemetry shipping
user_id str | None None Associate all events with a user (falls back to "unknown")
convo_id str | None None Group events into a conversation
tracing_enabled bool True Enable OTEL-based tracing
bypass_otel_for_tools bool True Bypass OTEL for tool calls
disable_auto_instrument bool True Library auto-instrumentation is opt-in (see below)
debug bool False Enable verbose debug logging

Library auto-instrumentation is opt-in

As of 0.0.4, disable_auto_instrument defaults to True: the integration no longer lets Traceloop monkey-patch every LLM client library it recognizes in your process (the OpenAI client itself, Anthropic, botocore, etc.). The wrapper captures input/output, token usage, model name, and finish_reason directly from the wrapped client's responses, so no library patching is needed for full dashboards.

If you specifically want LLM-call-level spans from library instrumentation and have verified compatibility in your environment, opt back in with disable_auto_instrument=False.

Double-Wrap Protection

Calling wrap() on an already-instrumented client is a safe no-op — the client is returned unchanged.

Full Documentation

See the Raindrop docs for the complete reference.

Testing

cd packages/azure-openai-python
pip install -e ".[dev]"
python -m pytest tests/ -v

License

MIT

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

raindrop_azure_openai-0.0.4.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

raindrop_azure_openai-0.0.4-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file raindrop_azure_openai-0.0.4.tar.gz.

File metadata

  • Download URL: raindrop_azure_openai-0.0.4.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for raindrop_azure_openai-0.0.4.tar.gz
Algorithm Hash digest
SHA256 53a0cfd92a93f21b9acf10a791a42bdf6f6ed912ca8567b735c2d8b77c42ae27
MD5 2924516ae8f46a673f8a94f958b4930c
BLAKE2b-256 32c5b76fe8fbd738403233305584b968708cf28cd13f9b18276d48c145819f75

See more details on using hashes here.

File details

Details for the file raindrop_azure_openai-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for raindrop_azure_openai-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9566a6301b0f25410bcc5cf5233c0c30b15ac79212f8ce60ba684266dac06c1e
MD5 61dc04c3db75294548d00f3e0de7bcc0
BLAKE2b-256 22d2532f0539d860f21154f238c918441c6fef6d104727aaa1b861bcb0e32d31

See more details on using hashes here.

Supported by

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