<div align="center">
<a href="https://traceroot.ai/">
<img src="misc/images/traceroot_logo.png" alt="TraceRoot Logo">
</a>
</div>
<div align="center">
[](https://www.producthunt.com/products/traceroot-ai?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_source=badge-traceroot-ai)
[![Testing Status][testing-image]][testing-url]
[![Documentation][docs-image]][docs-url]
[![Discord][discord-image]][discord-url]
[![PyPI Version][pypi-image]][pypi-url]
[![PyPI SDK Downloads][pypi-sdk-downloads-image]][pypi-sdk-downloads-url]
[![npm version][npm-image]][npm-url]
[![TraceRoot.AI Website][company-website-image]][company-website-url]
[![X][zecheng-x-image]][zecheng-x-url]
[![X][xinwei-x-image]][xinwei-x-url]
[![Y Combinator][y-combinator-image]][y-combinator-url]
</div>
**TraceRoot** helps engineers debug production issues **10× faster** using AI-powered analysis of traces, logs, and code context.
- Visit the [TraceRoot website](https://traceroot.ai) to start debugging your production issues.
- Explore the [TraceRoot documentation](https://docs.traceroot.ai) to get started with the TraceRoot library.
- Join our [Discord community](https://discord.gg/tPyffEZvvJ) to learn more and discuss on AI Agent for observability, debugging, tracing and root cause analysis.
## About
TraceRoot accelerates the debugging process with AI-powered insights. It integrates seamlessly into your development workflow, providing real-time trace and log analysis, code context understanding, and intelligent assistance.
## Demo
<div align="center">
<img src="misc/images/product_git_v1.gif" alt="TraceRoot Demo" width="100%">
</div>
## Features
| Feature | Description |
| ------------------------------------------------- | ----------------------------------------------------------------------------- |
| 🚀 [Ease of Use](#getting-started-with-traceroot) | Get started with TraceRoot in minutes with our simple setup process |
| 🤖 LLM Flexibility | Bring your own model (OpenAI, Anthropic, local LLMs) for AI-powered debugging |
| 🌐 Distributed Services | Cross-platform support with distributed setup for enterprise-scale debugging |
| 💻 AI Debugging Interface | Cursor-like interface specialized for debugging with AI assistance |
| 🔌 Integration Support | Native integration with GitHub, Notion, Slack, and other tools |
## Getting started with TraceRoot
### TraceRoot Cloud (Recommended)
The fastest and most reliable way to start with TraceRoot is by signing up for free to [TraceRoot Cloud](https://auth.traceroot.ai/) for a **7-day trial**.
You’ll get:
- **100k** traces + logs storage with **30-day retention**
- **1M** LLM tokens
- AI agent with chat mode
Usually new features will be available in TraceRoot Cloud first, and then they will be released to the self-hosted version.
### Self-hosting TraceRoot (Advanced)
If you want to self-host TraceRoot, you can deploy a starter instance in one line on Linux with Docker:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/traceroot-ai/traceroot/HEAD/bin/deploy-starter)"
```
Open source deployments should scale to a certain point and may not cover all the features, thus we recommend [migrating to TraceRoot Cloud](https://traceroot.ai).
In general the open source version will start the UI at [http://localhost:3000](http://localhost:3000) and the API at [http://localhost:8000](http://localhost:8000).
If you don't want to use Docker, please refer to the [DEVELOPMENT.md](DEVELOPMENT.md) for more details to setup the environment manually.
## Setting up TraceRoot
Whether you're using [TraceRoot Cloud](https://traceroot.ai) or our open source version, it's required to use our SDK:
### Available SDKs
| Language | Repository |
| --------------------- | -------------------------------------------------------------------- |
| Python | [traceroot-sdk](https://github.com/traceroot-ai/traceroot-sdk) |
| JavaScript/TypeScript | [traceroot-sdk-ts](https://github.com/traceroot-ai/traceroot-sdk-ts) |
For more details on SDK usage and examples, please check out this [Quickstart](https://docs.traceroot.ai/quickstart).
## AI Agent Framework
Here is an overview for our AI Agent Framework:
### Context Model
<div align="center">
<a href="https://traceroot.ai/">
<img src="misc/images/context-model.png" alt="Context Model" width="90%" max-width="1200px">
</a>
</div>
### Explainability
Please checkout the [README.md in the `rest/agent` directory](rest/agent/README.md) for more details.
## Citation
If you find our exploratory TraceRoot useful in your research, please consider citing:
```bibtex
@article{traceroot_2025,
title={TraceRoot Is All You Need for Debugging and Tracing},
author={Zecheng Zhang and Xinwei He},
year = {2025},
publisher = {GitHub},
url = {https://github.com/traceroot-ai/traceroot}
}
```
## Contributors
Thanks to all our contributors for helping make TraceRoot better!
<a href="https://github.com/traceroot-ai/traceroot/graphs/contributors">
<img src="https://contrib.rocks/image?repo=traceroot-ai/traceroot" />
</a>
[company-website-image]: https://img.shields.io/badge/website-traceroot.ai-black
[company-website-url]: https://traceroot.ai
[discord-image]: https://img.shields.io/discord/1395844148568920114?logo=discord&labelColor=%235462eb&logoColor=%23f5f5f5&color=%235462eb
[discord-url]: https://discord.gg/tPyffEZvvJ
[docs-image]: https://img.shields.io/badge/docs-traceroot.ai-0dbf43
[docs-url]: https://docs.traceroot.ai
[npm-image]: https://img.shields.io/npm/v/traceroot-sdk-ts?style=flat-square&logo=npm&logoColor=fff
[npm-url]: https://www.npmjs.com/package/traceroot-sdk-ts
[pypi-image]: https://badge.fury.io/py/traceroot.svg
[pypi-sdk-downloads-image]: https://static.pepy.tech/badge/traceroot
[pypi-sdk-downloads-url]: https://pypi.python.org/pypi/traceroot
[pypi-url]: https://pypi.python.org/pypi/traceroot
[testing-image]: https://github.com/traceroot-ai/traceroot/actions/workflows/test.yml/badge.svg
[testing-url]: https://github.com/traceroot-ai/traceroot/actions/workflows/test.yml
[xinwei-x-image]: https://img.shields.io/twitter/follow/xinwei_97?style=social
[xinwei-x-url]: https://x.com/xinwei_97
[y-combinator-image]: https://img.shields.io/badge/Combinator-S25-orange?logo=ycombinator&labelColor=white
[y-combinator-url]: https://www.ycombinator.com/companies/traceroot-ai
[zecheng-x-image]: https://img.shields.io/twitter/follow/zechengzh?style=social
[zecheng-x-url]: https://x.com/zechengzh
Raw data
{
"_id": null,
"home_page": null,
"name": "traceroot-framework",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "opentelemetry, agents, dev, del-tools, artificial-intelligence, tracing, logging, debugging, rest-api, multi-agent-systems, coding, debugging-assistant",
"author": "Zecheng Zhang, Xinwei He",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/22/6c/aaf3a550da751c7fec80182beade852441606ac5fb75880532ccb9cf73cc/traceroot_framework-0.1.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://traceroot.ai/\">\n <img src=\"misc/images/traceroot_logo.png\" alt=\"TraceRoot Logo\">\n </a>\n</div>\n\n<div align=\"center\">\n\n[](https://www.producthunt.com/products/traceroot-ai?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_source=badge-traceroot-ai)\n\n[![Testing Status][testing-image]][testing-url]\n[![Documentation][docs-image]][docs-url]\n[![Discord][discord-image]][discord-url]\n[![PyPI Version][pypi-image]][pypi-url]\n[![PyPI SDK Downloads][pypi-sdk-downloads-image]][pypi-sdk-downloads-url]\n[![npm version][npm-image]][npm-url]\n[![TraceRoot.AI Website][company-website-image]][company-website-url]\n[![X][zecheng-x-image]][zecheng-x-url]\n[![X][xinwei-x-image]][xinwei-x-url]\n[![Y Combinator][y-combinator-image]][y-combinator-url]\n\n</div>\n\n**TraceRoot** helps engineers debug production issues **10\u00d7 faster** using AI-powered analysis of traces, logs, and code context.\n\n- Visit the [TraceRoot website](https://traceroot.ai) to start debugging your production issues.\n- Explore the [TraceRoot documentation](https://docs.traceroot.ai) to get started with the TraceRoot library.\n- Join our [Discord community](https://discord.gg/tPyffEZvvJ) to learn more and discuss on AI Agent for observability, debugging, tracing and root cause analysis.\n\n## About\n\nTraceRoot accelerates the debugging process with AI-powered insights. It integrates seamlessly into your development workflow, providing real-time trace and log analysis, code context understanding, and intelligent assistance.\n\n## Demo\n\n<div align=\"center\">\n <img src=\"misc/images/product_git_v1.gif\" alt=\"TraceRoot Demo\" width=\"100%\">\n</div>\n\n## Features\n\n| Feature | Description |\n| ------------------------------------------------- | ----------------------------------------------------------------------------- |\n| \ud83d\ude80 [Ease of Use](#getting-started-with-traceroot) | Get started with TraceRoot in minutes with our simple setup process |\n| \ud83e\udd16 LLM Flexibility | Bring your own model (OpenAI, Anthropic, local LLMs) for AI-powered debugging |\n| \ud83c\udf10 Distributed Services | Cross-platform support with distributed setup for enterprise-scale debugging |\n| \ud83d\udcbb AI Debugging Interface | Cursor-like interface specialized for debugging with AI assistance |\n| \ud83d\udd0c Integration Support | Native integration with GitHub, Notion, Slack, and other tools |\n\n## Getting started with TraceRoot\n\n### TraceRoot Cloud (Recommended)\n\nThe fastest and most reliable way to start with TraceRoot is by signing up for free to [TraceRoot Cloud](https://auth.traceroot.ai/) for a **7-day trial**.\nYou\u2019ll get:\n\n- **100k** traces + logs storage with **30-day retention**\n- **1M** LLM tokens\n- AI agent with chat mode\n\nUsually new features will be available in TraceRoot Cloud first, and then they will be released to the self-hosted version.\n\n### Self-hosting TraceRoot (Advanced)\n\nIf you want to self-host TraceRoot, you can deploy a starter instance in one line on Linux with Docker:\n\n```bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/traceroot-ai/traceroot/HEAD/bin/deploy-starter)\"\n```\n\nOpen source deployments should scale to a certain point and may not cover all the features, thus we recommend [migrating to TraceRoot Cloud](https://traceroot.ai).\n\nIn general the open source version will start the UI at [http://localhost:3000](http://localhost:3000) and the API at [http://localhost:8000](http://localhost:8000).\n\nIf you don't want to use Docker, please refer to the [DEVELOPMENT.md](DEVELOPMENT.md) for more details to setup the environment manually.\n\n## Setting up TraceRoot\n\nWhether you're using [TraceRoot Cloud](https://traceroot.ai) or our open source version, it's required to use our SDK:\n\n### Available SDKs\n\n| Language | Repository |\n| --------------------- | -------------------------------------------------------------------- |\n| Python | [traceroot-sdk](https://github.com/traceroot-ai/traceroot-sdk) |\n| JavaScript/TypeScript | [traceroot-sdk-ts](https://github.com/traceroot-ai/traceroot-sdk-ts) |\n\nFor more details on SDK usage and examples, please check out this [Quickstart](https://docs.traceroot.ai/quickstart).\n\n## AI Agent Framework\n\nHere is an overview for our AI Agent Framework:\n\n### Context Model\n\n<div align=\"center\">\n <a href=\"https://traceroot.ai/\">\n <img src=\"misc/images/context-model.png\" alt=\"Context Model\" width=\"90%\" max-width=\"1200px\">\n </a>\n</div>\n\n### Explainability\n\nPlease checkout the [README.md in the `rest/agent` directory](rest/agent/README.md) for more details.\n\n## Citation\n\nIf you find our exploratory TraceRoot useful in your research, please consider citing:\n\n```bibtex\n@article{traceroot_2025,\n title={TraceRoot Is All You Need for Debugging and Tracing},\n author={Zecheng Zhang and Xinwei He},\n year = {2025},\n publisher = {GitHub},\n url = {https://github.com/traceroot-ai/traceroot}\n}\n```\n\n## Contributors\n\nThanks to all our contributors for helping make TraceRoot better!\n\n<a href=\"https://github.com/traceroot-ai/traceroot/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=traceroot-ai/traceroot\" />\n</a>\n\n[company-website-image]: https://img.shields.io/badge/website-traceroot.ai-black\n[company-website-url]: https://traceroot.ai\n[discord-image]: https://img.shields.io/discord/1395844148568920114?logo=discord&labelColor=%235462eb&logoColor=%23f5f5f5&color=%235462eb\n[discord-url]: https://discord.gg/tPyffEZvvJ\n[docs-image]: https://img.shields.io/badge/docs-traceroot.ai-0dbf43\n[docs-url]: https://docs.traceroot.ai\n[npm-image]: https://img.shields.io/npm/v/traceroot-sdk-ts?style=flat-square&logo=npm&logoColor=fff\n[npm-url]: https://www.npmjs.com/package/traceroot-sdk-ts\n[pypi-image]: https://badge.fury.io/py/traceroot.svg\n[pypi-sdk-downloads-image]: https://static.pepy.tech/badge/traceroot\n[pypi-sdk-downloads-url]: https://pypi.python.org/pypi/traceroot\n[pypi-url]: https://pypi.python.org/pypi/traceroot\n[testing-image]: https://github.com/traceroot-ai/traceroot/actions/workflows/test.yml/badge.svg\n[testing-url]: https://github.com/traceroot-ai/traceroot/actions/workflows/test.yml\n[xinwei-x-image]: https://img.shields.io/twitter/follow/xinwei_97?style=social\n[xinwei-x-url]: https://x.com/xinwei_97\n[y-combinator-image]: https://img.shields.io/badge/Combinator-S25-orange?logo=ycombinator&labelColor=white\n[y-combinator-url]: https://www.ycombinator.com/companies/traceroot-ai\n[zecheng-x-image]: https://img.shields.io/twitter/follow/zechengzh?style=social\n[zecheng-x-url]: https://x.com/zechengzh\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "TraceRoot - Comprehensive AI-powered tracing, monitoring and REST API solution",
"version": "0.1.1",
"project_urls": {
"Bug Reports": "https://github.com/traceroot-ai/traceroot/issues",
"Documentation": "https://github.com/traceroot-ai/traceroot#readme",
"Homepage": "https://github.com/traceroot-ai/traceroot",
"Repository": "https://github.com/traceroot-ai/traceroot"
},
"split_keywords": [
"opentelemetry",
" agents",
" dev",
" del-tools",
" artificial-intelligence",
" tracing",
" logging",
" debugging",
" rest-api",
" multi-agent-systems",
" coding",
" debugging-assistant"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "19c9576586de3d04983d6e5804c8c15cdd6ff4be7a1f5c3512b1fa53c61492ce",
"md5": "99ccfd497b722d5fb747b74767f85275",
"sha256": "bd5ed3bc655564938e13f1f2991bad35b4934b8ce5b6c266215562477f2b93d6"
},
"downloads": -1,
"filename": "traceroot_framework-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99ccfd497b722d5fb747b74767f85275",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 95608,
"upload_time": "2025-09-07T10:30:52",
"upload_time_iso_8601": "2025-09-07T10:30:52.298600Z",
"url": "https://files.pythonhosted.org/packages/19/c9/576586de3d04983d6e5804c8c15cdd6ff4be7a1f5c3512b1fa53c61492ce/traceroot_framework-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "226caaf3a550da751c7fec80182beade852441606ac5fb75880532ccb9cf73cc",
"md5": "d92060ba8c601982242c50d72f4a0e3c",
"sha256": "5b94b37bbcc07566f7c46c10dc9551496f15b4fcddab2f25283e73d022d582f9"
},
"downloads": -1,
"filename": "traceroot_framework-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d92060ba8c601982242c50d72f4a0e3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 77395,
"upload_time": "2025-09-07T10:30:53",
"upload_time_iso_8601": "2025-09-07T10:30:53.372231Z",
"url": "https://files.pythonhosted.org/packages/22/6c/aaf3a550da751c7fec80182beade852441606ac5fb75880532ccb9cf73cc/traceroot_framework-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-07 10:30:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "traceroot-ai",
"github_project": "traceroot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "traceroot-framework"
}
JSON
