mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
141 lines
3.6 KiB
Plaintext
141 lines
3.6 KiB
Plaintext
---
|
||
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.
|
||
```
|