diff --git a/docs/en/observability/neatlogs.mdx b/docs/en/observability/neatlogs.mdx index 24b17cfced..8b3721fdd4 100644 --- a/docs/en/observability/neatlogs.mdx +++ b/docs/en/observability/neatlogs.mdx @@ -1,134 +1,132 @@ --- title: Neatlogs Integration -description: Understand, debug, and share your CrewAI agent runs +description: Collaborative debugging and observability for your CrewAI agents icon: magnifying-glass-chart mode: "wide" --- -# Introduction - -Neatlogs helps you **see what your agent did**, **why**, and **share it**. - -It captures every step: thoughts, tool calls, responses, evaluations. No raw logs. Just clear, structured traces. Great for debugging and collaboration. - -## Why use Neatlogs? - -CrewAI agents use multiple tools and reasoning steps. When something goes wrong, you need context β€” not just errors. - -Neatlogs lets you: - -- Follow the full decision path -- Add feedback directly on steps -- Chat with the trace using AI assistant -- Share runs publicly for feedback -- Turn insights into tasks - -All in one place. - -Manage your traces effortlessly - -![Traces](/images/neatlogs-1.png) -![Trace Response](/images/neatlogs-2.png) - -The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to debug. - -![Trace Details](/images/neatlogs-3.png) -![Ai Chat Bot With A Trace](/images/neatlogs-4.png) -![Comments Drawer](/images/neatlogs-5.png) - -## Core Features - -- **Trace Viewer**: Track thoughts, tools, and decisions in sequence -- **Inline Comments**: Tag teammates on any trace step -- **Feedback & Evaluation**: Mark outputs as correct or incorrect -- **Error Highlighting**: Automatic flagging of API/tool failures -- **Task Conversion**: Convert comments into assigned tasks -- **Ask the Trace (AI)**: Chat with your trace using Neatlogs AI bot -- **Public Sharing**: Publish trace links to your community - -## Quick Setup with CrewAI - - - - Visit [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs), create a project, copy the API key. - - - ```bash - pip install neatlogs - ``` - (Latest version 0.8.0, Python 3.8+; MIT license) - - - Before starting Crew agents, add: - - ```python - import neatlogs - neatlogs.init("YOUR_PROJECT_API_KEY") - ``` - - Agents run as usual. Neatlogs captures everything automatically. - - - - - - -## Under the Hood - -According to GitHub, Neatlogs: - -- Captures thoughts, tool calls, responses, errors, and token stats -- Supports AI-powered task generation and robust evaluation workflows - -All with just two lines of code. - - - -## Watch It Work - -### πŸ” Full Demo (4β€―min) +[Neatlogs](https://neatlogs.com/?utm_source=crewAI-docs) is a collaborative debugging workspace for AI agent teams. It captures every LLM call, tool invocation, token count, and latency and surfaces it all in a shared dashboard your whole team can search, comment on, and act from. +/> -### βš™οΈ CrewAI Integration (30β€―s) +## What is Neatlogs? +{/* ADD YOUTUBE VIDEO HERE - team to provide URL */} +{/* - +/> +*/} + +Agent failures rarely throw exceptions. They produce wrong outputs, miss tool calls, or hallucinate. Neatlogs gives your team the full picture: what the agent decided, why, and where it went wrong. + + + + Follow every thought, tool call, and decision in sequence. Token counts and latency included. + + + Find traces, runs, and patterns in plain English. No query language needed. + + + Tag teammates on any trace step. Threads keep investigation in one place. + + + Mark outputs correct or incorrect. Build eval datasets straight from production traces. + + + Chat with your trace using the built-in AI assistant to surface root causes fast. + + + Publish trace links to your community or stakeholders for async review. + + + +## Quick Setup + + + Go to [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs), create a project, and copy the API key from your dashboard. + + + ```bash + pip install neatlogs + ``` + + + Call `neatlogs.init()` before importing CrewAI so the auto-instrumentation patches land first. -## Links & Support + ```python + import os + import neatlogs -- πŸ“˜ [Neatlogs Docs](https://docs.neatlogs.com/) -- πŸ” [Dashboard & API Key](https://app.neatlogs.com/) -- 🐦 [Follow on Twitter](https://twitter.com/neatlogs) -- πŸ“§ Contact: hello@neatlogs.com -- πŸ›  [GitHub SDK](https://github.com/NeatLogs/neatlogs) + neatlogs.init( + api_key=os.environ["NEATLOGS_API_KEY"], + endpoint=os.environ["NEATLOGS_ENDPOINT"], + workflow_name="my-agent", + instrumentations=["crewai"], + ) + # Now import and run your crew as normal + from crewai import Crew, Agent, Task + ``` + That's it β€” no changes to the rest of your code. + + + Every tool call, agent run, and LLM call is captured and surfaced in your Neatlogs dashboard automatically. Tag teammates and leave comments directly on any trace step β€” no context switching, no Slack threads, no copy-pasting outputs. -## TL;DR + + + + Iterate on prompts without touching production. Neatlogs gives you version control for every prompt in your crew and a playground to test changes side by side β€” so you can improve agent behaviour safely before it goes anywhere near your live system. -With just: + + + + Get agent improvement suggestions and code fixes surfaced straight into Cursor, Codex, Claude Code, and other AI-native editors. Debug and improve your crew without leaving the tools you already work in. -```bash -pip install neatlogs + + + + Bring your team in to review agent outputs, mark runs as correct or incorrect, and build evaluation datasets straight from production traces. Close the loop between what your agents produce and what they should produce. -import neatlogs -neatlogs.init("YOUR_API_KEY") + + + -You can now capture, understand, share, and act on your CrewAI agent runs in seconds. -No setup overhead. Full trace transparency. Full team collaboration. -``` +## Resources + + + + Full SDK reference and integration guides + + + Create a project and get your API key + + + MIT licensed Β· Python 3.8+ + + + hello@neatlogs.com + + diff --git a/docs/images/neatlogs-2.png b/docs/images/neatlogs-2.png index 1dabfbfec3..351a0b696c 100644 Binary files a/docs/images/neatlogs-2.png and b/docs/images/neatlogs-2.png differ diff --git a/docs/images/neatlogs-3.png b/docs/images/neatlogs-3.png index 00b5e66d94..73b0e3827a 100644 Binary files a/docs/images/neatlogs-3.png and b/docs/images/neatlogs-3.png differ diff --git a/docs/images/neatlogs-4.png b/docs/images/neatlogs-4.png index 0640f4b30a..288918ba17 100644 Binary files a/docs/images/neatlogs-4.png and b/docs/images/neatlogs-4.png differ diff --git a/docs/images/neatlogs-codefixes.mp4 b/docs/images/neatlogs-codefixes.mp4 new file mode 100644 index 0000000000..741b480839 Binary files /dev/null and b/docs/images/neatlogs-codefixes.mp4 differ diff --git a/docs/images/neatlogs-evals.mp4 b/docs/images/neatlogs-evals.mp4 new file mode 100644 index 0000000000..ba6553a36e Binary files /dev/null and b/docs/images/neatlogs-evals.mp4 differ diff --git a/docs/images/neatlogs-experiments.mp4 b/docs/images/neatlogs-experiments.mp4 new file mode 100644 index 0000000000..f32333ebed Binary files /dev/null and b/docs/images/neatlogs-experiments.mp4 differ