Skip to main content

Raindrop integration for Google Vertex AI / Gen AI

Project description

raindrop-vertex-ai

Raindrop integration for Google Vertex AI / Gen AI (Python). Automatically captures models.generate_content() and aio.models.generate_content() calls.

Installation

pip install raindrop-vertex-ai google-genai

google-genai is a required dependency.

Quick Start

from raindrop_vertex_ai import RaindropVertexAI
from google import genai

raindrop = RaindropVertexAI(api_key="your-write-key", user_id="user-123")

client = genai.Client(api_key="...")
wrapped = raindrop.wrap(client)

response = wrapped.models.generate_content(
    model="gemini-2.0-flash", contents="Hello!"
)
print(response.text)

raindrop.shutdown()

Omitting api_key disables telemetry shipping (a warning is emitted) but does not crash your application.

What Gets Tracked

  • generate_content — input content, output text, model name
  • Token usage — prompt_token_count and candidates_token_count from usage metadata
  • Cached tokenscached_content_token_count from usage metadata → ai.usage.cached_tokens
  • Thinking tokensthoughts_token_count from usage metadata (Gemini 2.5) → ai.usage.thoughts_tokens
  • Finish reasoncandidate.finish_reason (STOP, MAX_TOKENS, SAFETY, RECITATION) → vertex_ai.finish_reason
  • Errors — captured with error type and message in properties, then re-raised
  • Async support — both models.generate_content (sync) and aio.models.generate_content (async) are instrumented
  • Double-wrap guard — calling wrap() on an already-wrapped client is a safe no-op

Configuration

raindrop = RaindropVertexAI(
    api_key="rk_...",                    # Optional: your Raindrop API key
    user_id="user-123",                  # Optional: associate events with a user
    convo_id="convo-456",                # Optional: conversation/thread ID
    project_id="support-prod",           # Optional: route events to a specific project (slug)
    tracing_enabled=True,                # Optional: enable Raindrop tracing (default: True)
    bypass_otel_for_tools=True,          # Optional: bypass OTEL for tools (default: True)
    debug=True,                          # Optional: enable verbose DEBUG logging
)
Option Type Default Description
api_key str None Raindrop API key
user_id str None Associate all events with a user
convo_id str None Group events into a conversation
project_id str None Route events to a specific project (slug); omit for the default Production project
tracing_enabled bool True Enable Raindrop tracing
bypass_otel_for_tools bool True Bypass OpenTelemetry for tool instrumentation
disable_auto_instrument bool True Library auto-instrumentation is opt-in (see below)
debug bool False Enable verbose DEBUG-level 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 (google.genai 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.

Debug Logging

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

Async Usage

import asyncio
from raindrop_vertex_ai import RaindropVertexAI
from google import genai

raindrop = RaindropVertexAI(api_key="rk_...")
client = genai.Client(api_key="...")
wrapped = raindrop.wrap(client)

async def main():
    response = await wrapped.aio.models.generate_content(
        model="gemini-2.0-flash", contents="Hello!"
    )
    print(response.text)

asyncio.run(main())
raindrop.shutdown()

identify()

raindrop.identify(user_id="user-123", traits={"plan": "pro", "org": "acme"})

track_signal()

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

Flushing and Shutdown

Always call shutdown() before your process exits to ensure all telemetry is shipped:

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

Projects

Route events to a specific project by passing its slug as project_id:

raindrop = RaindropVertexAI(
    api_key="rk_...",
    project_id="support-prod",
)

project_id sets the X-Raindrop-Project-Id header on every event. Omit it (or pass "default") to use your org's default Production project, which is the existing behavior. The same option is accepted by the create_raindrop_vertex_ai(...) factory. Invalid slugs are ignored with a warning and no header is sent.

Factory Function

A create_raindrop_vertex_ai() factory is also available for convenience:

from raindrop_vertex_ai import create_raindrop_vertex_ai

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

Full Documentation

See the Raindrop docs for complete API reference.

Testing

cd packages/vertex-ai-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_vertex_ai-0.0.7.tar.gz (23.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_vertex_ai-0.0.7-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file raindrop_vertex_ai-0.0.7.tar.gz.

File metadata

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

File hashes

Hashes for raindrop_vertex_ai-0.0.7.tar.gz
Algorithm Hash digest
SHA256 49bbf5d2fe31c02bbe17e524a2f14258c7f9bf62833347bf2bfd1194115b20af
MD5 e7c746881d9ad917f26fae471711be5d
BLAKE2b-256 167ffef19965ee3f152758f8384a6b71cab93e3711d1ab2a22b0ff61d50072d7

See more details on using hashes here.

File details

Details for the file raindrop_vertex_ai-0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for raindrop_vertex_ai-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9a9d074955eba47ebeb59e20540371787c22d560b9bc3ab7226324068225c549
MD5 a21d08e4f50a71ce6f216d3454c75ef2
BLAKE2b-256 b959c70632c57aff49a30140c37267868ce0ae4b48b74bf01167e6ebc383b8c8

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