openinference-instrumentation-google-adk 0.1.0__tar.gz

openinference_instrumentation_google_adk-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+# vendored virtual environments
+.venv
+
+# gradio work directory
+.gradio

openinference_instrumentation_google_adk-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright The OpenInference Authors
+
+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
+
+       http://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.

openinference_instrumentation_google_adk-0.1.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: openinference-instrumentation-google-adk
+Version: 0.1.0
+Summary: OpenInference Google ADK Instrumentation
+Project-URL: Homepage, https://github.com/Arize-ai/openinference/tree/main/python/instrumentation/openinference-instrumentation-google-adk
+Author-email: OpenInference Authors <oss@arize.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.9
+Requires-Dist: openinference-instrumentation>=0.1.32
+Requires-Dist: openinference-semantic-conventions>=0.1.17
+Requires-Dist: opentelemetry-api
+Requires-Dist: opentelemetry-instrumentation
+Requires-Dist: opentelemetry-semantic-conventions
+Requires-Dist: typing-extensions
+Requires-Dist: wrapt
+Provides-Extra: instruments
+Requires-Dist: google-adk>=1.2.1; extra == 'instruments'
+Description-Content-Type: text/markdown
+
+# OpenInference Google ADK Instrumentation
+
+[![pypi](https://badge.fury.io/py/openinference-instrumentation-google-adk.svg)](https://pypi.org/project/openinference-instrumentation-google-adk/)
+
+Python auto-instrumentation library for Google ADK.
+
+The traces emitted by this instrumentation are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as [`arize-phoenix`](https://github.com/Arize-ai/phoenix)
+
+## Installation
+
+```shell
+pip install openinference-instrumentation-google-adk
+```
+
+## Quickstart
+
+In this example we will instrument a small program that uses Gemini and observe the traces via [`arize-phoenix`](https://github.com/Arize-ai/phoenix).
+
+Install packages.
+
+```shell
+pip install openinference-instrumentation-google-adk arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp
+```
+
+Start the phoenix server so that it is ready to collect traces.
+The Phoenix server runs entirely on your machine and does not send data over the internet.
+
+```shell
+phoenix serve
+```
+
+In a python file, set up the `GoogleADKInstrumentor` and configure the tracer to send traces to Phoenix.
+
+```python
+import asyncio
+
+from google.adk.agents import Agent
+from google.adk.runners import InMemoryRunner
+from google.genai import types
+
+from openinference.instrumentation.google_adk import GoogleADKInstrumentor
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk import trace as trace_sdk
+from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SimpleSpanProcessor
+
+endpoint = "http://127.0.0.1:6006/v1/traces"
+tracer_provider = trace_sdk.TracerProvider()
+tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))
+# Optionally, you can also print the spans to the console.
+tracer_provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter()))
+
+GoogleADKInstrumentor().instrument(tracer_provider=tracer_provider)
+
+def get_weather(city: str) -> dict:
+    """Retrieves the current weather report for a specified city.
+
+    Args:
+        city (str): The name of the city for which to retrieve the weather report.
+
+    Returns:
+        dict: status and result or error msg.
+    """
+    if city.lower() == "new york":
+        return {
+            "status": "success",
+            "report": (
+                "The weather in New York is sunny with a temperature of 25 degrees"
+                " Celsius (77 degrees Fahrenheit)."
+            ),
+        }
+    else:
+        return {
+            "status": "error",
+            "error_message": f"Weather information for '{city}' is not available.",
+        }
+
+agent = Agent(
+   name="test_agent",
+   model="gemini-2.0-flash-exp",
+   description="Agent to answer questions using tools.",
+   instruction="You must use the available tools to find an answer.",
+   tools=[get_weather]
+)
+
+async def main():
+    app_name = "test_instrumentation"
+    user_id = "test_user"
+    session_id = "test_session"
+    runner = InMemoryRunner(agent=agent, app_name=app_name)
+    session_service = runner.session_service
+    await session_service.create_session(
+        app_name=app_name,
+        user_id=user_id,
+        session_id=session_id
+    )
+    async for event in runner.run_async(
+        user_id=user_id,
+        session_id=session_id,
+        new_message=types.Content(role="user", parts=[
+            types.Part(text="What is the weather in New York?")]
+        )
+    ):
+        if event.is_final_response():
+            print(event.content.parts[0].text.strip())
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Since we are using Gemini, we must set the `GOOGLE_API_KEY` environment variable to authenticate with the Gemini API.
+
+```shell
+export GOOGLE_API_KEY=your-api-key
+```
+
+Now simply run the python file and observe the traces in Phoenix.
+
+```shell
+python your_file.py
+```

openinference_instrumentation_google_adk-0.1.0/README.md

@@ -0,0 +1,120 @@
+# OpenInference Google ADK Instrumentation
+
+[![pypi](https://badge.fury.io/py/openinference-instrumentation-google-adk.svg)](https://pypi.org/project/openinference-instrumentation-google-adk/)
+
+Python auto-instrumentation library for Google ADK.
+
+The traces emitted by this instrumentation are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as [`arize-phoenix`](https://github.com/Arize-ai/phoenix)
+
+## Installation
+
+```shell
+pip install openinference-instrumentation-google-adk
+```
+
+## Quickstart
+
+In this example we will instrument a small program that uses Gemini and observe the traces via [`arize-phoenix`](https://github.com/Arize-ai/phoenix).
+
+Install packages.
+
+```shell
+pip install openinference-instrumentation-google-adk arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp
+```
+
+Start the phoenix server so that it is ready to collect traces.
+The Phoenix server runs entirely on your machine and does not send data over the internet.
+
+```shell
+phoenix serve
+```
+
+In a python file, set up the `GoogleADKInstrumentor` and configure the tracer to send traces to Phoenix.
+
+```python
+import asyncio
+
+from google.adk.agents import Agent
+from google.adk.runners import InMemoryRunner
+from google.genai import types
+
+from openinference.instrumentation.google_adk import GoogleADKInstrumentor
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk import trace as trace_sdk
+from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SimpleSpanProcessor
+
+endpoint = "http://127.0.0.1:6006/v1/traces"
+tracer_provider = trace_sdk.TracerProvider()
+tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))
+# Optionally, you can also print the spans to the console.
+tracer_provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter()))
+
+GoogleADKInstrumentor().instrument(tracer_provider=tracer_provider)
+
+def get_weather(city: str) -> dict:
+    """Retrieves the current weather report for a specified city.
+
+    Args:
+        city (str): The name of the city for which to retrieve the weather report.
+
+    Returns:
+        dict: status and result or error msg.
+    """
+    if city.lower() == "new york":
+        return {
+            "status": "success",
+            "report": (
+                "The weather in New York is sunny with a temperature of 25 degrees"
+                " Celsius (77 degrees Fahrenheit)."
+            ),
+        }
+    else:
+        return {
+            "status": "error",
+            "error_message": f"Weather information for '{city}' is not available.",
+        }
+
+agent = Agent(
+   name="test_agent",
+   model="gemini-2.0-flash-exp",
+   description="Agent to answer questions using tools.",
+   instruction="You must use the available tools to find an answer.",
+   tools=[get_weather]
+)
+
+async def main():
+    app_name = "test_instrumentation"
+    user_id = "test_user"
+    session_id = "test_session"
+    runner = InMemoryRunner(agent=agent, app_name=app_name)
+    session_service = runner.session_service
+    await session_service.create_session(
+        app_name=app_name,
+        user_id=user_id,
+        session_id=session_id
+    )
+    async for event in runner.run_async(
+        user_id=user_id,
+        session_id=session_id,
+        new_message=types.Content(role="user", parts=[
+            types.Part(text="What is the weather in New York?")]
+        )
+    ):
+        if event.is_final_response():
+            print(event.content.parts[0].text.strip())
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Since we are using Gemini, we must set the `GOOGLE_API_KEY` environment variable to authenticate with the Gemini API.
+
+```shell
+export GOOGLE_API_KEY=your-api-key
+```
+
+Now simply run the python file and observe the traces in Phoenix.
+
+```shell
+python your_file.py
+```

openinference_instrumentation_google_adk-0.1.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "openinference-instrumentation-google-adk"
+dynamic = ["version"]
+description = "OpenInference Google ADK Instrumentation"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.9, <3.14"
+authors = [
+  { name = "OpenInference Authors", email = "oss@arize.com" },
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+  "opentelemetry-api",
+  "opentelemetry-instrumentation",
+  "opentelemetry-semantic-conventions",
+  "openinference-instrumentation>=0.1.32",
+  "openinference-semantic-conventions>=0.1.17",
+  "typing-extensions",
+  "wrapt",
+]
+
+[project.optional-dependencies]
+instruments = [
+  "google-adk >= 1.2.1",
+]
+
+[project.entry-points.opentelemetry_instrumentor]
+google_adk = "openinference.instrumentation.google_adk:GoogleADKInstrumentor"
+
+[project.entry-points.openinference_instrumentor]
+google_adk = "openinference.instrumentation.google_adk:GoogleADKInstrumentor"
+
+[project.urls]
+Homepage = "https://github.com/Arize-ai/openinference/tree/main/python/instrumentation/openinference-instrumentation-google-adk"
+
+[tool.hatch.version]
+path = "src/openinference/instrumentation/google_adk/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/openinference"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = [
+  "tests",
+]
+
+[tool.mypy]
+strict = true
+explicit_package_bases = true
+exclude = [
+  "examples",
+  "dist",
+  "sdist",
+]
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = [
+  "wrapt",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint.per-file-ignores]
+"*.ipynb" = ["E402", "E501"]
+"examples/*" = ["E501"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+
+[tool.ruff.lint.isort]
+force-single-line = false

openinference_instrumentation_google_adk-0.1.0/src/openinference/instrumentation/google_adk/__init__.py

@@ -0,0 +1,187 @@
+import logging
+from typing import Any, Collection, Dict, Iterator, List, Tuple, cast
+
+import wrapt
+from opentelemetry import trace as trace_api
+from opentelemetry.instrumentation.instrumentor import (  # type: ignore[attr-defined]
+    BaseInstrumentor,
+)
+from opentelemetry.trace import Span, Tracer, get_current_span
+from opentelemetry.util._decorator import _agnosticcontextmanager
+from wrapt import resolve_path, wrap_function_wrapper
+
+from openinference.instrumentation import OITracer, TraceConfig
+from openinference.instrumentation.google_adk.version import __version__
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+_instruments = ("google-adk >= 1.2.1",)
+
+
+class GoogleADKInstrumentor(BaseInstrumentor):  # type: ignore
+    def instrumentation_dependencies(self) -> Collection[str]:
+        return _instruments
+
+    def _instrument(self, **kwargs: Any) -> None:
+        if not (tracer_provider := kwargs.get("tracer_provider")):
+            tracer_provider = trace_api.get_tracer_provider()
+        if not (config := kwargs.get("config")):
+            config = TraceConfig()
+        else:
+            assert isinstance(config, TraceConfig)
+
+        self._tracer = cast(
+            Tracer,
+            OITracer(
+                trace_api.get_tracer(__name__, __version__, tracer_provider),
+                config=config,
+            ),
+        )
+
+        from google.adk.agents import BaseAgent
+        from google.adk.runners import Runner
+
+        from openinference.instrumentation.google_adk._wrappers import (
+            _BaseAgentRunAsync,
+            _RunnerRunAsync,
+        )
+
+        # Store original methods for cleanup during uninstrumentation
+        self._originals: List[Tuple[Any, Any, Any]] = []
+        method_wrappers: Dict[Any, Any] = {
+            Runner.run_async: _RunnerRunAsync(self._tracer),
+            BaseAgent.run_async: _BaseAgentRunAsync(self._tracer),
+        }
+
+        # Wrap each method with its corresponding tracer
+        for method, wrapper in method_wrappers.items():
+            module, name = method.__module__, method.__qualname__
+            self._originals.append(resolve_path(module, name))
+            wrap_function_wrapper(module, name, wrapper)
+
+        self._patch_trace_call_llm()
+        self._patch_trace_tool_call()
+        self._disable_existing_tracers()
+
+    def _uninstrument(self, **kwargs: Any) -> None:
+        self._unpatch_trace_call_llm()
+        self._unpatch_trace_tool_call()
+        self._restore_existing_tracers()
+
+        # Restore all wrapped methods to their original state
+        for parent, attribute, original in getattr(self, "_originals", ()):
+            setattr(parent, attribute, original)
+
+    def _patch_trace_call_llm(self) -> None:
+        """Patch the LLM call tracing functionality to use our tracer."""
+        from google.adk.flows.llm_flows import base_llm_flow
+
+        from openinference.instrumentation.google_adk._wrappers import _TraceCallLlm
+
+        setattr(base_llm_flow, "tracer", self._tracer)
+        setattr(
+            base_llm_flow,
+            "trace_call_llm",
+            _TraceCallLlm(self._tracer)(base_llm_flow.trace_call_llm),  # type: ignore[attr-defined]
+        )
+
+    def _unpatch_trace_call_llm(self) -> None:
+        """Restore the original LLM call tracing functionality."""
+        from google.adk.flows.llm_flows import base_llm_flow
+
+        if callable(
+            original := getattr(base_llm_flow.trace_call_llm, "__wrapped__"),  # type: ignore[attr-defined]
+        ):
+            from google.adk.flows.llm_flows import (
+                base_llm_flow,
+            )
+
+            setattr(base_llm_flow, "trace_call_llm", original)
+
+        from google.adk.telemetry import tracer
+
+        setattr(base_llm_flow, "tracer", tracer)
+
+    def _patch_trace_tool_call(self) -> None:
+        """Patch the tool call tracing functionality to use our tracer."""
+        from google.adk.flows.llm_flows import functions
+
+        from openinference.instrumentation.google_adk._wrappers import _TraceToolCall
+
+        setattr(functions, "tracer", self._tracer)
+        setattr(
+            functions,
+            "trace_tool_call",
+            _TraceToolCall(self._tracer)(functions.trace_tool_call),  # type: ignore[attr-defined]
+        )
+
+    def _unpatch_trace_tool_call(self) -> None:
+        """Restore the original tool call tracing functionality."""
+        from google.adk.flows.llm_flows.base_llm_flow import functions  # type: ignore[attr-defined]
+
+        if callable(
+            original := getattr(functions.trace_tool_call, "__wrapped__"),  # type: ignore[attr-defined]
+        ):
+            from google.adk.flows.llm_flows.base_llm_flow import (  # type: ignore[attr-defined]
+                functions,
+            )
+
+            setattr(functions, "trace_tool_call", original)
+
+        from google.adk.telemetry import tracer
+
+        setattr(functions, "tracer", tracer)
+
+    def _disable_existing_tracers(self) -> None:
+        """Disable existing tracers to prevent double-instrumentation."""
+        from google.adk.runners import (  # type: ignore[attr-defined]
+            tracer,  # pyright: ignore[reportPrivateImportUsage]
+        )
+
+        if isinstance(tracer, Tracer):
+            from google.adk import runners
+
+            setattr(runners, "tracer", _PassthroughTracer(tracer))
+
+        from google.adk.agents.base_agent import (
+            tracer,  # pyright: ignore[reportPrivateImportUsage]
+        )
+
+        if isinstance(tracer, Tracer):
+            from google.adk.agents import base_agent
+
+            setattr(base_agent, "tracer", _PassthroughTracer(tracer))
+
+    def _restore_existing_tracers(self) -> None:
+        """Restore original tracers that were disabled during instrumentation."""
+        from google.adk.runners import (  # type: ignore[attr-defined]
+            tracer,  # pyright: ignore[reportPrivateImportUsage]
+        )
+
+        if isinstance(original := getattr(tracer, "__wrapped__"), Tracer):
+            from google.adk import runners
+
+            setattr(runners, "tracer", original)
+
+        from google.adk.agents.base_agent import (
+            tracer,  # pyright: ignore[reportPrivateImportUsage]
+        )
+
+        if isinstance(original := getattr(tracer, "__wrapped__"), Tracer):
+            from google.adk.agents import base_agent
+
+            setattr(base_agent, "tracer", original)
+
+
+class _PassthroughTracer(wrapt.ObjectProxy):  # type: ignore[misc]
+    """A tracer proxy that passes through span operations without creating new spans.
+
+    This is used to disable existing tracers during instrumentation to prevent
+    double-instrumentation of the same operations.
+    """
+
+    @_agnosticcontextmanager
+    def start_as_current_span(self, *args: Any, **kwargs: Any) -> Iterator[Span]:
+        """Return the current span without creating a new one."""
+        yield get_current_span()

openinference_instrumentation_google_adk-0.1.0/src/openinference/instrumentation/google_adk/_wrappers.py

@@ -0,0 +1,522 @@
+import inspect
+import json
+import logging
+from abc import ABC
+from contextlib import ExitStack
+from typing import (
+    Any,
+    AsyncGenerator,
+    Callable,
+    Iterable,
+    Iterator,
+    Mapping,
+    OrderedDict,
+    TypedDict,
+    TypeVar,
+)
+
+import wrapt
+from google.adk import Runner
+from google.adk.agents import BaseAgent
+from google.adk.agents.run_config import RunConfig
+from google.adk.events import Event
+from google.adk.models.llm_request import LlmRequest
+from google.adk.models.llm_response import LlmResponse
+from google.adk.telemetry import _build_llm_request_for_trace
+from google.adk.tools import BaseTool
+from google.genai import types
+from google.genai.types import MediaModality
+from opentelemetry import context as context_api
+from opentelemetry import trace as trace_api
+from opentelemetry.context import _SUPPRESS_INSTRUMENTATION_KEY
+from opentelemetry.trace import StatusCode, get_current_span
+from opentelemetry.util.types import AttributeValue
+from typing_extensions import NotRequired, ParamSpec
+
+from openinference.instrumentation import (
+    get_attributes_from_context,
+    safe_json_dumps,
+    using_session,
+    using_user,
+)
+from openinference.semconv.trace import (
+    MessageAttributes,
+    MessageContentAttributes,
+    OpenInferenceLLMProviderValues,
+    OpenInferenceMimeTypeValues,
+    OpenInferenceSpanKindValues,
+    SpanAttributes,
+    ToolAttributes,
+    ToolCallAttributes,
+)
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+P = ParamSpec("P")
+T = TypeVar("T")
+
+
+class _WithTracer(ABC):
+    def __init__(
+        self,
+        tracer: trace_api.Tracer,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self._tracer = tracer
+
+
+class _RunnerRunAsyncKwargs(TypedDict):
+    user_id: str
+    session_id: str
+    new_message: types.Content
+    run_config: NotRequired[RunConfig]
+
+
+class _RunnerRunAsync(_WithTracer):
+    def __call__(
+        self,
+        wrapped: Callable[..., AsyncGenerator[Event, None]],
+        instance: Runner,
+        args: tuple[Any, ...],
+        kwargs: _RunnerRunAsyncKwargs,
+    ) -> Any:
+        generator = wrapped(*args, **kwargs)
+        if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+            return generator
+
+        tracer = self._tracer
+        name = f"invocation [{instance.app_name}]"
+        attributes = dict(get_attributes_from_context())
+        attributes[SpanAttributes.OPENINFERENCE_SPAN_KIND] = OpenInferenceSpanKindValues.CHAIN.value
+
+        arguments = bind_args_kwargs(wrapped, *args, **kwargs)
+        try:
+            attributes[SpanAttributes.INPUT_VALUE] = json.dumps(
+                arguments,
+                default=_default,
+                ensure_ascii=False,
+            )
+            attributes[SpanAttributes.INPUT_MIME_TYPE] = OpenInferenceMimeTypeValues.JSON.value
+        except Exception:
+            logger.exception(f"Failed to get attribute: {SpanAttributes.INPUT_VALUE}.")
+
+        if (user_id := kwargs.get("user_id")) is not None:
+            attributes[SpanAttributes.USER_ID] = user_id
+        if (session_id := kwargs.get("session_id")) is not None:
+            attributes[SpanAttributes.SESSION_ID] = session_id
+
+        class _AsyncGenerator(wrapt.ObjectProxy):  # type: ignore[misc]
+            __wrapped__: AsyncGenerator[Event, None]
+
+            async def __aiter__(self) -> Any:
+                with ExitStack() as stack:
+                    span = stack.enter_context(
+                        tracer.start_as_current_span(
+                            name=name,
+                            attributes=attributes,
+                        )
+                    )
+                    if user_id is not None:
+                        stack.enter_context(using_user(user_id))
+                    if session_id is not None:
+                        stack.enter_context(using_session(session_id))
+                    async for event in self.__wrapped__:
+                        if event.is_final_response():
+                            try:
+                                span.set_attribute(
+                                    SpanAttributes.OUTPUT_VALUE,
+                                    event.model_dump_json(exclude_none=True),
+                                )
+                                span.set_attribute(
+                                    SpanAttributes.OUTPUT_MIME_TYPE,
+                                    OpenInferenceMimeTypeValues.JSON.value,
+                                )
+                            except Exception:
+                                logger.exception(
+                                    f"Failed to get attribute: {SpanAttributes.OUTPUT_VALUE}."
+                                )
+                        yield event
+                    span.set_status(StatusCode.OK)
+
+        return _AsyncGenerator(generator)
+
+
+class _BaseAgentRunAsync(_WithTracer):
+    def __call__(
+        self,
+        wrapped: Callable[..., AsyncGenerator[Event, None]],
+        instance: BaseAgent,
+        args: tuple[Any, ...],
+        kwargs: Mapping[str, Any],
+    ) -> Any:
+        generator = wrapped(*args, **kwargs)
+        if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+            return generator
+
+        tracer = self._tracer
+        name = f"agent_run [{instance.name}]"
+        attributes = dict(get_attributes_from_context())
+        attributes[SpanAttributes.OPENINFERENCE_SPAN_KIND] = OpenInferenceSpanKindValues.AGENT.value
+
+        class _AsyncGenerator(wrapt.ObjectProxy):  # type: ignore[misc]
+            __wrapped__: AsyncGenerator[Event, None]
+
+            async def __aiter__(self) -> Any:
+                with tracer.start_as_current_span(
+                    name=name,
+                    attributes=attributes,
+                ) as span:
+                    async for event in self.__wrapped__:
+                        if event.is_final_response():
+                            try:
+                                span.set_attribute(
+                                    SpanAttributes.OUTPUT_VALUE,
+                                    event.model_dump_json(exclude_none=True),
+                                )
+                                span.set_attribute(
+                                    SpanAttributes.OUTPUT_MIME_TYPE,
+                                    OpenInferenceMimeTypeValues.JSON.value,
+                                )
+                            except Exception:
+                                logger.exception(
+                                    f"Failed to get attribute: {SpanAttributes.OUTPUT_VALUE}."
+                                )
+                        yield event
+                    span.set_status(StatusCode.OK)
+
+        return _AsyncGenerator(generator)
+
+
+class _TraceCallLlm(_WithTracer):
+    @wrapt.decorator  # type: ignore[misc]
+    def __call__(
+        self,
+        wrapped: Callable[..., T],
+        _: Any,
+        args: tuple[Any, ...],
+        kwargs: Mapping[str, Any],
+    ) -> T:
+        ans = wrapped(*args, **kwargs)
+        if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+            return ans
+        span = get_current_span()
+        span.set_status(StatusCode.OK)  # Pre-emptively set status to OK
+        span.set_attribute(
+            SpanAttributes.OPENINFERENCE_SPAN_KIND,
+            OpenInferenceSpanKindValues.LLM.value,
+        )
+        arguments = bind_args_kwargs(wrapped, *args, **kwargs)
+        llm_request = next((arg for arg in arguments.values() if isinstance(arg, LlmRequest)), None)
+        llm_response = next(
+            (arg for arg in arguments.values() if isinstance(arg, LlmResponse)), None
+        )
+        input_messages_index = 0
+        if llm_request:
+            span.set_attribute(
+                SpanAttributes.LLM_PROVIDER,
+                OpenInferenceLLMProviderValues.GOOGLE.value,
+            )  # TODO: other providers may also be possible
+
+            try:
+                span.set_attribute(
+                    SpanAttributes.INPUT_VALUE,
+                    safe_json_dumps(_build_llm_request_for_trace(llm_request)),
+                )
+                span.set_attribute(
+                    SpanAttributes.INPUT_MIME_TYPE,
+                    OpenInferenceMimeTypeValues.JSON.value,
+                )
+            except Exception:
+                logger.exception(f"Failed to get attribute: {SpanAttributes.INPUT_VALUE}.")
+
+            if llm_request.tools_dict:
+                for i, tool in enumerate(llm_request.tools_dict.values()):
+                    for k, v in _get_attributes_from_base_tool(
+                        tool,
+                        prefix=f"{SpanAttributes.LLM_TOOLS}.{i}.",
+                    ):
+                        span.set_attribute(k, v)
+
+            if llm_request.model:
+                span.set_attribute(SpanAttributes.LLM_MODEL_NAME, llm_request.model)
+
+            if config := llm_request.config:
+                for k, v in _get_attributes_from_generate_content_config(config):
+                    span.set_attribute(k, v)
+
+                if system_instruction := config.system_instruction:
+                    span.set_attribute(
+                        f"{SpanAttributes.LLM_INPUT_MESSAGES}.{input_messages_index}.{MessageAttributes.MESSAGE_ROLE}",
+                        "system",
+                    )
+                    if isinstance(system_instruction, str):
+                        span.set_attribute(
+                            f"{SpanAttributes.LLM_INPUT_MESSAGES}.{input_messages_index}.{MessageAttributes.MESSAGE_CONTENT}",
+                            system_instruction,
+                        )
+                    elif isinstance(system_instruction, types.Content):
+                        if system_instruction.parts:
+                            for k, v in _get_attributes_from_parts(
+                                system_instruction.parts,
+                                prefix=f"{SpanAttributes.LLM_INPUT_MESSAGES}.{input_messages_index}.",
+                                text_only=True,
+                            ):
+                                span.set_attribute(k, v)
+                    elif isinstance(system_instruction, list):
+                        # TODO
+                        pass
+                    input_messages_index += 1
+
+            if contents := llm_request.contents:
+                for i, content in enumerate(contents, input_messages_index):
+                    for k, v in _get_attributes_from_content(
+                        content,
+                        prefix=f"{SpanAttributes.LLM_INPUT_MESSAGES}.{i}.",
+                    ):
+                        span.set_attribute(k, v)
+        if llm_response:
+            for k, v in _get_attributes_from_llm_response(llm_response):
+                span.set_attribute(k, v)
+        return ans
+
+
+class _TraceToolCall(_WithTracer):
+    @wrapt.decorator  # type: ignore[misc]
+    def __call__(
+        self,
+        wrapped: Callable[..., T],
+        _: Any,
+        args: tuple[Any, ...],
+        kwargs: Mapping[str, Any],
+    ) -> T:
+        ans = wrapped(*args, **kwargs)
+        if context_api.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
+            return ans
+        span = get_current_span()
+        span.set_status(StatusCode.OK)  # Pre-emptively set status to OK
+        span.set_attribute(
+            SpanAttributes.OPENINFERENCE_SPAN_KIND,
+            OpenInferenceSpanKindValues.TOOL.value,
+        )
+        arguments = bind_args_kwargs(wrapped, *args, **kwargs)
+        if base_tool := next(
+            (arg for arg in arguments.values() if isinstance(arg, BaseTool)), None
+        ):
+            span.set_attribute(SpanAttributes.TOOL_NAME, base_tool.name)
+            span.set_attribute(SpanAttributes.TOOL_DESCRIPTION, base_tool.description)
+            if args_dict := next(
+                (arg for arg in arguments.values() if isinstance(arg, Mapping)), None
+            ):
+                try:
+                    span.set_attribute(
+                        SpanAttributes.TOOL_PARAMETERS,
+                        safe_json_dumps(args_dict),
+                    )
+                    span.set_attribute(
+                        SpanAttributes.INPUT_VALUE,
+                        safe_json_dumps(args_dict),
+                    )
+                    span.set_attribute(
+                        SpanAttributes.INPUT_MIME_TYPE,
+                        OpenInferenceMimeTypeValues.JSON.value,
+                    )
+                except Exception:
+                    logger.exception(f"Failed to get attribute: {SpanAttributes.INPUT_VALUE}.")
+        if event := next((arg for arg in arguments.values() if isinstance(arg, Event)), None):
+            if responses := event.get_function_responses():
+                try:
+                    span.set_attribute(
+                        SpanAttributes.OUTPUT_VALUE,
+                        responses[0].model_dump_json(exclude_none=True),
+                    )
+                    span.set_attribute(
+                        SpanAttributes.OUTPUT_MIME_TYPE,
+                        OpenInferenceMimeTypeValues.JSON.value,
+                    )
+                except Exception:
+                    logger.exception(f"Failed to get attribute in {wrapped.__name__}.")
+        return ans
+
+
+def stop_on_exception(
+    wrapped: Callable[P, Iterator[tuple[str, AttributeValue]]],
+) -> Callable[P, Iterator[tuple[str, AttributeValue]]]:
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> Iterator[tuple[str, AttributeValue]]:
+        try:
+            yield from wrapped(*args, **kwargs)
+        except Exception:
+            logger.exception(f"Failed to get attribute in {wrapped.__name__}.")
+
+    return wrapper
+
+
+@stop_on_exception
+def _get_attributes_from_generate_content_config(
+    obj: types.GenerateContentConfig,
+) -> Iterator[tuple[str, AttributeValue]]:
+    yield SpanAttributes.LLM_INVOCATION_PARAMETERS, obj.model_dump_json(exclude_none=True)
+
+
+@stop_on_exception
+def _get_attributes_from_llm_response(
+    obj: LlmResponse,
+) -> Iterator[tuple[str, AttributeValue]]:
+    yield SpanAttributes.OUTPUT_VALUE, obj.model_dump_json(exclude_none=True)
+    yield SpanAttributes.OUTPUT_MIME_TYPE, OpenInferenceMimeTypeValues.JSON.value
+    if obj.usage_metadata:
+        yield from _get_attributes_from_usage_metadata(obj.usage_metadata)
+    if obj.content:
+        yield from _get_attributes_from_content(
+            obj.content, prefix=f"{SpanAttributes.LLM_OUTPUT_MESSAGES}.0."
+        )
+
+
+@stop_on_exception
+def _get_attributes_from_usage_metadata(
+    obj: types.GenerateContentResponseUsageMetadata,
+) -> Iterator[tuple[str, AttributeValue]]:
+    if obj.candidates_token_count:
+        yield SpanAttributes.LLM_TOKEN_COUNT_COMPLETION, obj.candidates_token_count
+    if obj.candidates_tokens_details:
+        completion_details_audio = 0
+        for modality_token_count in obj.candidates_tokens_details:
+            if (
+                modality_token_count.modality is MediaModality.AUDIO
+                and modality_token_count.token_count
+            ):
+                completion_details_audio += modality_token_count.token_count
+        if completion_details_audio:
+            yield SpanAttributes.LLM_TOKEN_COUNT_COMPLETION_DETAILS_AUDIO, completion_details_audio
+    if obj.prompt_token_count:
+        yield SpanAttributes.LLM_TOKEN_COUNT_PROMPT, obj.prompt_token_count
+    if obj.total_token_count:
+        yield SpanAttributes.LLM_TOKEN_COUNT_TOTAL, obj.total_token_count
+
+
+@stop_on_exception
+def _get_attributes_from_content(
+    obj: types.Content,
+    /,
+    *,
+    prefix: str = "",
+) -> Iterator[tuple[str, AttributeValue]]:
+    role = obj.role or "user"
+    yield f"{prefix}{MessageAttributes.MESSAGE_ROLE}", role
+    if parts := obj.parts:
+        yield from _get_attributes_from_parts(parts, prefix=prefix)
+
+
+@stop_on_exception
+def _get_attributes_from_parts(
+    obj: Iterable[types.Part],
+    /,
+    *,
+    prefix: str = "",
+    text_only: bool = False,
+) -> Iterator[tuple[str, AttributeValue]]:
+    for i, part in enumerate(obj):
+        if (text := part.text) is not None:
+            yield from _get_attributes_from_text_part(
+                text,
+                prefix=f"{prefix}{MessageAttributes.MESSAGE_CONTENTS}.{i}.",
+            )
+        elif text_only:
+            continue
+        elif (function_call := part.function_call) is not None:
+            yield from _get_attributes_from_function_call(
+                function_call,
+                prefix=f"{prefix}{MessageAttributes.MESSAGE_TOOL_CALLS}.{i}.",
+            )
+        elif (function_response := part.function_response) is not None:
+            yield f"{prefix}{MessageAttributes.MESSAGE_ROLE}", "tool"
+            if function_response.name:
+                yield f"{prefix}{MessageAttributes.MESSAGE_NAME}", function_response.name
+            if function_response.response:
+                yield (
+                    f"{prefix}{MessageAttributes.MESSAGE_CONTENT}",
+                    safe_json_dumps(function_response.response),
+                )
+
+
+@stop_on_exception
+def _get_attributes_from_text_part(
+    obj: str,
+    /,
+    *,
+    prefix: str = "",
+) -> Iterator[tuple[str, AttributeValue]]:
+    yield f"{prefix}{MessageContentAttributes.MESSAGE_CONTENT_TEXT}", obj
+    yield f"{prefix}{MessageContentAttributes.MESSAGE_CONTENT_TYPE}", "text"
+
+
+@stop_on_exception
+def _get_attributes_from_function_call(
+    obj: types.FunctionCall,
+    /,
+    *,
+    prefix: str = "",
+) -> Iterator[tuple[str, AttributeValue]]:
+    if id_ := obj.id:
+        yield f"{prefix}{ToolCallAttributes.TOOL_CALL_ID}", id_
+    if name := obj.name:
+        yield f"{prefix}{ToolCallAttributes.TOOL_CALL_FUNCTION_NAME}", name
+    if function_arguments := obj.args:
+        yield (
+            f"{prefix}{ToolCallAttributes.TOOL_CALL_FUNCTION_ARGUMENTS_JSON}",
+            safe_json_dumps(function_arguments),
+        )
+
+
+@stop_on_exception
+def _get_attributes_from_function_response(
+    obj: types.FunctionResponse,
+    /,
+    *,
+    prefix: str = "",
+) -> Iterator[tuple[str, AttributeValue]]:
+    if id_ := obj.id:
+        yield f"{prefix}{ToolCallAttributes.TOOL_CALL_ID}", id_
+    if name := obj.name:
+        yield f"{prefix}{ToolCallAttributes.TOOL_CALL_FUNCTION_NAME}", name
+    if response := obj.response:
+        yield (
+            f"{prefix}{ToolCallAttributes.TOOL_CALL_FUNCTION_ARGUMENTS_JSON}",
+            safe_json_dumps(response),
+        )
+
+
+@stop_on_exception
+def _get_attributes_from_base_tool(
+    obj: BaseTool,
+    /,
+    *,
+    prefix: str = "",
+) -> Iterator[tuple[str, AttributeValue]]:
+    if declaration := obj._get_declaration():
+        tool_json_schema = declaration.model_dump_json(exclude_none=True)
+    else:
+        tool_json_schema = json.dumps({"name": obj.name, "description": obj.description})
+    yield f"{prefix}{ToolAttributes.TOOL_JSON_SCHEMA}", tool_json_schema
+
+
+def bind_args_kwargs(func: Any, *args: Any, **kwargs: Any) -> OrderedDict[str, Any]:
+    sig = inspect.signature(func)
+    bound = sig.bind(*args, **kwargs)
+    bound.apply_defaults()
+    return bound.arguments
+
+
+def _default(obj: Any) -> str:
+    from pydantic import BaseModel
+
+    if isinstance(obj, BaseModel):
+        return json.dumps(
+            obj.model_dump(exclude=None),
+            ensure_ascii=False,
+            default=str,
+        )
+    else:
+        return str(obj)

openinference_instrumentation_google_adk-0.1.0/src/openinference/instrumentation/google_adk/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"