Skip to main content

OpenTelemetry instrumentation for LiteLLM.

Project description

LLM Tracekit - LiteLLM

OpenTelemetry instrumentation for LiteLLM, designed to simplify LLM application development and production tracing and debugging.

Installation

pip install "llm-tracekit-litellm"

Usage

This section describes how to set up instrumentation for LiteLLM.

Setting up tracing

You can use the setup_export_to_coralogix function to setup tracing and export traces to Coralogix

from llm_tracekit.litellm import setup_export_to_coralogix

setup_export_to_coralogix(
    service_name="ai-service",
    application_name="ai-application",
    subsystem_name="ai-subsystem",
    capture_content=True,
)

Alternatively, you can set up tracing manually:

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import SimpleSpanProcessor

tracer_provider = TracerProvider(
    resource=Resource.create({SERVICE_NAME: "ai-service"}),
)
exporter = OTLPSpanExporter()
span_processor = SimpleSpanProcessor(exporter)
tracer_provider.add_span_processor(span_processor)
trace.set_tracer_provider(tracer_provider)

Activation

To instrument all clients, call the instrument method

from llm_tracekit.litellm import LiteLLMInstrumentor

LiteLLMInstrumentor().instrument()

Enabling message content

Message content such as the contents of the prompt, completion, function arguments and return values are not captured by default. To capture message content as span attributes, do one of the following:

  • Pass capture_content=True when calling setup_export_to_coralogix
  • Set the environment variable OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT to true

Most Coralogix AI evaluations will not work without message contents, so it is highly recommended to enable capturing.

Uninstrument

To uninstrument clients, call the uninstrument method:

LiteLLMInstrumentor().uninstrument()

Full Example

import litellm
from llm_tracekit.litellm import LiteLLMInstrumentor, setup_export_to_coralogix

# Optional: Configure sending spans to Coralogix
# Reads Coralogix connection details from the following environment variables:
# - CX_TOKEN
# - CX_ENDPOINT
setup_export_to_coralogix(
    service_name="ai-service",
    application_name="ai-application",
    subsystem_name="ai-subsystem",
    capture_content=True,
)

# Activate instrumentation
LiteLLMInstrumentor().instrument()

# Example LiteLLM Usage
response = litellm.completion(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Write a short poem on open telemetry."}],
    user="user@company.com",
)

Semantic Conventions

Attribute Type Description Examples
gen_ai.prompt.<message_number>.role string Role of message author for user message <message_number> system, user, assistant, tool
gen_ai.prompt.<message_number>.content string Contents of user message <message_number> What's the weather in Paris?
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.id string ID of tool call in user message <message_number> call_O8NOz8VlxosSASEsOY7LDUcP
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.type string Type of tool call in user message <message_number> function
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.name string The name of the function used in tool call within user message <message_number> get_current_weather
gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.arguments string Arguments passed to the function used in tool call within user message <message_number> {"location": "Seattle, WA"}
gen_ai.prompt.<message_number>.tool_call_id string Tool call ID in user message <message_number> call_mszuSIzqtI65i1wAUOE8w5H4
gen_ai.completion.<choice_number>.role string Role of message author for choice <choice_number> in model response assistant
gen_ai.completion.<choice_number>.finish_reason string Finish reason for choice <choice_number> in model response stop, tool_calls, error
gen_ai.completion.<choice_number>.content string Contents of choice <choice_number> in model response The weather in Paris is rainy and overcast, with temperatures around 57°F
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.id string ID of tool call in choice <choice_number> call_O8NOz8VlxosSASEsOY7LDUcP
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.type string Type of tool call in choice <choice_number> function
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.name string The name of the function used in tool call within choice <choice_number> get_current_weather
gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.arguments string Arguments passed to the function used in tool call within choice <choice_number> {"location": "Seattle, WA"}
gen_ai.request.tools.<tool_number>.type string Type of tool definition advertised to the model function
gen_ai.request.tools.<tool_number>.function.name string Name of the tool/function exposed to the model get_current_weather
gen_ai.request.tools.<tool_number>.function.description string Description of the tool/function Get the current weather in a given location
gen_ai.request.tools.<tool_number>.function.parameters string JSON schema describing the tool/function parameters passed with the request {"type": "object", "properties": {"city": {"type": "string"}}}
gen_ai.request.user string A unique identifier representing the end-user (from the user parameter) user@company.com

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

llm_tracekit_litellm-1.3.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

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

llm_tracekit_litellm-1.3.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file llm_tracekit_litellm-1.3.0.tar.gz.

File metadata

  • Download URL: llm_tracekit_litellm-1.3.0.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.5 {"installer":{"name":"uv","version":"0.11.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for llm_tracekit_litellm-1.3.0.tar.gz
Algorithm Hash digest
SHA256 20279ecb4c5d2bb531d69e249a8f19ef65c1b1440e3fe0c112f9c10d59128ae4
MD5 28d19ef93e476f2dec2fe01e464dbcb7
BLAKE2b-256 0050998d78b4af2c81f75bdae9c295ce41f87ab475864c4abb3b60a0a4534542

See more details on using hashes here.

File details

Details for the file llm_tracekit_litellm-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: llm_tracekit_litellm-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.5 {"installer":{"name":"uv","version":"0.11.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for llm_tracekit_litellm-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1d9feb95b53c8ae8180d91d48dbf9fb66921733ca6ebe82f603c3a9eaf3bab17
MD5 d1e2950866c284ed1a9a28d9e2b15568
BLAKE2b-256 3547a03b05a0acb5d080a32a2b13a7032a1d67d47921f143c8502e3406c53fd1

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