Skip to main content

OpenTelemetry instrumentation for Google Gemini.

Project description

LLM Tracekit - Gemini

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

Installation

pip install "llm-tracekit-gemini"

Usage

This section describes how to set up instrumentation for Google Gemini.

Setting up tracing

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

from llm_tracekit.gemini 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.gemini import GeminiInstrumentor

GeminiInstrumentor().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:

GeminiInstrumentor().uninstrument()

Full Example

from google import genai
from llm_tracekit.gemini import GeminiInstrumentor, 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
GeminiInstrumentor().instrument()

# Example Gemini Usage
client = genai.Client()
response = client.models.generate_content(
    model="gemini-2.0-flash",
    contents=[{"role": "user", "parts": [{"text": "Write a short poem on open telemetry."}]}],
)

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"}}}

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_gemini-1.2.0.tar.gz (15.2 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_gemini-1.2.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file llm_tracekit_gemini-1.2.0.tar.gz.

File metadata

  • Download URL: llm_tracekit_gemini-1.2.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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_gemini-1.2.0.tar.gz
Algorithm Hash digest
SHA256 863fc86c52a9aedfd47ee17e6ace0f719686bd8d7af18412044c7afe6841f6a7
MD5 20030abd8fb23d464e9ffe5a6b2112f6
BLAKE2b-256 4428b159dead3ea462c0a3bee58f213b473e8ad16d8745f71f24bd3b2f1a7c5f

See more details on using hashes here.

File details

Details for the file llm_tracekit_gemini-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: llm_tracekit_gemini-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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_gemini-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 686aecfafb6c12513986bd5fc1717d7c63639922a1fdcb37a2ae8caf43896719
MD5 dc44dce0844b6c4f75719be1efcfd5ea
BLAKE2b-256 03fcf67d3f851d68ba4e4c724161f5367c5101e497057d9047d55ac16b7dff42

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