diff --git a/docs/docs.json b/docs/docs.json index bd4973d91..67b7aa611 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -9,12 +9,7 @@ }, "favicon": "/images/favicon.svg", "contextual": { - "options": [ - "copy", - "view", - "chatgpt", - "claude" - ] + "options": ["copy", "view", "chatgpt", "claude"] }, "navigation": { "languages": [ @@ -55,32 +50,22 @@ "groups": [ { "group": "Get Started", - "pages": [ - "en/introduction", - "en/installation", - "en/quickstart" - ] + "pages": ["en/introduction", "en/installation", "en/quickstart"] }, { "group": "Guides", "pages": [ { "group": "Strategy", - "pages": [ - "en/guides/concepts/evaluating-use-cases" - ] + "pages": ["en/guides/concepts/evaluating-use-cases"] }, { "group": "Agents", - "pages": [ - "en/guides/agents/crafting-effective-agents" - ] + "pages": ["en/guides/agents/crafting-effective-agents"] }, { "group": "Crews", - "pages": [ - "en/guides/crews/first-crew" - ] + "pages": ["en/guides/crews/first-crew"] }, { "group": "Flows", @@ -94,7 +79,6 @@ "pages": [ "en/guides/advanced/customizing-prompts", "en/guides/advanced/fingerprinting" - ] } ] @@ -241,6 +225,7 @@ "en/observability/langtrace", "en/observability/maxim", "en/observability/mlflow", + "en/observability/neatlogs", "en/observability/openlit", "en/observability/opik", "en/observability/patronus-evaluation", @@ -274,9 +259,7 @@ }, { "group": "Telemetry", - "pages": [ - "en/telemetry" - ] + "pages": ["en/telemetry"] } ] }, @@ -285,9 +268,7 @@ "groups": [ { "group": "Getting Started", - "pages": [ - "en/enterprise/introduction" - ] + "pages": ["en/enterprise/introduction"] }, { "group": "Features", @@ -342,9 +323,7 @@ }, { "group": "Resources", - "pages": [ - "en/enterprise/resources/frequently-asked-questions" - ] + "pages": ["en/enterprise/resources/frequently-asked-questions"] } ] }, @@ -353,9 +332,7 @@ "groups": [ { "group": "Getting Started", - "pages": [ - "en/api-reference/introduction" - ] + "pages": ["en/api-reference/introduction"] }, { "group": "Endpoints", @@ -365,16 +342,13 @@ }, { "tab": "Examples", - "groups": [ + "groups": [ { "group": "Examples", - "pages": [ - "en/examples/example" - ] + "pages": ["en/examples/example"] } ] } - ] }, { @@ -425,21 +399,15 @@ "pages": [ { "group": "Estratégia", - "pages": [ - "pt-BR/guides/concepts/evaluating-use-cases" - ] + "pages": ["pt-BR/guides/concepts/evaluating-use-cases"] }, { "group": "Agentes", - "pages": [ - "pt-BR/guides/agents/crafting-effective-agents" - ] + "pages": ["pt-BR/guides/agents/crafting-effective-agents"] }, { "group": "Crews", - "pages": [ - "pt-BR/guides/crews/first-crew" - ] + "pages": ["pt-BR/guides/crews/first-crew"] }, { "group": "Flows", @@ -632,9 +600,7 @@ }, { "group": "Telemetria", - "pages": [ - "pt-BR/telemetry" - ] + "pages": ["pt-BR/telemetry"] } ] }, @@ -643,9 +609,7 @@ "groups": [ { "group": "Começando", - "pages": [ - "pt-BR/enterprise/introduction" - ] + "pages": ["pt-BR/enterprise/introduction"] }, { "group": "Funcionalidades", @@ -710,9 +674,7 @@ "groups": [ { "group": "Começando", - "pages": [ - "pt-BR/api-reference/introduction" - ] + "pages": ["pt-BR/api-reference/introduction"] }, { "group": "Endpoints", @@ -722,16 +684,13 @@ }, { "tab": "Exemplos", - "groups": [ + "groups": [ { "group": "Exemplos", - "pages": [ - "pt-BR/examples/example" - ] + "pages": ["pt-BR/examples/example"] } ] } - ] } ] diff --git a/docs/en/observability/neatlogs.mdx b/docs/en/observability/neatlogs.mdx new file mode 100644 index 000000000..20edd1c9c --- /dev/null +++ b/docs/en/observability/neatlogs.mdx @@ -0,0 +1,140 @@ +--- +title: Neatlogs Integration +description: Understand, debug, and share your CrewAI agent runs +icon: magnifying-glass-chart +--- + +# 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) :contentReference[oaicite:1]{index=1} + + + 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 :contentReference[oaicite:2]{index=2} +- Supports AI-powered task generation and robust evaluation workflows :contentReference[oaicite:3]{index=3} + +All with just two lines of code. + +--- + +## Watch It Work + +### 🔍 Full Demo (4 min) + + + +### ⚙️ CrewAI Integration (30 s) + + + +--- + +## Links & Support + +- 📘 [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) :contentReference[oaicite:4]{index=4} + +--- + +## TL;DR + +With just: + +```bash +pip install neatlogs + +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. +``` diff --git a/docs/images/neatlogs-1.png b/docs/images/neatlogs-1.png new file mode 100644 index 000000000..046beb297 Binary files /dev/null and b/docs/images/neatlogs-1.png differ diff --git a/docs/images/neatlogs-2.png b/docs/images/neatlogs-2.png new file mode 100644 index 000000000..1dabfbfec Binary files /dev/null and b/docs/images/neatlogs-2.png differ diff --git a/docs/images/neatlogs-3.png b/docs/images/neatlogs-3.png new file mode 100644 index 000000000..00b5e66d9 Binary files /dev/null and b/docs/images/neatlogs-3.png differ diff --git a/docs/images/neatlogs-4.png b/docs/images/neatlogs-4.png new file mode 100644 index 000000000..0640f4b30 Binary files /dev/null and b/docs/images/neatlogs-4.png differ diff --git a/docs/images/neatlogs-5.png b/docs/images/neatlogs-5.png new file mode 100644 index 000000000..e199adff4 Binary files /dev/null and b/docs/images/neatlogs-5.png differ