Checkout ADK sample from adk-sample-9-29

aabmass · aabmass · commit 06f81137b1ce · 2025-10-06T18:45:20.000Z
Get adk sample working

working with adk web
diff --git a/adk-sql-agent/.dockerignore b/adk-sql-agent/.dockerignore
@@ -0,0 +1 @@
+Dockerfile
diff --git a/adk-sql-agent/.gitignore b/adk-sql-agent/.gitignore
@@ -0,0 +1 @@
+*.db
diff --git a/adk-sql-agent/.python-version b/adk-sql-agent/.python-version
@@ -0,0 +1 @@
+3.13
diff --git a/adk-sql-agent/Dockerfile b/adk-sql-agent/Dockerfile
@@ -0,0 +1,21 @@
+# NOTE: this must be run from the repo root as build context
+
+# Adapted from https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layers
+# Install uv
+FROM python:3.13-slim
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+RUN apt-get update && apt-get install -y git
+
+# Change the working directory to the `app` directory
+WORKDIR /app
+
+# Copy the project into the image
+COPY . ./
+
+WORKDIR /app/adk-sql-agent
+
+# Sync the project
+RUN --mount=type=cache,target=/root/.cache/uv uv sync --locked
+
+ENTRYPOINT [ "uv", "run", "--locked", "--env-file=main.env", "main.py" ]
diff --git a/adk-sql-agent/README.md b/adk-sql-agent/README.md
@@ -0,0 +1,58 @@
+# OpenTelemetry ADK instrumentation example
+
+<!-- TODO: link to devsite doc once it is published -->
+
+This demo shows does remote uploading and with `.ref` attributes in the telemetry, following OTel semconv 1.37 for GenAI: https://github.com/open-telemetry/semantic-conventions/blob/v1.37.0/docs/gen-ai/gen-ai-events.md
+
+## Configure upload
+This demo uses the [fsspec](https://filesystem-spec.readthedocs.io/) library to do the upload
+in a vendor agnostic way, which is configured in an environment variable
+`OTEL_PYTHON_GENAI_UPLOADER_PATH`. For example, to upload to GCS bucket `my-bucket` with
+subdirectory `v1/`:
+
+```console
+export OTEL_PYTHON_GENAI_UPLOADER_PATH="gs://my-bucket/v1"
+```
+
+This will work with any installed fsspec implementations and also allows using any fsspec
+configuration like URL Chaining:
+- [Built in implementations](https://filesystem-spec.readthedocs.io/en/latest/api.html#built-in-implementations)
+- [Known third party impls](https://filesystem-spec.readthedocs.io/en/latest/api.html#external-implementations)
+- [URL Chaining](https://filesystem-spec.readthedocs.io/en/latest/features.html#url-chaining)
+
+## Run the demo
+
+To run the app, set some environment variables (alternatively can be put in `main.env`):
+
+```console
+# Port if not default
+export PORT=8000
+# Project for ADC
+export GOOGLE_CLOUD_PROJECT=my-project
+
+# Configure the upload path
+export OTEL_PYTHON_GENAI_UPLOADER_PATH="gs://${GOOGLE_CLOUD_PROJECT}/v1"
+
+uv run --env-file main.env main.py
+```
+
+## Dockerfile
+
+Build
+
+```console
+# from this directory, run with repo root build context
+docker build -f ./Dockerfile -t adk-sql-agent-write-aside ..
+```
+
+Run:
+```console
+docker run --rm \
+    -p 8000:8000 \
+    -e PORT=8000 \
+    -e GOOGLE_APPLICATION_CREDENTIALS \
+    -e GOOGLE_CLOUD_PROJECT \
+    -e OTEL_PYTHON_GENAI_UPLOADER_PATH="gs://otel-starter-project-genai-refs/v1" \
+    -v "$GOOGLE_APPLICATION_CREDENTIALS:$GOOGLE_APPLICATION_CREDENTIALS" \
+    adk-sql-agent-write-aside:latest
+```
diff --git a/adk-sql-agent/image_describer_agent/.env b/adk-sql-agent/image_describer_agent/.env
@@ -0,0 +1,3 @@
+GOOGLE_GENAI_USE_VERTEXAI=1
+GOOGLE_CLOUD_PROJECT=otel-starter-project
+GOOGLE_CLOUD_LOCATION=us-central1
diff --git a/adk-sql-agent/image_describer_agent/__init__.py b/adk-sql-agent/image_describer_agent/__init__.py
@@ -0,0 +1 @@
+from . import agent
diff --git a/adk-sql-agent/image_describer_agent/agent.py b/adk-sql-agent/image_describer_agent/agent.py
@@ -0,0 +1,18 @@
+from textwrap import dedent
+
+from google.adk.agents.llm_agent import Agent
+
+root_agent = Agent(
+    model="gemini-2.5-flash",
+    name="root_agent",
+    description="An agent that can describe images",
+    instruction=dedent("""\
+    You are an agent that can describe images. You don't have any tools at your disposal.
+    Some guidelines for you:
+
+    - Don't answer any questions that are opinion based or involve emotions.
+    - Keep it brief and succinct
+    - But also be descriptive
+    - Answer in a professional tone
+    """),
+)
diff --git a/adk-sql-agent/main.env b/adk-sql-agent/main.env
@@ -0,0 +1,9 @@
+GOOGLE_GENAI_USE_VERTEXAI=TRUE
+GOOGLE_CLOUD_LOCATION=us-central1
+GOOGLE_CLOUD_PROJECT=otel-starter-project
+
+OTEL_INSTRUMENTATION_GENAI_UPLOAD_FORMAT='jsonl'
+OTEL_INSTRUMENTATION_GENAI_COMPLETION_HOOK=upload
+OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH="gs://otel-starter-project-genai-refs/v3"
+OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
+OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental
diff --git a/adk-sql-agent/pyproject.toml b/adk-sql-agent/pyproject.toml
@@ -0,0 +1,46 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+[project]
+name = "adk-sql-agent"
+version = "0.1.0"
+description = "An ADK agent that can run queries on an ephemeral SQLite database"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "fsspec>=2025.5.1",
+    "gcsfs",
+    "google-adk~=1.14",
+    "opentelemetry-exporter-gcp-logging>=1.9.0a0",
+    "opentelemetry-exporter-gcp-monitoring>=1.9.0a0",
+    "opentelemetry-exporter-otlp-proto-grpc>=1.33.1",
+    "opentelemetry-instrumentation-aiohttp-client>=0.54b1",
+    "opentelemetry-instrumentation-google-genai>=0.2b0",
+    "opentelemetry-instrumentation-httpx>=0.54b1",
+    "opentelemetry-instrumentation-requests>=0.54b1",
+    "opentelemetry-instrumentation-sqlite3>=0.54b1",
+    "opentelemetry-instrumentation-vertexai>=2.0b0",
+    "opentelemetry-util-genai",
+    "rich>=14.0.0",
+]
+
+[dependency-groups]
+dev = ["debugpy>=1.8.17", "ipython>=9.3.0", "pillow>=11.2.1"]
+
+[tool.uv.sources]
+fsspec = { git = "https://github.com/fsspec/filesystem_spec.git" }
+gcsfs = { git = "https://github.com/aabmass/gcsfs.git", branch = "remove-conflicts" }
+opentelemetry-exporter-gcp-logging = { git = "https://github.com/GoogleCloudPlatform/opentelemetry-operations-python.git", branch = "main", subdirectory = "opentelemetry-exporter-gcp-logging" }
+opentelemetry-instrumentation-google-genai = { path = "../instrumentation-genai/opentelemetry-instrumentation-google-genai", editable = true }
+opentelemetry-util-genai = { path = "../util/opentelemetry-util-genai", editable = true }
diff --git a/adk-sql-agent/run.sh b/adk-sql-agent/run.sh
@@ -0,0 +1,2 @@
+#!/bin/sh
+uv run --env-file main.env adk web --otel_to_cloud --host 0.0.0.0
diff --git a/adk-sql-agent/sql_agent/__init__.py b/adk-sql-agent/sql_agent/__init__.py
@@ -0,0 +1,3 @@
+from . import agent
+
+__all__ = ["agent"]
diff --git a/adk-sql-agent/sql_agent/agent.py b/adk-sql-agent/sql_agent/agent.py
@@ -0,0 +1,86 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+import sqlite3
+import tempfile
+
+from google.adk.agents import Agent
+from google.adk.agents.callback_context import CallbackContext
+from google.adk.models import LlmResponse, LlmRequest
+
+from opentelemetry import trace
+
+from .tools import create_run_sql_tool, describe_uri_tool
+
+# from utils import ask_prompt, console, print_markdown, render_messages
+
+
+SYSTEM_PROMPT = f"""\
+You are a helpful AI assistant with a mastery of database design and querying. You have access
+to an ephemeral sqlite3 database that you can query and modify through some tools. Help answer
+questions and perform actions. Follow these rules:
+
+- Make sure you always use sql_db_query_checker to validate SQL statements **before** running
+  them. In pseudocode: `checked_query = sql_db_query_checker(query);
+  sql_db_query(checked_query)`.
+- Be creative and don't ask for permission! The database is ephemeral so it's OK to make some mistakes.
+- The sqlite version is {sqlite3.sqlite_version} which supports multiple row inserts.
+- Always prefer to insert multiple rows in a single call to the sql_db_query tool, if possible.
+- You may request to execute multiple sql_db_query tool calls which will be run in parallel.
+
+If you make a mistake, try to recover."""
+
+INTRO_TEXT = """\
+Starting agent using ephemeral SQLite DB {dbpath}. This demo allows you to chat with an Agent
+that has full access to an ephemeral SQLite database. The database is initially empty. It is
+built with the the LangGraph prebuilt **ReAct Agent** and the **SQLDatabaseToolkit**. Here are some samples you can try:
+
+**Weather**
+- Create a new table to hold weather data.
+- Populate the weather database with 20 example rows.
+- Add a new column for weather observer notes
+
+**Pets**
+- Create a database table for pets including an `owner_id` column.
+- Add 20 example rows please.
+- Create an owner table.
+- Link the two tables together, adding new columns, values, and rows as needed.
+- Write a query to join these tables and give the result of owners and their pets.
+- Show me the query, then the output as a table
+
+---
+"""
+
+tracer = trace.get_tracer(__name__)
+
+
+def get_dbpath(thread_id: str) -> str:
+    # Ephemeral sqlite database per conversation thread
+    _, path = tempfile.mkstemp(suffix=".db")
+    return path
+
+
+# TODO: how to get the session from within a callback.
+dbpath = get_dbpath("default")
+
+
+root_agent = Agent(
+    name="sql_agent",
+    model="gemini-2.5-flash",
+    description=INTRO_TEXT,
+    instruction=SYSTEM_PROMPT,
+    tools=[create_run_sql_tool(dbpath), describe_uri_tool],
+)
diff --git a/adk-sql-agent/sql_agent/tools.py b/adk-sql-agent/sql_agent/tools.py
@@ -0,0 +1,109 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import logging
+import sqlite3
+from typing import Any, NotRequired, TypedDict
+
+from google.genai import Client
+from google.genai import types as genai_types
+
+from opentelemetry import trace
+from opentelemetry.instrumentation.sqlite3 import SQLite3Instrumentor
+
+
+tracer = trace.get_tracer(__name__)
+logger = logging.getLogger(__name__)
+
+
+class SqlRunResult(TypedDict):
+    error: NotRequired[str]
+    """If the result represents an error. It will be null or undefined if no error"""
+
+    rows: NotRequired[list[tuple[str, ...]]]
+    """The rows returned by the SQL query"""
+
+
+def create_run_sql_tool(dbpath: str):
+    instrumentor = SQLite3Instrumentor()
+
+    @tracer.start_as_current_span("run_sql")
+    def run_sql(sql_query: str) -> dict[str, Any]:
+        """Runs a SQLite query. The SQL query can be DDL or DML. Returns the rows if it's a SELECT query."""
+
+        with instrumentor.instrument_connection(sqlite3.connect(dbpath)) as db:
+            try:
+                cursor = db.cursor()
+                cursor.execute(sql_query)
+                rows_list: list[tuple[str, ...]] = []
+
+                # Check if the query is one that would return rows (e.g., SELECT)
+                if cursor.description is not None:
+                    fetched_rows: list[tuple[Any, ...]] = cursor.fetchall()
+                    rows_list = [
+                        tuple(str(col) for col in row) for row in fetched_rows
+                    ]
+                    logger.info("Query returned %s rows", len(rows_list))
+                else:
+                    # For DDL/DML (like INSERT, UPDATE, DELETE without RETURNING clause)
+                    # cursor.description is None.
+                    # rowcount shows number of affected rows for DML.
+                    logger.info(
+                        "Query affected %s rows (DDL/DML)", cursor.rowcount
+                    )
+
+                # DML statements (INSERT, UPDATE, DELETE) require a commit.
+                # DDL statements are often autocommitted by SQLite, but an explicit commit here ensures DML changes are saved.
+                db.commit()
+                return {"rows": rows_list}
+
+            except sqlite3.Error as err:
+                logger.error(f"SQL Error: {err} for query: {sql_query}")
+                try:
+                    db.rollback()  # Attempt to rollback on error
+                    logger.info("SQL transaction rolled back due to error.")
+                except sqlite3.Error as rb_err:
+                    # This can happen if the connection is already closed or in an unusable state.
+                    logger.error(f"Failed to rollback transaction: {rb_err}")
+                return {"error": str(err)}
+
+    return run_sql
+
+
+# Tool that calls gemini with an image
+@tracer.start_as_current_span("describe_uri_tool")
+def describe_uri_tool(uri: str, mime_type: str) -> dict[str, Any]:
+    """describe_uri_tool is a tool that takes a URI (http(s) or gs:// for GCS) and mime type
+    for the URI (you can guess the type your best) and returns a description or error.
+    """
+    client = Client()
+
+    try:
+        res = client.models.generate_content(
+            model="gemini-2.0-flash-lite",
+            contents=[
+                genai_types.Part.from_text(
+                    text="Describe the following attached file:"
+                ),
+                genai_types.Part.from_uri(file_uri=uri, mime_type=mime_type),
+            ],
+        )
+    except Exception as e:
+        return {"error": str(e)}
+
+    if not res.candidates:
+        return {"error": "No candidates returned"}
+
+    return res.candidates[0].model_dump(mode="json")
diff --git a/adk-sql-agent/utils.py b/adk-sql-agent/utils.py
diff --git a/adk-sql-agent/uv.lock b/adk-sql-agent/uv.lock
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+GOOGLE_GENAI_USE_VERTEXAI=1`
	`2`	`+GOOGLE_CLOUD_PROJECT=otel-starter-project`
	`3`	`+GOOGLE_CLOUD_LOCATION=us-central1`