-
Notifications
You must be signed in to change notification settings - Fork 31
feat(deepagents): support DeepAgents instrumentation #228
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sipercai
wants to merge
17
commits into
main
Choose a base branch
from
liuyu/simple-deepagents-instrumentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
effaf5a
feat(deepagents): add root agent instrumentation
sipercai 4af6f06
docs(deepagents): clarify manual instrumentation order
sipercai 6b5ad37
chore(deepagents): use loongsuite util genai for direct installs
sipercai f9e7bdc
feat(deepagents): map model nodes to react steps
sipercai f799020
feat(deepagents): capture skill load attributes
sipercai 238ab3d
chore(deepagents): satisfy PR readiness checks
sipercai 385f7c5
style(deepagents): apply precommit formatting
sipercai 875f970
fix(deepagents): uninstrument managed dependencies
sipercai a456f57
test(deepagents): cover structured tool arguments
sipercai 2d51b6c
perf(langchain): route react step entry by framework
sipercai 30f0a4c
fix(deepagents): restore util package source metadata
sipercai 974b460
fix(deepagents): include core deps for lint env
sipercai d270136
fix(vertexai): remove stale pyright ignores
sipercai 0ae1399
fix(deepagents): align python version matrix
sipercai 8c70103
fix(deepagents): align bootstrap pin version
sipercai 8aa32ec
fix(deepagents): capture root agent input messages
sipercai 66ac6cd
style(deepagents): apply ruff formatting
sipercai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
instrumentation-loongsuite/loongsuite-instrumentation-deepagents/CHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## Unreleased | ||
|
|
||
| ### Added | ||
|
|
||
| - Initial DeepAgents instrumentation that marks `create_deep_agent` graphs so | ||
| LangChain instrumentation emits an `AGENT` span for the DeepAgents root. | ||
| - DeepAgents skill-load telemetry: when an agent reads a registered skill's | ||
| top-level `SKILL.md` through the built-in `read_file` tool, the tool span | ||
| carries `gen_ai.skill.name`, `gen_ai.skill.id`, | ||
| `gen_ai.skill.description`, and `gen_ai.skill.version`. | ||
|
|
||
| ## Version 0.6.0 (2026-06-03) | ||
|
|
||
| There are no changelog entries for this release. |
56 changes: 56 additions & 0 deletions
56
instrumentation-loongsuite/loongsuite-instrumentation-deepagents/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # LoongSuite DeepAgents Instrumentation | ||
|
|
||
| LoongSuite instrumentation for [DeepAgents](https://github.com/langchain-ai/deepagents). | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| pip install loongsuite-instrumentation-deepagents | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```python | ||
| from opentelemetry.instrumentation.deepagents import DeepAgentsInstrumentor | ||
|
|
||
| DeepAgentsInstrumentor().instrument() | ||
|
|
||
| from deepagents import create_deep_agent | ||
| ``` | ||
|
|
||
| When instrumenting manually, call `DeepAgentsInstrumentor().instrument()` before | ||
| importing or binding `deepagents.create_deep_agent`. Auto-instrumentation runs | ||
| before application imports and does not need this extra ordering step. | ||
|
|
||
| ## What it does | ||
|
|
||
| This instrumentation patches `deepagents.graph.create_deep_agent` so the final | ||
| graph returned by DeepAgents is marked with `_loongsuite_react_agent = True`. | ||
| It also marks the graph as a DeepAgents agent and injects the same flags into | ||
| call-time `RunnableConfig` metadata for `invoke`, `ainvoke`, `stream`, and | ||
| `astream`. | ||
|
|
||
| The marker is consumed by `loongsuite-instrumentation-langchain`, which routes | ||
| the DeepAgents root graph span as an `AGENT` span instead of a generic `CHAIN` | ||
| span. | ||
|
|
||
| The LangChain tracer also maps each DeepAgents `model` decision node to a | ||
| `react step` span. Multi-round tool flows end the previous step with | ||
| `gen_ai.react.finish_reason = "tool_calls"` and the final step with `"stop"`. | ||
| This package intentionally does not create separate ENTRY spans or GenAI | ||
| metrics. | ||
|
|
||
| For DeepAgents skills, the framework first loads skill metadata through | ||
| `SkillsMiddleware.before_agent` and exposes the available skills in the system | ||
| prompt. Loading the full skill instructions happens when the agent calls the | ||
| built-in filesystem tool to read the skill file, for example | ||
| `read_file(file_path="/skills/foo/SKILL.md")`. That `execute_tool read_file` | ||
| span is annotated with `gen_ai.skill.name`, `gen_ai.skill.id`, | ||
| `gen_ai.skill.description`, and `gen_ai.skill.version` when the file path | ||
| matches a registered top-level `SKILL.md`. Reading helper files under the same | ||
| skill directory is recorded as a normal file read, not as a skill load. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| - `deepagents >= 0.6.0, < 0.7.0` | ||
| - Python 3.11+ |
56 changes: 56 additions & 0 deletions
56
instrumentation-loongsuite/loongsuite-instrumentation-deepagents/pyproject.toml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| [build-system] | ||
| requires = ["hatchling"] | ||
| build-backend = "hatchling.build" | ||
|
|
||
| [project] | ||
| name = "loongsuite-instrumentation-deepagents" | ||
| dynamic = ["version"] | ||
| description = "LoongSuite DeepAgents Instrumentation" | ||
| readme = "README.md" | ||
| license = "Apache-2.0" | ||
| requires-python = ">=3.11" | ||
| authors = [ | ||
| { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" }, | ||
| ] | ||
| classifiers = [ | ||
| "Development Status :: 4 - Beta", | ||
| "Intended Audience :: Developers", | ||
| "License :: OSI Approved :: Apache Software License", | ||
| "Programming Language :: Python", | ||
| "Programming Language :: Python :: 3", | ||
| "Programming Language :: Python :: 3.11", | ||
| "Programming Language :: Python :: 3.12", | ||
| "Programming Language :: Python :: 3.13", | ||
| ] | ||
| dependencies = [ | ||
| "loongsuite-instrumentation-langchain", | ||
| "loongsuite-instrumentation-langgraph", | ||
| "opentelemetry-api ~= 1.37", | ||
| "opentelemetry-instrumentation >= 0.58b0", | ||
| "opentelemetry-semantic-conventions >= 0.58b0", | ||
| "wrapt >= 1.0.0, < 2.0.0", | ||
| ] | ||
|
|
||
| [project.optional-dependencies] | ||
| instruments = [ | ||
| "deepagents >= 0.6.0, < 0.7.0", | ||
| ] | ||
|
|
||
| [project.entry-points.opentelemetry_instrumentor] | ||
| deepagents = "opentelemetry.instrumentation.deepagents:DeepAgentsInstrumentor" | ||
|
|
||
| [project.urls] | ||
| Homepage = "https://github.com/alibaba/loongsuite-python-agent/tree/main/instrumentation-loongsuite/loongsuite-instrumentation-deepagents" | ||
| Repository = "https://github.com/alibaba/loongsuite-python-agent" | ||
|
|
||
| [tool.hatch.version] | ||
| path = "src/opentelemetry/instrumentation/deepagents/version.py" | ||
|
|
||
| [tool.hatch.build.targets.sdist] | ||
| include = [ | ||
| "src", | ||
| "tests", | ||
| ] | ||
|
|
||
| [tool.hatch.build.targets.wheel] | ||
| packages = ["src/opentelemetry"] | ||
110 changes: 110 additions & 0 deletions
110
...suite-instrumentation-deepagents/src/opentelemetry/instrumentation/deepagents/__init__.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| # Copyright The OpenTelemetry 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. | ||
|
|
||
| """LoongSuite instrumentation for langchain-ai DeepAgents.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import importlib | ||
| import logging | ||
| from typing import Any, Collection | ||
|
|
||
| from opentelemetry.instrumentation.deepagents.internal.patch import ( | ||
| instrument_create_deep_agent, | ||
| uninstrument_create_deep_agent, | ||
| ) | ||
| from opentelemetry.instrumentation.deepagents.package import _instruments | ||
| from opentelemetry.instrumentation.instrumentor import BaseInstrumentor | ||
|
|
||
| __all__ = ["DeepAgentsInstrumentor"] | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def _instrument_dependency( | ||
| module_name: str, | ||
| class_name: str, | ||
| **kwargs: Any, | ||
| ) -> BaseInstrumentor | None: | ||
| try: | ||
| module = importlib.import_module(module_name) | ||
| except ModuleNotFoundError as exc: | ||
| if exc.name == module_name or ( | ||
| exc.name is not None and module_name.startswith(f"{exc.name}.") | ||
| ): | ||
| logger.warning( | ||
| "deepagents instrumentation requires %s; continuing without it.", | ||
| module_name, | ||
| ) | ||
| return None | ||
| raise | ||
|
|
||
| instrumentor_type = getattr(module, class_name, None) | ||
| if instrumentor_type is None: | ||
| logger.warning( | ||
| "deepagents instrumentation could not find %s.%s", | ||
| module_name, | ||
| class_name, | ||
| ) | ||
| return None | ||
|
|
||
| instrumentor = instrumentor_type() | ||
| if instrumentor.is_instrumented_by_opentelemetry: | ||
| return None | ||
| instrumentor.instrument(**kwargs) | ||
| if instrumentor.is_instrumented_by_opentelemetry: | ||
| return instrumentor | ||
| return None | ||
|
|
||
|
|
||
| class DeepAgentsInstrumentor(BaseInstrumentor): | ||
| """Instrument DeepAgents root graphs as LangChain agent spans.""" | ||
|
|
||
| def instrumentation_dependencies(self) -> Collection[str]: | ||
| return _instruments | ||
|
|
||
| def _instrument(self, **kwargs: Any) -> None: | ||
| self._dependency_instrumentors = [] | ||
| langchain_instrumentor = _instrument_dependency( | ||
| "opentelemetry.instrumentation.langchain", | ||
| "LangChainInstrumentor", | ||
| **kwargs, | ||
| ) | ||
| if langchain_instrumentor is not None: | ||
| self._dependency_instrumentors.append(langchain_instrumentor) | ||
|
|
||
| langgraph_instrumentor = _instrument_dependency( | ||
| "opentelemetry.instrumentation.langgraph", | ||
| "LangGraphInstrumentor", | ||
| **kwargs, | ||
| ) | ||
| if langgraph_instrumentor is not None: | ||
| self._dependency_instrumentors.append(langgraph_instrumentor) | ||
|
|
||
| instrument_create_deep_agent() | ||
|
|
||
| def _uninstrument(self, **kwargs: Any) -> None: | ||
| uninstrument_create_deep_agent() | ||
| for instrumentor in reversed( | ||
| getattr(self, "_dependency_instrumentors", []) | ||
| ): | ||
| try: | ||
| instrumentor.uninstrument() | ||
| except Exception as exc: # noqa: BLE001 | ||
| logger.debug( | ||
| "Failed to uninstrument deepagents dependency %s: %s", | ||
| instrumentor.__class__.__name__, | ||
| exc, | ||
| ) | ||
| self._dependency_instrumentors = [] |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.