Skip to main content

OpenTelemetry instrumentation for Google ADK (Agent Development Kit).

Project description

LLM Tracekit - Google ADK

OpenTelemetry instrumentation for Google ADK (Agent Development Kit), designed to simplify LLM application development and production tracing and debugging.

Installation

pip install "llm-tracekit-google-adk"

Usage

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

Setting up tracing

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

from llm_tracekit.google_adk 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.google_adk import GoogleADKInstrumentor

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

GoogleADKInstrumentor().uninstrument()

Full Example

import asyncio
from google.adk import Agent, Runner
from google.adk.sessions import InMemorySessionService
from google.genai import types
from llm_tracekit.google_adk import GoogleADKInstrumentor, 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
GoogleADKInstrumentor().instrument()


async def main():
    agent = Agent(
        name="MyAgent",
        model="gemini-2.0-flash",
        instruction="You are a helpful assistant.",
    )

    session_service = InMemorySessionService()
    runner = Runner(agent=agent, app_name="my_app", session_service=session_service)

    session = await session_service.create_session(app_name="my_app", user_id="user_1")

    async for event in runner.run_async(
        user_id="user_1",
        session_id=session.id,
        new_message=types.Content(role="user", parts=[types.Part(text="Hello!")]),
    ):
        # print any streamed text chunks
        if event.content and event.content.parts:
            for part in event.content.parts:
                if part.text:
                    print(part.text, end="")


if __name__ == "__main__":
    asyncio.run(main())

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 entry in tools list function
gen_ai.request.tools.<tool_number>.function.name string The name of the function to use in tool calls get_current_weather
gen_ai.request.tools.<tool_number>.function.description string Description of the function Get the current weather in a given location
gen_ai.request.user string A unique identifier representing the end-user (from the user_id passed to session_service.create_session(...)) 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_google_adk-1.3.0.tar.gz (10.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_google_adk-1.3.0-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: llm_tracekit_google_adk-1.3.0.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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_google_adk-1.3.0.tar.gz
Algorithm Hash digest
SHA256 7561469a2b633d684e76ae399b78d1213642c77871c93c2d08bff6be38612b85
MD5 acbaa8386ffdc3dbad5b1db62899eef2
BLAKE2b-256 021b3b3951ca07038231567075577e32e93db4aca43d469f8024344ac733d47c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: llm_tracekit_google_adk-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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_google_adk-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1073b7017fec133adf8156cfbc36b2ef6887fdd785d672a01060b8e43511cab
MD5 a16d29259aaad411ad421d7e71386a3a
BLAKE2b-256 3eaaa2e22830fd4e1037ea298368c823febcbf681479c75b9217a5ff8710f0fb

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