Files
wehub-resource-sync 5a558eb09e
Backend Tests / discover-tests (push) Waiting to run
Backend Tests / ${{ matrix.name }} (push) Blocked by required conditions
Build and Publish SDK / build-and-publish (push) Waiting to run
Build Opik Docker Images / set-version (push) Waiting to run
Build Opik Docker Images / build-backend (push) Blocked by required conditions
Build Opik Docker Images / build-sandbox-executor-python (push) Blocked by required conditions
Build Opik Docker Images / build-python-backend (push) Blocked by required conditions
Build Opik Docker Images / build-frontend (push) Blocked by required conditions
Build Opik Docker Images / create-git-tag (push) Blocked by required conditions
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Waiting to run
Docs - Publish / run (push) Waiting to run
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Waiting to run
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Blocked by required conditions
Frontend Unit Tests / Test on Node 20 (push) Waiting to run
Guardrails E2E Tests / Select Python version matrix (push) Waiting to run
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Blocked by required conditions
Guardrails E2E Tests / 📢 Slack Notification (push) Blocked by required conditions
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Waiting to run
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Blocked by required conditions
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Waiting to run
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Waiting to run
Lint Opik Helm Chart / unittest-helm-chart (push) Waiting to run
Lint Opik Helm Chart / render-equality (push) Waiting to run
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Waiting to run
Python BE E2E Tests / Python BE E2E (push) Waiting to run
Python Backend Tests / run-python-backend-tests (push) Waiting to run
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Waiting to run
Release Drafter / update_release_draft (push) Waiting to run
SDK E2E Libraries Integration Tests / Check Secrets (push) Waiting to run
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Blocked by required conditions
SDK E2E Libraries Integration Tests / build-opik (push) Blocked by required conditions
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Blocked by required conditions
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Waiting to run
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Waiting to run
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Waiting to run
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Waiting to run
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Waiting to run
TypeScript SDK Build & Publish / build-and-publish (push) Waiting to run
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Waiting to run
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:25:44 +08:00

1851 lines
65 KiB
Python

import pickle
from typing import Dict
import google.adk
import pydantic
import pytest
from google.adk import agents as adk_agents
from google.adk.agents import run_config
from google.adk.models import lite_llm as adk_lite_llm
from google.adk.tools import agent_tool as adk_agent_tool
from google.genai import types as genai_types
import opik
from opik import semantic_version
from opik.integrations.adk import OpikTracer, track_adk_agent_recursive
from opik.integrations.adk import helpers as opik_adk_helpers
from opik.integrations.adk import opik_tracer, legacy_opik_tracer
from . import agent_tools
from . import constants, helpers
from .agent_instructions import TOOL_USE_WEATHER, TOOL_USE_WEATHER_OR_TIME
from .constants import (
APP_NAME,
USER_ID,
SESSION_ID,
MODEL_NAME,
EXPECTED_USAGE_GOOGLE,
EXPECTED_USAGE_ADK_LITELLM_OPENAI,
EXPECTED_USAGE_ADK_LITELLM_OPENAI_STREAMING,
)
from ...testlib import (
ANY_BUT_NONE,
ANY_DICT,
ANY_STRING,
SpanModel,
TraceModel,
assert_equal,
)
# Maximum reasonable time-to-first-token in seconds for test assertions
MAX_REASONABLE_TTFT_SECONDS = 60
@pytest.mark.skipif(
semantic_version.SemanticVersion.parse(google.adk.__version__) >= "1.3.0",
reason="Test only applies to ADK versions < 1.3.0",
)
def test_adk__public_name_OpikTracer_is_legacy_implementation_for_old_adk_versions():
"""Test that OpikTracer maps to LegacyOpikTracer for ADK versions < 1.3.0"""
assert OpikTracer is legacy_opik_tracer.LegacyOpikTracer
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__public_name_OpikTracer_is_new_implementation_for_new_adk_versions():
"""Test that OpikTracer maps to OpikTracer for ADK versions >= 1.3.0"""
assert OpikTracer is opik_tracer.OpikTracer
def test_adk__single_agent__single_tool__happyflow(fake_backend):
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="weather_agent",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk-metadata-key": "adk-metadata-value",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
tags=["adk-test"],
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
},
thread_id=SESSION_ID,
project_name="adk-test",
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
project_name="adk-test",
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="get_weather",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input={"city": "New York"},
output={
"status": "success",
"report": "The weather in New York is sunny with a temperature of 25 degrees Celsius (41 degrees Fahrenheit).",
},
project_name="adk-test",
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
project_name="adk-test",
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
def test_adk__single_agent__multiple_tools__two_invocations_lead_to_two_traces_with_the_same_thread_id(
fake_backend,
):
opik_tracer = OpikTracer()
root_agent = adk_agents.Agent(
name="weather_time_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER_OR_TIME,
tools=[
agent_tools.get_weather,
agent_tools.get_current_time,
],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user", parts=[genai_types.Part(text="What is the time in New York?")]
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
EXPECTED_WEATHER_QUESTION_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="weather_time_agent",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="get_weather",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input={"city": "New York"},
output={
"status": "success",
"report": "The weather in New York is sunny with a temperature of 25 degrees Celsius (41 degrees Fahrenheit).",
},
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
],
source="sdk",
)
EXPECTED_TIME_QUESTION_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="weather_time_agent",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": "What is the time in New York?"}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="get_current_time",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input={"city": "New York"},
output={
"status": "success",
"report": ANY_STRING.starting_with(
"The current time in New York is"
),
},
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
],
source="sdk",
)
assert len(fake_backend.trace_trees) == 2
weather_trace_tree = fake_backend.trace_trees[0]
time_trace_tree = fake_backend.trace_trees[1]
assert_equal(EXPECTED_WEATHER_QUESTION_TRACE_TREE, weather_trace_tree)
assert_equal(EXPECTED_TIME_QUESTION_TRACE_TREE, time_trace_tree)
def test_adk__sequential_agent_with_subagents__every_subagent_has_its_own_span(
fake_backend,
):
opik_tracer = OpikTracer()
root_agent = helpers.root_agent_sequential_with_translator_and_summarizer(
opik_tracer
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user", parts=[genai_types.Part(text=constants.INPUT_GERMAN_TEXT)]
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="TextProcessingAssistant",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": constants.INPUT_GERMAN_TEXT}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name="Translator",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="general",
input=ANY_DICT,
output=ANY_DICT,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
)
],
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="Summarizer",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="general",
input=ANY_DICT,
output=ANY_DICT,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
)
],
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
def test_adk__tool_calls_tracked_function__tracked_function_span_attached_to_the_tool_span(
fake_backend,
):
opik_tracer = OpikTracer(
tags=["adk-test"], metadata={"adk-metadata-key": "adk-metadata-value"}
)
@opik.track(type="tool")
def is_city_supported(city: str) -> bool:
return city.lower() == "new york"
def get_weather(city: str) -> Dict[str, str]:
if not is_city_supported(city):
return {
"status": "error",
"error_message": f"Weather information for '{city}' is not available.",
}
return {
"status": "success",
"report": f"The weather in {city} is sunny with a temperature of 25 degrees Celsius (41 degrees Fahrenheit).",
}
root_agent = adk_agents.Agent(
name="weather_time_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="weather_time_agent",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk-metadata-key": "adk-metadata-value",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
tags=["adk-test"],
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="get_weather",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input={"city": "New York"},
output={
"status": "success",
"report": "The weather in New York is sunny with a temperature of 25 degrees Celsius (41 degrees Fahrenheit).",
},
spans=[
SpanModel(
id=ANY_BUT_NONE,
name="is_city_supported",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
type="tool",
input={"city": "New York"},
output={"output": True},
source="sdk",
)
],
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
def test_adk__litellm_used_for_openai_model__usage_logged_in_openai_format(
fake_backend,
):
model_name = "openai/gpt-5-nano"
opik_tracer = OpikTracer(
tags=["adk-test"], metadata={"adk-metadata-key": "adk-metadata-value"}
)
root_agent = adk_agents.Agent(
name="weather_time_agent",
model=adk_lite_llm.LiteLlm(model_name, reasoning_effort="minimal"),
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Verify trace-level properties (spans checked separately since the LLM
# may non-deterministically call the tool more than once)
assert trace_tree.name == "weather_time_agent"
assert trace_tree.tags == ["adk-test"]
assert trace_tree.input == {
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
}
assert trace_tree.thread_id == SESSION_ID
# Verify spans structurally: at least 1 LLM + 1 tool + 1 LLM
llm_spans = [s for s in trace_tree.spans if s.type == "llm"]
tool_spans = [s for s in trace_tree.spans if s.type == "tool"]
assert len(llm_spans) >= 2, f"Expected at least 2 LLM spans, got {len(llm_spans)}"
assert len(tool_spans) >= 1, f"Expected at least 1 tool span, got {len(tool_spans)}"
for llm_span in llm_spans:
assert llm_span.provider == "openai"
assert llm_span.usage is not None
for tool_span in tool_spans:
assert tool_span.name == "get_weather"
assert tool_span.input == {"city": "New York"}
for llm_span in llm_spans:
assert llm_span.usage == EXPECTED_USAGE_ADK_LITELLM_OPENAI
def test_adk__litellm_used_for_openai_model__streaming_mode_is_SSE__usage_logged_in_openai_format(
fake_backend,
):
model_name = "openai/gpt-5-nano"
opik_tracer = OpikTracer(
tags=["adk-test"], metadata={"adk-metadata-key": "adk-metadata-value"}
)
root_agent = adk_agents.Agent(
name="weather_time_agent",
model=adk_lite_llm.LiteLlm(model_name, reasoning_effort="minimal"),
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
run_config=run_config.RunConfig(streaming_mode=run_config.StreamingMode.SSE),
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Verify trace-level properties (spans checked separately since the LLM
# may non-deterministically call the tool more than once)
assert trace_tree.name == "weather_time_agent"
assert trace_tree.tags == ["adk-test"]
assert trace_tree.input == {
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
}
assert trace_tree.thread_id == SESSION_ID
# Verify spans structurally: at least 1 LLM + 1 tool + 1 LLM
llm_spans = [s for s in trace_tree.spans if s.type == "llm"]
tool_spans = [s for s in trace_tree.spans if s.type == "tool"]
assert len(llm_spans) >= 2, f"Expected at least 2 LLM spans, got {len(llm_spans)}"
assert len(tool_spans) >= 1, f"Expected at least 1 tool span, got {len(tool_spans)}"
for llm_span in llm_spans:
assert llm_span.provider == "openai"
assert llm_span.usage is not None
for tool_span in tool_spans:
assert tool_span.name == "get_weather"
assert tool_span.input == {"city": "New York"}
for llm_span in llm_spans:
assert llm_span.usage == EXPECTED_USAGE_ADK_LITELLM_OPENAI_STREAMING
def test_adk__track_adk_agent_recursive__sequential_agent_with_subagent__every_subagent_is_tracked(
fake_backend,
):
opik_tracer = OpikTracer()
translator_to_english = adk_agents.Agent(
name="Translator",
model=MODEL_NAME,
description="Translates text to English.",
instruction="Translate to English.",
)
summarizer = adk_agents.Agent(
name="Summarizer",
model=MODEL_NAME,
description="Summarizes text to 1 sentence.",
instruction="Summarize to one sentence.",
)
root_agent = adk_agents.SequentialAgent(
name="TextProcessingAssistant",
sub_agents=[translator_to_english, summarizer],
description="Runs translator to english then summarizer, in order.",
)
track_adk_agent_recursive(root_agent, opik_tracer)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user", parts=[genai_types.Part(text=constants.INPUT_GERMAN_TEXT)]
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="TextProcessingAssistant",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": constants.INPUT_GERMAN_TEXT}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name="Translator",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="general",
input=ANY_DICT,
output=ANY_DICT,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
)
],
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="Summarizer",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="general",
input=ANY_DICT,
output=ANY_DICT,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
)
],
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__track_adk_agent_recursive__agent_tool_is_used__agent_tool_is_tracked(
fake_backend,
):
opik_tracer = OpikTracer()
translator_to_english = adk_agents.Agent(
name="Translator",
model=MODEL_NAME,
description="Translates text to English.",
instruction="Translate to English.",
)
root_agent = adk_agents.Agent(
name="TextProcessingAssistant",
model=MODEL_NAME,
tools=[adk_agent_tool.AgentTool(agent=translator_to_english)],
description="Agent responsible for translating text to english by invoking a special tool for that.",
instruction=(
"You MUST call the Translator tool with the user's text. "
"Then return the tool's result verbatim. "
"Never answer directly without calling the tool."
),
)
track_adk_agent_recursive(root_agent, opik_tracer)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user", parts=[genai_types.Part(text=constants.INPUT_GERMAN_TEXT)]
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="TextProcessingAssistant",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": constants.INPUT_GERMAN_TEXT}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
SpanModel( # from tool callback
id=ANY_BUT_NONE,
name="Translator",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input=ANY_DICT,
output=ANY_DICT,
spans=[
SpanModel( # from agent callback
id=ANY_BUT_NONE,
name="Translator",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="general",
input=ANY_DICT,
output=ANY_DICT,
spans=[
SpanModel( # from model callback inside the agent tool
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
)
],
source="sdk",
)
],
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
def test_adk__track_adk_agent_recursive__idempotent_calls_make_no_duplicated_callbacks():
opik_tracer = OpikTracer()
translator_to_english = adk_agents.Agent(
name="Translator",
model=MODEL_NAME,
description="Translates text to English.",
instruction="Translate the input text to English.",
)
root_agent = adk_agents.Agent(
name="TextProcessingAssistant",
model=MODEL_NAME,
tools=[adk_agent_tool.AgentTool(agent=translator_to_english)],
description="Agent responsible for translating text to english by invoking a special tool for that.",
instruction=(
"You MUST call the Translator tool with the user's text. "
"Then return the tool's result verbatim. "
"Never answer directly without calling the tool."
),
)
track_adk_agent_recursive(root_agent, opik_tracer)
first_translator_after_agent_callback = translator_to_english.after_agent_callback
first_translator_before_agent_callback = translator_to_english.before_agent_callback
first_translator_after_tool_callback = translator_to_english.after_tool_callback
first_translator_before_tool_callback = translator_to_english.before_tool_callback
first_translator_after_model_callback = translator_to_english.after_model_callback
first_translator_before_model_callback = translator_to_english.before_model_callback
first_root_after_agent_callback = root_agent.after_agent_callback
first_root_before_agent_callback = root_agent.before_agent_callback
first_root_after_tool_callback = root_agent.after_tool_callback
first_root_before_tool_callback = root_agent.before_tool_callback
first_root_after_model_callback = root_agent.after_model_callback
first_root_before_model_callback = root_agent.before_model_callback
track_adk_agent_recursive(root_agent, opik_tracer)
assert (
translator_to_english.after_agent_callback
is first_translator_after_agent_callback
)
assert (
translator_to_english.before_agent_callback
is first_translator_before_agent_callback
)
assert (
translator_to_english.after_tool_callback
is first_translator_after_tool_callback
)
assert (
translator_to_english.before_tool_callback
is first_translator_before_tool_callback
)
assert (
translator_to_english.after_model_callback
is first_translator_after_model_callback
)
assert (
translator_to_english.before_model_callback
is first_translator_before_model_callback
)
assert root_agent.after_agent_callback is first_root_after_agent_callback
assert root_agent.before_agent_callback is first_root_before_agent_callback
assert root_agent.after_tool_callback is first_root_after_tool_callback
assert root_agent.before_tool_callback is first_root_before_tool_callback
assert root_agent.after_model_callback is first_root_after_model_callback
assert root_agent.before_model_callback is first_root_before_model_callback
def test_adk__opik_tracer__unpickled_object_works_as_expected(fake_backend):
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
pickled_opik_tracer = pickle.dumps(opik_tracer)
opik_tracer = pickle.loads(pickled_opik_tracer)
root_agent = adk_agents.Agent(
name="weather_time_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="weather_time_agent",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk-metadata-key": "adk-metadata-value",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
tags=["adk-test"],
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
},
thread_id=SESSION_ID,
project_name="adk-test",
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
project_name="adk-test",
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="get_weather",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input={"city": "New York"},
output={
"status": "success",
"report": "The weather in New York is sunny with a temperature of 25 degrees Celsius (41 degrees Fahrenheit).",
},
project_name="adk-test",
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
project_name="adk-test",
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
def test_adk__agent_with_response_schema__happyflow(
fake_backend,
):
opik_tracer = OpikTracer()
class SummaryResult(pydantic.BaseModel):
summary: str
summarizer = adk_agents.Agent(
name="Summarizer",
model=MODEL_NAME,
description="Summarizes text to 1 sentence.",
instruction="Summarize to one sentence.",
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
output_schema=SummaryResult,
)
runner = helpers.build_sync_runner(summarizer)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user", parts=[genai_types.Part(text=constants.INPUT_GERMAN_TEXT)]
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="Summarizer",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
output=ANY_DICT,
input={
"role": "user",
"parts": [{"text": constants.INPUT_GERMAN_TEXT}],
},
thread_id=SESSION_ID,
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
source="sdk",
)
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__llm_call_failed__error_info_is_logged_in_llm_span(fake_backend):
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_agent",
model=adk_lite_llm.LiteLlm("openai/invalid-model-name"),
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
with pytest.raises(Exception):
# `events_generator` generator will not produce a single event and finish immediately
# because first llm call fails.
# `_extract_final_response_text` will raise an exception because it is
# programmed to do so when there are no events (we still have to try to exhaust the generator though,
# because it is necessary for agent to actuallyexecute)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
# The LLM call fails before ADK's after_model_callback fires, so no child
# LLM span is produced — assert on the trace-level error_info only. If a
# future ADK version starts emitting a child LLM span again we'll catch
# that separately.
assert len(fake_backend.trace_trees) == 1
trace_tree = fake_backend.trace_trees[0]
assert trace_tree.name == "weather_agent"
assert trace_tree.project_name == "adk-test"
assert trace_tree.thread_id == SESSION_ID
assert trace_tree.tags == ["adk-test"]
assert trace_tree.error_info is not None
assert trace_tree.error_info["exception_type"]
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__tool_call_failed__error_info_is_logged_in_tool_span(fake_backend):
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
def get_weather(city: str) -> str:
1 / 0
return ""
root_agent = adk_agents.Agent(
name="weather_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
with pytest.raises(Exception):
# `events_generator` generator will not produce a single event and finish immediately
# because first llm call fails.
# `_extract_final_response_text` will raise an exception because it is
# programmed to do so when there are no events (we still have to try to exhaust the generator though,
# because it is necessary for agent to actuallyexecute)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
EXPECTED_TRACE_TREE = TraceModel(
id=ANY_BUT_NONE,
name="weather_agent",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata={
"created_from": "google-adk",
"adk-metadata-key": "adk-metadata-value",
"adk_invocation_id": ANY_STRING,
"app_name": APP_NAME,
"user_id": USER_ID,
"_opik_graph_definition": ANY_BUT_NONE,
},
tags=["adk-test"],
output=None,
input={
"role": "user",
"parts": [{"text": "What is the weather in New York?"}],
},
thread_id=SESSION_ID,
project_name="adk-test",
error_info={
"exception_type": "ZeroDivisionError",
"message": ANY_STRING,
"traceback": ANY_STRING,
},
spans=[
SpanModel(
id=ANY_BUT_NONE,
name=MODEL_NAME,
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="llm",
input=ANY_DICT,
output=ANY_DICT,
provider=opik_adk_helpers.get_adk_provider(),
model=MODEL_NAME,
usage=EXPECTED_USAGE_GOOGLE,
project_name="adk-test",
source="sdk",
),
SpanModel(
id=ANY_BUT_NONE,
name="get_weather",
start_time=ANY_BUT_NONE,
end_time=ANY_BUT_NONE,
last_updated_at=ANY_BUT_NONE,
metadata=ANY_DICT,
type="tool",
input={"city": "New York"},
output=None,
error_info={
"exception_type": "ZeroDivisionError",
"message": ANY_STRING,
"traceback": ANY_STRING,
},
project_name="adk-test",
source="sdk",
),
],
source="sdk",
)
assert_equal(EXPECTED_TRACE_TREE, trace_tree)
@pytest.fixture
def disable_tracing():
opik.set_tracing_active(False)
yield
opik.set_tracing_active(True)
def test_adk__tracing_disabled__no_spans_created(fake_backend, disable_tracing):
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) == 0
assert len(fake_backend.span_trees) == 0
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__llm_call__time_to_first_token_tracked_in_metadata(fake_backend):
"""Test that time-to-first-token is tracked and stored in LLM span metadata."""
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Check that LLM spans have time_to_first_token in metadata
llm_spans = [span for span in trace_tree.spans if span.type == "llm"]
assert len(llm_spans) > 0, "Expected at least one LLM span"
for llm_span in llm_spans:
assert llm_span.metadata is not None, "LLM span should have metadata"
assert "time_to_first_token" in llm_span.metadata, (
f"LLM span metadata should contain 'time_to_first_token', got: {llm_span.metadata.keys()}"
)
ttft = llm_span.metadata["time_to_first_token"]
assert isinstance(ttft, (int, float)), (
f"time_to_first_token should be a number, got {type(ttft)}"
)
assert ttft >= 0, f"time_to_first_token should be non-negative, got {ttft}"
assert ttft < MAX_REASONABLE_TTFT_SECONDS, (
f"time_to_first_token should be reasonable (< {MAX_REASONABLE_TTFT_SECONDS}s), got {ttft}"
)
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__llm_call__time_to_first_token_tracked_for_streaming_responses(
fake_backend,
):
"""Test that time-to-first-token is tracked correctly for streaming responses."""
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
run_config=run_config.RunConfig(streaming_mode=run_config.StreamingMode.SSE),
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Check that LLM spans have time_to_first_token in metadata for streaming responses
llm_spans = [span for span in trace_tree.spans if span.type == "llm"]
assert len(llm_spans) > 0, "Expected at least one LLM span"
for llm_span in llm_spans:
assert llm_span.metadata is not None, "LLM span should have metadata"
assert "time_to_first_token" in llm_span.metadata, (
f"LLM span metadata should contain 'time_to_first_token' for streaming responses, got: {llm_span.metadata.keys()}"
)
ttft = llm_span.metadata["time_to_first_token"]
assert isinstance(ttft, (int, float)), (
f"time_to_first_token should be a number, got {type(ttft)}"
)
assert ttft >= 0, f"time_to_first_token should be non-negative, got {ttft}"
assert ttft < MAX_REASONABLE_TTFT_SECONDS, (
f"time_to_first_token should be reasonable (< {MAX_REASONABLE_TTFT_SECONDS}s), got {ttft}"
)
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__llm_call__time_to_first_token_tracked_for_multiple_llm_calls(
fake_backend,
):
"""Test that time-to-first-token is tracked separately for each LLM call."""
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_time_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER_OR_TIME,
tools=[agent_tools.get_weather, agent_tools.get_current_time],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="What is the weather in New York?")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Check that all LLM spans have time_to_first_token in metadata
llm_spans = [span for span in trace_tree.spans if span.type == "llm"]
assert len(llm_spans) >= 2, (
"Expected at least two LLM spans (one before tool, one after)"
)
for llm_span in llm_spans:
assert llm_span.metadata is not None, "LLM span should have metadata"
assert "time_to_first_token" in llm_span.metadata, (
f"All LLM spans should have 'time_to_first_token', got: {llm_span.metadata.keys()}"
)
ttft = llm_span.metadata["time_to_first_token"]
assert isinstance(ttft, (int, float)), (
f"time_to_first_token should be a number, got {type(ttft)}"
)
assert ttft >= 0, f"time_to_first_token should be non-negative, got {ttft}"
assert ttft < MAX_REASONABLE_TTFT_SECONDS, (
f"time_to_first_token should be reasonable (< {MAX_REASONABLE_TTFT_SECONDS}s), got {ttft}"
)
# Verify that different LLM calls have distinct TTFT values when possible
# They might be similar in magnitude but should be tracked independently per call
ttft_values = [span.metadata["time_to_first_token"] for span in llm_spans]
assert len(set(ttft_values)) >= 2, (
"Expected at least two distinct TTFT values for multiple LLM calls"
)
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__llm_call__time_to_first_token_not_present_when_no_content(fake_backend):
"""Test that time-to-first-token is not tracked when response has no content."""
opik_tracer = OpikTracer(
project_name="adk-test",
tags=["adk-test"],
metadata={"adk-metadata-key": "adk-metadata-value"},
)
root_agent = adk_agents.Agent(
name="weather_agent",
model=MODEL_NAME,
description=(
"Agent to answer questions about the weather in a city (only 'New York' supported)."
),
instruction=TOOL_USE_WEATHER,
tools=[agent_tools.get_weather],
before_agent_callback=opik_tracer.before_agent_callback,
after_agent_callback=opik_tracer.after_agent_callback,
before_model_callback=opik_tracer.before_model_callback,
after_model_callback=opik_tracer.after_model_callback,
before_tool_callback=opik_tracer.before_tool_callback,
after_tool_callback=opik_tracer.after_tool_callback,
)
runner = helpers.build_sync_runner(root_agent)
# Use a simple query that should generate a response
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user",
parts=[genai_types.Part(text="Hello")],
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Check that LLM spans have time_to_first_token when they have content
llm_spans = [span for span in trace_tree.spans if span.type == "llm"]
assert len(llm_spans) > 0, "Expected at least one LLM span"
for llm_span in llm_spans:
# If span has output/content, it should have TTFT
if llm_span.output is not None and llm_span.usage is not None:
assert llm_span.metadata is not None, "LLM span should have metadata"
# Note: Even if content exists, TTFT should be tracked
# The test verifies that when content exists, TTFT is present
if "time_to_first_token" in llm_span.metadata:
ttft = llm_span.metadata["time_to_first_token"]
assert isinstance(ttft, (int, float)), (
f"time_to_first_token should be a number, got {type(ttft)}"
)
assert ttft >= 0, (
f"time_to_first_token should be non-negative, got {ttft}"
)
else:
# When span has no output or no usage, TTFT should not be present
assert not (
llm_span.metadata and "time_to_first_token" in llm_span.metadata
), (
f"LLM span without content should not have 'time_to_first_token' in metadata. "
f"Span output: {llm_span.output}, usage: {llm_span.usage}, metadata: {llm_span.metadata}"
)
@helpers.pytest_skip_for_adk_older_than_1_3_0
def test_adk__llm_call__time_to_first_token_tracked_for_sequential_agents(fake_backend):
"""Test that time-to-first-token is tracked for each LLM call in sequential agents."""
opik_tracer = OpikTracer()
root_agent = helpers.root_agent_sequential_with_translator_and_summarizer(
opik_tracer
)
runner = helpers.build_sync_runner(root_agent)
events_generator = runner.run(
user_id=USER_ID,
session_id=SESSION_ID,
new_message=genai_types.Content(
role="user", parts=[genai_types.Part(text=constants.INPUT_GERMAN_TEXT)]
),
)
_ = helpers.extract_final_response_text(events_generator)
opik.flush_tracker()
assert len(fake_backend.trace_trees) > 0
trace_tree = fake_backend.trace_trees[0]
# Check that all LLM spans in nested agents have time_to_first_token
def collect_llm_spans(span):
"""Recursively collect all LLM spans."""
llm_spans = []
if span.type == "llm":
llm_spans.append(span)
if hasattr(span, "spans") and span.spans:
for child_span in span.spans:
llm_spans.extend(collect_llm_spans(child_span))
return llm_spans
all_llm_spans = []
for span in trace_tree.spans:
all_llm_spans.extend(collect_llm_spans(span))
assert len(all_llm_spans) >= 2, (
"Expected at least two LLM spans (one per sub-agent)"
)
for llm_span in all_llm_spans:
assert llm_span.metadata is not None, "LLM span should have metadata"
assert "time_to_first_token" in llm_span.metadata, (
f"All LLM spans in sequential agents should have 'time_to_first_token', got: {llm_span.metadata.keys()}"
)
ttft = llm_span.metadata["time_to_first_token"]
assert isinstance(ttft, (int, float)), (
f"time_to_first_token should be a number, got {type(ttft)}"
)
assert ttft >= 0, f"time_to_first_token should be non-negative, got {ttft}"
assert ttft < MAX_REASONABLE_TTFT_SECONDS, (
f"time_to_first_token should be reasonable (< {MAX_REASONABLE_TTFT_SECONDS}s), got {ttft}"
)