🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
feat: Add traceroot example and make traceroot as an observe decorator (#2794)
Zecheng Zhangff509a570f5a
diff --git a/camel/agents/chat_agent.py b/camel/agents/chat_agent.pyindex 4ff43894b..9d879ae56 100644--- a/camel/agents/chat_agent.py+++ b/camel/agents/chat_agent.py@@ -50,6 +50,7 @@ from camel.agents._utils import (safe_model_dump,)from camel.agents.base import BaseAgent+from camel.logger import get_loggerfrom camel.memories import (AgentMemory,ChatHistoryMemory,@@ -90,7 +91,7 @@ from camel.utils.tool_result import ToolResultif TYPE_CHECKING:from camel.terminators import ResponseTerminator-logger = logging.getLogger(__name__)+logger = get_logger(__name__)# AgentOps decorator settingtry:@@ -109,6 +110,11 @@ if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":from langfuse.decorators import observeexcept ImportError:from camel.utils import observe+elif os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":+ try:+ from traceroot import trace as observe # type: ignore[import]+ except ImportError:+ from camel.utils import observeelse:from camel.utils import observe@@ -1222,9 +1228,8 @@ class ChatAgent(BaseAgent):):while not self.pause_event.is_set():time.sleep(0.001)- tool_call_records.append(- self._execute_tool(tool_call_request)- )+ result = self._execute_tool(tool_call_request)+ tool_call_records.append(result)# If we found external tool calls, break the loopif external_tool_call_requests:diff --git a/camel/logger.py b/camel/logger.pyindex b901235ff..71337b844 100644--- a/camel/logger.py+++ b/camel/logger.py@@ -155,7 +155,7 @@ def set_log_level(level):_logger.debug(f"Logging level set to: {logging.getLevelName(level)}")-def get_logger(name):+def get_logger(name: str):r"""Get a logger with the specified name, prefixed with 'camel.'.diff --git a/camel/models/azure_openai_model.py b/camel/models/azure_openai_model.pyindex 34dc9b447..f661d98f5 100644--- a/camel/models/azure_openai_model.py+++ b/camel/models/azure_openai_model.py@@ -41,6 +41,11 @@ if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":from langfuse.decorators import observeexcept ImportError:from camel.utils import observe+elif os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":+ try:+ from traceroot import trace as observe # type: ignore[import]+ except ImportError:+ from camel.utils import observeelse:from camel.utils import observediff --git a/camel/models/deepseek_model.py b/camel/models/deepseek_model.pyindex c10b1d4d1..185223ca4 100644--- a/camel/models/deepseek_model.py+++ b/camel/models/deepseek_model.py@@ -40,6 +40,11 @@ if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":from langfuse.decorators import observeexcept ImportError:from camel.utils import observe+elif os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":+ try:+ from traceroot import trace as observe # type: ignore[import]+ except ImportError:+ from camel.utils import observeelse:from camel.utils import observediff --git a/camel/models/gemini_model.py b/camel/models/gemini_model.pyindex 765824047..d4b4590ab 100644--- a/camel/models/gemini_model.py+++ b/camel/models/gemini_model.py@@ -37,6 +37,11 @@ if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":from langfuse.decorators import observeexcept ImportError:from camel.utils import observe+elif os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":+ try:+ from traceroot import trace as observe # type: ignore[import]+ except ImportError:+ from camel.utils import observeelse:from camel.utils import observediff --git a/camel/models/openai_compatible_model.py b/camel/models/openai_compatible_model.pyindex f89d4ff73..ed4fe7e0f 100644--- a/camel/models/openai_compatible_model.py+++ b/camel/models/openai_compatible_model.py@@ -41,6 +41,11 @@ if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":from langfuse.decorators import observeexcept ImportError:from camel.utils import observe+elif os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":+ try:+ from traceroot import trace as observe # type: ignore[import]+ except ImportError:+ from camel.utils import observeelse:from camel.utils import observediff --git a/camel/models/openai_model.py b/camel/models/openai_model.pyindex bd9dfd72d..009d591f3 100644--- a/camel/models/openai_model.py+++ b/camel/models/openai_model.py@@ -40,6 +40,11 @@ if os.environ.get("LANGFUSE_ENABLED", "False").lower() == "true":from langfuse.decorators import observeexcept ImportError:from camel.utils import observe+elif os.environ.get("TRACEROOT_ENABLED", "False").lower() == "true":+ try:+ from traceroot import trace as observe # type: ignore[import]+ except ImportError:+ from camel.utils import observeelse:from camel.utils import observediff --git a/examples/debug/.traceroot-config.yaml b/examples/debug/.traceroot-config.yamlnew file mode 100644index 000000000..4b1f2dfb9--- /dev/null+++ b/examples/debug/.traceroot-config.yaml@@ -0,0 +1,5 @@+name: "camel-example"+service_name: "camel-example"+github_owner: "camel-ai"+github_repo_name: "camel"+github_commit_hash: "master"\ No newline at end of filediff --git a/examples/debug/README_traceroot.md b/examples/debug/README_traceroot.mdnew file mode 100644index 000000000..670445106--- /dev/null+++ b/examples/debug/README_traceroot.md@@ -0,0 +1,43 @@+# TraceRoot Usage Guide++TraceRoot is an open-source LLM debugging platform that correlates logging and tracing. This guide covers how to use TraceRoot with the CAMEL project.+++## Table of Contents++- [Quick Start](#quick-start)+- [Environment Configuration](#environment-configuration)+- [Self-Hosted Deployment](#self-hosted-deployment)+- [Related Links](#related-links)++## Quick Start++### 1. Install Dependencies++```bash+uv pip install ".[dev_tools]"+```++### 2. Environment Variables Configuration++Before using TraceRoot, set the following environment variables:++```bash+# Enable TraceRoot for debugging+export TRACEROOT_ENABLED="true"+python camel/examples/debug/traceroot_example.py+```++Some of the configuration options specified in the `.traceroot-config.yaml` file.++And then if you import `import traceroot` in your Python code, the traceroot functionality will be automatically enabled.++### 3. Self-Hosted Deployment++And for now you need to [reach out to us](https://traceroot.ai/) to get necessary details for the TraceRoot setup. The open source version will be available soon.+++## Related Links++- [TraceRoot Documentation](https://docs.traceroot.ai/)+- [TraceRoot LinkedIn](https://www.linkedin.com/company/traceroot-ai)diff --git a/examples/debug/traceroot_example.py b/examples/debug/traceroot_example.pynew file mode 100644index 000000000..80b3692cb--- /dev/null+++ b/examples/debug/traceroot_example.py@@ -0,0 +1,61 @@+#!/usr/bin/env python3+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========+# 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.+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========++"""+Preparation before running:+1. Set environment variables:+ - TRACEROOT_ENABLED="true" # Enable debugging++Note:+- Debugging and tracing will only be enabled if TRACEROOT_ENABLED=true+"""++import traceroot++from camel.agents import ChatAgent+from camel.models import ModelFactory+from camel.toolkits import MathToolkit+from camel.types import ModelPlatformType, ModelType++logger = traceroot.get_logger('camel')+++def main():+ math_toolkit = [*MathToolkit().get_tools()]++ model = ModelFactory.create(+ model_platform=ModelPlatformType.DEFAULT,+ model_type=ModelType.DEFAULT,+ )++ # Define system message+ sys_msg = "You are a helpful AI assistant, skilled at answering questions."+ logger.info("System message: %s", sys_msg)++ # Create agent+ camel_agent = ChatAgent(+ system_message=sys_msg, model=model, tools=math_toolkit+ )++ user_msg = "Calculate the square root after adding 222991 and 1111"+ logger.info("User message: %s", user_msg)++ response = camel_agent.step(user_msg)+ logger.info("Agent response: %s", response.msgs[0].content)+++if __name__ == "__main__":+ main()diff --git a/pyproject.toml b/pyproject.tomlindex b4b48d74f..3c67881d2 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -180,6 +180,7 @@ dev_tools = ["daytona-sdk==0.20.0","aci-sdk>=1.0.0b1","langfuse>=2.60.5",+ "traceroot==0.0.3a2",]model_platforms = ["litellm>=1.38.1,<2",@@ -390,6 +391,7 @@ all = ["pgvector>=0.2.4,<0.3","chromadb>=0.6.0,<1.0.0","pymupdf>=1.26.1",+ "traceroot==0.0.3a2",][project.urls]diff --git a/test/toolkits/test_hybrid_browser_toolkit.py b/test/toolkits/test_hybrid_browser_toolkit.pyindex d517807ac..4f290e01e 100644--- a/test/toolkits/test_hybrid_browser_toolkit.py+++ b/test/toolkits/test_hybrid_browser_toolkit.py@@ -1124,7 +1124,8 @@ class TestHybridBrowserToolkit:tools = toolkit.get_tools()- # Default tools should be 6 tools+ # Default tools should be 6 tools (updated default configuration)+assert len(tools) == 6tool_names = [tool.func.__name__ for tool in tools]diff --git a/uv.lock b/uv.lockindex e8f27d986..4c9e4f8df 100644--- a/uv.lock+++ b/uv.lock@@ -591,18 +591,32 @@ wheels = [{ url = "https://files.pythonhosted.org/packages/10/cb/f2ad4230dc2eb1a74edf38f1a38b9b52277f75bef262d8908e60d957e13c/blinker-1.9.0-py3-none-any.whl", hash = "sha256:ba0efaa9080b619ff2f3459d1d500c57bddea4a6b424b60a91141db6fd2f08bc", size = 8458, upload-time = "2024-11-08T17:25:46.184Z" },]+[[package]]+name = "boto3"+version = "1.39.3"+source = { registry = "https://pypi.org/simple" }+dependencies = [+ { name = "botocore" },+ { name = "jmespath" },+ { name = "s3transfer" },+]+sdist = { url = "https://files.pythonhosted.org/packages/02/42/712a74bb86d06538c55067a35b8a82c57aa303eba95b2b1ee91c829288f4/boto3-1.39.3.tar.gz", hash = "sha256:0a367106497649ae3d8a7b571b8c3be01b7b935a0fe303d4cc2574ed03aecbb4", size = 111838, upload-time = "2025-07-03T19:26:00.988Z" }+wheels = [+ { url = "https://files.pythonhosted.org/packages/15/70/723d2ab259aeaed6c96e5c1857ebe7d474ed9aa8f487dea352c60f33798f/boto3-1.39.3-py3-none-any.whl", hash = "sha256:056cfa2440fe1a157a7c2be897c749c83e1a322144aa4dad889f2fca66571019", size = 139906, upload-time = "2025-07-03T19:25:58.803Z" },+]+[[package]]name = "botocore"-version = "1.37.3"+version = "1.39.3"source = { registry = "https://pypi.org/simple" }dependencies = [{ name = "jmespath" },{ name = "python-dateutil" },{ name = "urllib3" },]-sdist = { url = "https://files.pythonhosted.org/packages/74/fb/b243ab806d2e1e6b8a475b731cc59a1f1e4709eded4884b988a27bbc996b/botocore-1.37.3.tar.gz", hash = "sha256:fe8403eb55a88faf9b0f9da6615e5bee7be056d75e17af66c3c8f0a3b0648da4", size = 13574648, upload-time = "2025-02-27T20:27:59.559Z" }+sdist = { url = "https://files.pythonhosted.org/packages/60/66/96e89cc261d75f0b8125436272c335c74d2a39df84504a0c3956adcd1301/botocore-1.39.3.tar.gz", hash = "sha256:da8f477e119f9f8a3aaa8b3c99d9c6856ed0a243680aa3a3fbbfc15a8d4093fb", size = 14132316, upload-time = "2025-07-03T19:25:49.502Z" }wheels = [- { url = "https://files.pythonhosted.org/packages/88/54/772118f15b5990173aa5264946cc8c9ff70c8f02d72ee6d63167a985188c/botocore-1.37.3-py3-none-any.whl", hash = "sha256:d01bd3bf4c80e61fa88d636ad9f5c9f60a551d71549b481386c6b4efe0bb2b2e", size = 13342066, upload-time = "2025-02-27T20:27:53.137Z" },+ { url = "https://files.pythonhosted.org/packages/53/e4/3698dbb037a44d82a501577c6e3824c19f4289f4afbcadb06793866250d8/botocore-1.39.3-py3-none-any.whl", hash = "sha256:66a81cfac18ad5e9f47696c73fdf44cdbd8f8ca51ab3fca1effca0aabf61f02f", size = 13791724, upload-time = "2025-07-03T19:25:44.026Z" },][[package]]@@ -755,6 +769,7 @@ all = [{ name = "tabulate" },{ name = "tavily-python" },{ name = "textblob" },+ { name = "traceroot" },{ name = "transformers" },{ name = "tree-sitter" },{ name = "tree-sitter-python" },@@ -823,6 +838,7 @@ dev-tools = [{ name = "jupyter-client" },{ name = "langfuse" },{ name = "mcp" },+ { name = "traceroot" },{ name = "tree-sitter" },{ name = "tree-sitter-python" },{ name = "typer" },@@ -1282,6 +1298,8 @@ requires-dist = [{ name = "textblob", marker = "extra == 'data-tools'", specifier = ">=0.17.1,<0.18" },{ name = "tiktoken", specifier = ">=0.7.0,<0.8" },{ name = "toml", marker = "extra == 'dev'", specifier = ">=0.10.2" },+ { name = "traceroot", marker = "extra == 'all'", specifier = "==0.0.3a2" },+ { name = "traceroot", marker = "extra == 'dev-tools'", specifier = "==0.0.3a2" },{ name = "transformers", marker = "extra == 'all'", specifier = ">=4,<5" },{ name = "transformers", marker = "extra == 'huggingface'", specifier = ">=4,<5" },{ name = "transformers", marker = "extra == 'owl'", specifier = ">=4,<5" },@@ -4870,6 +4888,18 @@ wheels = [{ url = "https://files.pythonhosted.org/packages/84/6e/d608a9336ede3d15869c70ebdd4ec670f774641104b0873bb973bce9d822/opentelemetry_instrumentation_fastapi-0.55b1-py3-none-any.whl", hash = "sha256:af4c09aebb0bd6b4a0881483b175e76547d2bc96329c94abfb794bf44f29f6bb", size = 12713, upload-time = "2025-06-10T08:57:39.712Z" },]+[[package]]+name = "opentelemetry-propagator-aws-xray"+version = "1.0.2"+source = { registry = "https://pypi.org/simple" }+dependencies = [+ { name = "opentelemetry-api" },+]+sdist = { url = "https://files.pythonhosted.org/packages/f4/31/40004e9e55b1e5694ef3a7526f0b7637df44196fc68a8b7d248a3684680f/opentelemetry_propagator_aws_xray-1.0.2.tar.gz", hash = "sha256:6b2cee5479d2ef0172307b66ed2ed151f598a0fd29b3c01133ac87ca06326260", size = 10994, upload-time = "2024-08-05T17:45:57.601Z" }+wheels = [+ { url = "https://files.pythonhosted.org/packages/ea/89/849a0847871fd9745315896ad9e23d6479db84d90b8b36c4c26dc46e92b8/opentelemetry_propagator_aws_xray-1.0.2-py3-none-any.whl", hash = "sha256:1c99181ee228e99bddb638a0c911a297fa21f1c3a0af951f841e79919b5f1934", size = 10856, upload-time = "2024-08-05T17:45:56.492Z" },+]+[[package]]name = "opentelemetry-proto"version = "1.34.1"@@ -4896,6 +4926,18 @@ wheels = [{ url = "https://files.pythonhosted.org/packages/07/1b/def4fe6aa73f483cabf4c748f4c25070d5f7604dcc8b52e962983491b29e/opentelemetry_sdk-1.34.1-py3-none-any.whl", hash = "sha256:308effad4059562f1d92163c61c8141df649da24ce361827812c40abb2a1e96e", size = 118477, upload-time = "2025-06-10T08:55:16.02Z" },]+[[package]]+name = "opentelemetry-sdk-extension-aws"+version = "2.1.0"+source = { registry = "https://pypi.org/simple" }+dependencies = [+ { name = "opentelemetry-sdk" },+]+sdist = { url = "https://files.pythonhosted.org/packages/f5/b3/825c93fe4c238845f1356297abea33d03b2adaafb5ae98fc257b394de124/opentelemetry_sdk_extension_aws-2.1.0.tar.gz", hash = "sha256:ff68ddecc1910f62c019d22ec0f7461713ead7f662d6a2304d4089c1a0b20416", size = 16334, upload-time = "2024-12-24T15:01:57.387Z" }+wheels = [+ { url = "https://files.pythonhosted.org/packages/02/61/47a6a43b7935d54b5734fbf3fb0357dd5a7d0dfaa9677b7318518fe8d507/opentelemetry_sdk_extension_aws-2.1.0-py3-none-any.whl", hash = "sha256:c7cf6efc275d2c24108a468d954287ce5aab9733bac816a080cfb3117374e63a", size = 18776, upload-time = "2024-12-24T15:01:56.053Z" },+]+[[package]]name = "opentelemetry-semantic-conventions"version = "0.55b1"@@ -6841,6 +6883,18 @@ wheels = [{ url = "https://files.pythonhosted.org/packages/aa/70/f8724f31abc0b329ca98b33d73c14020168babcf71b0cba3cded5d9d0e66/ruff-0.7.4-py3-none-win_arm64.whl", hash = "sha256:11bff065102c3ae9d3ea4dc9ecdfe5a5171349cdd0787c1fc64761212fc9cf1f", size = 8851590, upload-time = "2024-11-15T11:33:09.664Z" },]+[[package]]+name = "s3transfer"+version = "0.13.0"+source = { registry = "https://pypi.org/simple" }+dependencies = [+ { name = "botocore" },+]+sdist = { url = "https://files.pythonhosted.org/packages/ed/5d/9dcc100abc6711e8247af5aa561fc07c4a046f72f659c3adea9a449e191a/s3transfer-0.13.0.tar.gz", hash = "sha256:f5e6db74eb7776a37208001113ea7aa97695368242b364d73e91c981ac522177", size = 150232, upload-time = "2025-05-22T19:24:50.245Z" }+wheels = [+ { url = "https://files.pythonhosted.org/packages/18/17/22bf8155aa0ea2305eefa3a6402e040df7ebe512d1310165eda1e233c3f8/s3transfer-0.13.0-py3-none-any.whl", hash = "sha256:0148ef34d6dd964d0d8cf4311b2b21c474693e57c2e069ec708ce043d2b527be", size = 85152, upload-time = "2025-05-22T19:24:48.703Z" },+]+[[package]]name = "safetensors"version = "0.5.3"@@ -7735,6 +7789,34 @@ wheels = [{ url = "https://files.pythonhosted.org/packages/d0/30/dc54f88dd4a2b5dc8a0279bdd7270e735851848b762aeb1c1184ed1f6b14/tqdm-4.67.1-py3-none-any.whl", hash = "sha256:26445eca388f82e72884e0d580d5464cd801a3ea01e63e5601bdff9ba6a48de2", size = 78540, upload-time = "2024-11-24T20:12:19.698Z" },]+[[package]]+name = "traceroot"+version = "0.0.3a2"+source = { registry = "https://pypi.org/simple" }+dependencies = [+ { name = "opentelemetry-api" },+ { name = "opentelemetry-exporter-otlp" },+ { name = "opentelemetry-exporter-otlp-proto-common" },+ { name = "opentelemetry-exporter-otlp-proto-grpc" },+ { name = "opentelemetry-exporter-otlp-proto-http" },+ { name = "opentelemetry-instrumentation" },+ { name = "opentelemetry-instrumentation-asgi" },+ { name = "opentelemetry-instrumentation-fastapi" },+ { name = "opentelemetry-propagator-aws-xray" },+ { name = "opentelemetry-proto" },+ { name = "opentelemetry-sdk" },+ { name = "opentelemetry-sdk-extension-aws" },+ { name = "opentelemetry-semantic-conventions" },+ { name = "opentelemetry-util-http" },+ { name = "pandas" },+ { name = "pyyaml" },+ { name = "watchtower" },+]+sdist = { url = "https://files.pythonhosted.org/packages/f9/74/82c170b264cefbda3f4dc3cfccc13649361bbfca00a6a2ad15ab92637544/traceroot-0.0.3a2.tar.gz", hash = "sha256:ca9ec30682ff9b8c57029a555cc8e6e33f3f5fca7999b10111aeb8b4bdbfd577", size = 14933, upload-time = "2025-07-04T19:26:12.04Z" }+wheels = [+ { url = "https://files.pythonhosted.org/packages/bd/d0/5e1ff3da0c0eeb0e540fd10de87d2c038ef571cb427942359fe69d6bf314/traceroot-0.0.3a2-py3-none-any.whl", hash = "sha256:d9321b7165ff5cd2532640fa650d14088e92b64635d1bb6dfe39efd7bd4f94b8", size = 12312, upload-time = "2025-07-04T19:26:10.769Z" },+]+[[package]]name = "traitlets"version = "5.14.3"@@ -8266,6 +8348,18 @@ wheels = [{ url = "https://files.pythonhosted.org/packages/bd/d3/254cea30f918f489db09d6a8435a7de7047f8cb68584477a515f160541d6/watchfiles-1.1.0-pp311-pypy311_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:923fec6e5461c42bd7e3fd5ec37492c6f3468be0499bc0707b4bbbc16ac21792", size = 454009, upload-time = "2025-06-15T19:06:52.896Z" },]+[[package]]+name = "watchtower"+version = "3.4.0"+source = { registry = "https://pypi.org/simple" }+dependencies = [+ { name = "boto3" },+]+sdist = { url = "https://files.pythonhosted.org/packages/f6/e1/40e6940383b7202e7c12343ab58c4a0acd5552217d829a4f0ed19cd9cf0b/watchtower-3.4.0.tar.gz", hash = "sha256:7d3c116aff72a73ce8f6fc0addd1d0daa04d3f9d53d87cedca3a5a65a264bf7d", size = 27128, upload-time = "2025-02-25T15:07:05.374Z" }+wheels = [+ { url = "https://files.pythonhosted.org/packages/35/ac/7caa56d4cf82e66b5cdc46d7fa6edd0d4bcd407ec33e46f28a8be83cca28/watchtower-3.4.0-py3-none-any.whl", hash = "sha256:5eac65cbf2a7350bb43c3518485230a6135ed7dec7ccb88468828d68ab9fea26", size = 18022, upload-time = "2025-02-25T15:07:02.851Z" },+]+[[package]]name = "wcwidth"version = "0.2.13"