mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
docs: added integration with neatlogs (#3138)
This commit is contained in:
@@ -9,12 +9,7 @@
|
|||||||
},
|
},
|
||||||
"favicon": "/images/favicon.svg",
|
"favicon": "/images/favicon.svg",
|
||||||
"contextual": {
|
"contextual": {
|
||||||
"options": [
|
"options": ["copy", "view", "chatgpt", "claude"]
|
||||||
"copy",
|
|
||||||
"view",
|
|
||||||
"chatgpt",
|
|
||||||
"claude"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"navigation": {
|
"navigation": {
|
||||||
"languages": [
|
"languages": [
|
||||||
@@ -55,32 +50,22 @@
|
|||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Get Started",
|
"group": "Get Started",
|
||||||
"pages": [
|
"pages": ["en/introduction", "en/installation", "en/quickstart"]
|
||||||
"en/introduction",
|
|
||||||
"en/installation",
|
|
||||||
"en/quickstart"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Guides",
|
"group": "Guides",
|
||||||
"pages": [
|
"pages": [
|
||||||
{
|
{
|
||||||
"group": "Strategy",
|
"group": "Strategy",
|
||||||
"pages": [
|
"pages": ["en/guides/concepts/evaluating-use-cases"]
|
||||||
"en/guides/concepts/evaluating-use-cases"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Agents",
|
"group": "Agents",
|
||||||
"pages": [
|
"pages": ["en/guides/agents/crafting-effective-agents"]
|
||||||
"en/guides/agents/crafting-effective-agents"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Crews",
|
"group": "Crews",
|
||||||
"pages": [
|
"pages": ["en/guides/crews/first-crew"]
|
||||||
"en/guides/crews/first-crew"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Flows",
|
"group": "Flows",
|
||||||
@@ -94,7 +79,6 @@
|
|||||||
"pages": [
|
"pages": [
|
||||||
"en/guides/advanced/customizing-prompts",
|
"en/guides/advanced/customizing-prompts",
|
||||||
"en/guides/advanced/fingerprinting"
|
"en/guides/advanced/fingerprinting"
|
||||||
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -241,6 +225,7 @@
|
|||||||
"en/observability/langtrace",
|
"en/observability/langtrace",
|
||||||
"en/observability/maxim",
|
"en/observability/maxim",
|
||||||
"en/observability/mlflow",
|
"en/observability/mlflow",
|
||||||
|
"en/observability/neatlogs",
|
||||||
"en/observability/openlit",
|
"en/observability/openlit",
|
||||||
"en/observability/opik",
|
"en/observability/opik",
|
||||||
"en/observability/patronus-evaluation",
|
"en/observability/patronus-evaluation",
|
||||||
@@ -274,9 +259,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Telemetry",
|
"group": "Telemetry",
|
||||||
"pages": [
|
"pages": ["en/telemetry"]
|
||||||
"en/telemetry"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@@ -285,9 +268,7 @@
|
|||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Getting Started",
|
"group": "Getting Started",
|
||||||
"pages": [
|
"pages": ["en/enterprise/introduction"]
|
||||||
"en/enterprise/introduction"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Features",
|
"group": "Features",
|
||||||
@@ -342,9 +323,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Resources",
|
"group": "Resources",
|
||||||
"pages": [
|
"pages": ["en/enterprise/resources/frequently-asked-questions"]
|
||||||
"en/enterprise/resources/frequently-asked-questions"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@@ -353,9 +332,7 @@
|
|||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Getting Started",
|
"group": "Getting Started",
|
||||||
"pages": [
|
"pages": ["en/api-reference/introduction"]
|
||||||
"en/api-reference/introduction"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Endpoints",
|
"group": "Endpoints",
|
||||||
@@ -365,16 +342,13 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"tab": "Examples",
|
"tab": "Examples",
|
||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Examples",
|
"group": "Examples",
|
||||||
"pages": [
|
"pages": ["en/examples/example"]
|
||||||
"en/examples/example"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -425,21 +399,15 @@
|
|||||||
"pages": [
|
"pages": [
|
||||||
{
|
{
|
||||||
"group": "Estratégia",
|
"group": "Estratégia",
|
||||||
"pages": [
|
"pages": ["pt-BR/guides/concepts/evaluating-use-cases"]
|
||||||
"pt-BR/guides/concepts/evaluating-use-cases"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Agentes",
|
"group": "Agentes",
|
||||||
"pages": [
|
"pages": ["pt-BR/guides/agents/crafting-effective-agents"]
|
||||||
"pt-BR/guides/agents/crafting-effective-agents"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Crews",
|
"group": "Crews",
|
||||||
"pages": [
|
"pages": ["pt-BR/guides/crews/first-crew"]
|
||||||
"pt-BR/guides/crews/first-crew"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Flows",
|
"group": "Flows",
|
||||||
@@ -632,9 +600,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Telemetria",
|
"group": "Telemetria",
|
||||||
"pages": [
|
"pages": ["pt-BR/telemetry"]
|
||||||
"pt-BR/telemetry"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@@ -643,9 +609,7 @@
|
|||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Começando",
|
"group": "Começando",
|
||||||
"pages": [
|
"pages": ["pt-BR/enterprise/introduction"]
|
||||||
"pt-BR/enterprise/introduction"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Funcionalidades",
|
"group": "Funcionalidades",
|
||||||
@@ -710,9 +674,7 @@
|
|||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Começando",
|
"group": "Começando",
|
||||||
"pages": [
|
"pages": ["pt-BR/api-reference/introduction"]
|
||||||
"pt-BR/api-reference/introduction"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Endpoints",
|
"group": "Endpoints",
|
||||||
@@ -722,16 +684,13 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"tab": "Exemplos",
|
"tab": "Exemplos",
|
||||||
"groups": [
|
"groups": [
|
||||||
{
|
{
|
||||||
"group": "Exemplos",
|
"group": "Exemplos",
|
||||||
"pages": [
|
"pages": ["pt-BR/examples/example"]
|
||||||
"pt-BR/examples/example"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
140
docs/en/observability/neatlogs.mdx
Normal file
140
docs/en/observability/neatlogs.mdx
Normal file
@@ -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
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
The best UX to view a CrewAI trace. Post comments anywhere you want. Use AI to debug.
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
<Steps>
|
||||||
|
<Step title="Sign Up & Get API Key">
|
||||||
|
Visit [neatlogs.com](https://neatlogs.com/?utm_source=crewAI-docs), create a project, copy the API key.
|
||||||
|
</Step>
|
||||||
|
<Step title="Install SDK">
|
||||||
|
```bash
|
||||||
|
pip install neatlogs
|
||||||
|
```
|
||||||
|
(Latest version 0.8.0, Python 3.8+; MIT license) :contentReference[oaicite:1]{index=1}
|
||||||
|
</Step>
|
||||||
|
<Step title="Initialize Neatlogs">
|
||||||
|
Before starting Crew agents, add:
|
||||||
|
|
||||||
|
```python
|
||||||
|
import neatlogs
|
||||||
|
neatlogs.init("YOUR_PROJECT_API_KEY")
|
||||||
|
```
|
||||||
|
|
||||||
|
Agents run as usual. Neatlogs captures everything automatically.
|
||||||
|
|
||||||
|
</Step>
|
||||||
|
</Steps>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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)
|
||||||
|
|
||||||
|
<iframe
|
||||||
|
width="100%"
|
||||||
|
height="315"
|
||||||
|
src="https://www.youtube.com/embed/8KDme9T2I7Q?si=b8oHteaBwFNs_Duk"
|
||||||
|
title="YouTube video player"
|
||||||
|
frameBorder="0"
|
||||||
|
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||||
|
allowFullScreen
|
||||||
|
></iframe>
|
||||||
|
|
||||||
|
### ⚙️ CrewAI Integration (30 s)
|
||||||
|
|
||||||
|
<iframe
|
||||||
|
className="w-full aspect-video rounded-xl"
|
||||||
|
src="https://www.loom.com/embed/9c78b552af43452bb3e4783cb8d91230?sid=e9d7d370-a91a-49b0-809e-2f375d9e801d"
|
||||||
|
title="Loom video player"
|
||||||
|
frameBorder="0"
|
||||||
|
allowFullScreen
|
||||||
|
></iframe>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
```
|
||||||
BIN
docs/images/neatlogs-1.png
Normal file
BIN
docs/images/neatlogs-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 222 KiB |
BIN
docs/images/neatlogs-2.png
Normal file
BIN
docs/images/neatlogs-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 329 KiB |
BIN
docs/images/neatlogs-3.png
Normal file
BIN
docs/images/neatlogs-3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 590 KiB |
BIN
docs/images/neatlogs-4.png
Normal file
BIN
docs/images/neatlogs-4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 216 KiB |
BIN
docs/images/neatlogs-5.png
Normal file
BIN
docs/images/neatlogs-5.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 277 KiB |
Reference in New Issue
Block a user