Skip to main content

LiteLLM callback handler for Sigil Python SDK

Project description

Sigil Python Framework Module: LiteLLM

sigil-sdk-litellm is a LiteLLM callback handler that exports generation telemetry to Sigil.

Installation

pip install sigil-sdk sigil-sdk-litellm
pip install litellm

Quickstart

import litellm
from sigil_sdk import Client
from sigil_sdk_litellm import SigilLiteLLMLogger

client = Client()
handler = SigilLiteLLMLogger(client=client)

litellm.callbacks = [handler]

response = litellm.completion(
    model="openai/gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello!"}],
)
print(response.choices[0].message.content)

client.shutdown()

Streaming

import litellm
from sigil_sdk import Client
from sigil_sdk_litellm import SigilLiteLLMLogger

client = Client()
litellm.callbacks = [SigilLiteLLMLogger(client=client)]

response = litellm.completion(
    model="openai/gpt-4o-mini",
    messages=[{"role": "user", "content": "Give me three reliability tips."}],
    stream=True,
)
for chunk in response:
    content = chunk.choices[0].delta.content
    if content:
        print(content, end="", flush=True)
print()

client.shutdown()

Configuration

All options are keyword-only on SigilLiteLLMLogger:

Parameter Type Default Description
client sigil_sdk.Client required Sigil SDK client instance
capture_inputs bool True Record input messages
capture_outputs bool True Record output messages
agent_name str "" Default agent name (see below for per-request)
agent_version str "" Default agent version (see below for per-request)
conversation_id str "" Default conversation ID (see below for per-request)
extra_tags dict[str, str] None Additional tags merged into every generation
extra_metadata dict[str, Any] None Additional metadata merged into every generation

The create_sigil_litellm_logger factory accepts the same parameters.

Per-Request Metadata

The handler resolves agent_name, agent_version, and conversation_id from per-request LiteLLM metadata, falling back to the static values from handler init. This is useful when multiple agents share a single LiteLLM proxy.

response = litellm.completion(
    model="openai/gpt-4o-mini",
    messages=[{"role": "user", "content": "Continue our chat."}],
    metadata={
        "agent_name": "search-agent",
        "agent_version": "v2",
        "conversation_id": "conv-abc-123",
    },
)

For conversation_id, the handler also checks session_id and thread_id metadata keys as fallbacks.

LiteLLM Proxy (Docker)

When running LiteLLM as a proxy server in Docker, register the handler via a callback file next to your config.

1. Extend the Docker image:

FROM ghcr.io/berriai/litellm:v1.82.3-stable.patch.2
RUN pip install sigil-sdk sigil-sdk-litellm

2. Create a callback file (sigil_callback.py, same directory as config.yaml):

import os

from sigil_sdk import Client
from sigil_sdk.config import AuthConfig, ClientConfig, GenerationExportConfig
from sigil_sdk_litellm import SigilLiteLLMLogger

client = Client(ClientConfig(
    generation_export=GenerationExportConfig(
        protocol="http",
        endpoint=os.environ["SIGIL_ENDPOINT"],
        auth=AuthConfig(
            mode="basic",
            tenant_id=os.environ.get("SIGIL_TENANT_ID", ""),
            basic_password=os.environ.get("SIGIL_API_KEY", ""),
        ),
    ),
))
sigil_handler = SigilLiteLLMLogger(
    client=client,
    agent_name="litellm-proxy",
)

3. Reference it in config.yaml:

model_list:
  - model_name: gpt-4o-mini
    litellm_params:
      model: openai/gpt-4o-mini

litellm_settings:
  callbacks: sigil_callback.sigil_handler

The proxy resolves sigil_callback.sigil_handler by importing sigil_callback.py from the config directory and using the sigil_handler instance.

4. Mount both files and run:

docker run -d \
  -v $(pwd)/config.yaml:/app/config.yaml \
  -v $(pwd)/sigil_callback.py:/app/sigil_callback.py \
  -e SIGIL_ENDPOINT=https://your-sigil-endpoint \
  -e SIGIL_TENANT_ID=your-tenant \
  -e SIGIL_API_KEY=your-key \
  -p 4000:4000 \
  your-litellm-image \
  --config /app/config.yaml

The callback file reads connection details from environment variables. Adjust the AuthConfig mode to match your deployment (see sigil_sdk.config for tenant, bearer, and basic modes).

Behavior

  • Mode mapping: non-stream calls -> SYNC, stream calls -> STREAM with first-token timestamp.
  • Provider detection: uses custom_llm_provider from LiteLLM's standard logging object.
  • Failed calls are recorded with the error attached via set_call_error.
  • Only chat completion call types (completion, acompletion) are recorded; embeddings and other call types are skipped.
  • Framework tags are always set:
    • sigil.framework.name=litellm
    • sigil.framework.source=handler
    • sigil.framework.language=python
  • LiteLLM request_tags are forwarded as litellm.tag.<value>.
  • Token usage includes detailed breakdowns (cached tokens, reasoning tokens) when the provider returns them.
  • Tool calls and tool results in messages are mapped to Sigil's tool call/result parts.

Call client.shutdown() during teardown to flush buffered telemetry.

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

sigil_sdk_litellm-0.1.3.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

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

sigil_sdk_litellm-0.1.3-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file sigil_sdk_litellm-0.1.3.tar.gz.

File metadata

  • Download URL: sigil_sdk_litellm-0.1.3.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sigil_sdk_litellm-0.1.3.tar.gz
Algorithm Hash digest
SHA256 41ab614f5827de3474bf16dcc5c69f703a79a789a50dfb56e5f3dd00c2194040
MD5 39f76341a04add75d6fbb9d79d56c56b
BLAKE2b-256 a20de0193484dcb6f5aa161147528c67fdb5a755bb35424f1879fd0ecd85e7c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigil_sdk_litellm-0.1.3.tar.gz:

Publisher: python-sdks-publish.yml on grafana/sigil-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigil_sdk_litellm-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for sigil_sdk_litellm-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 703eb340625b8c4faead2d5e7b3d3f6eab5fffffd914e804cf5455d022149be9
MD5 eeeca9e88252e1127a2c5cae1dc8fd19
BLAKE2b-256 432748925b6b5c997c725fe1ba3fb5812c9bf56513ac8bdc19ae414702add824

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigil_sdk_litellm-0.1.3-py3-none-any.whl:

Publisher: python-sdks-publish.yml on grafana/sigil-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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