mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
chore: merge main into release/v1.0.0
This commit is contained in:
Greyson LaLonde
@@ -271,6 +271,7 @@
|
||||
{
|
||||
"group": "Observability",
|
||||
"pages": [
|
||||
"en/observability/tracing",
|
||||
"en/observability/overview",
|
||||
"en/observability/arize-phoenix",
|
||||
"en/observability/braintrust",
|
||||
|
||||
@@ -102,5 +102,3 @@ Once deployed, you can view the automation details and have the **Options** drop
|
||||
Stream real-time events and updates to your systems.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -86,5 +86,3 @@ Once published, you can view the automation details and have the **Options** dro
|
||||
Export a React Component.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -44,5 +44,3 @@ you can use them locally or refine them to your needs.
|
||||
Store, share, and reuse agent definitions across teams and projects.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -100,5 +100,3 @@ The organization owner always has access. In private mode, only whitelisted user
|
||||
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
||||
Contact our support team for assistance with RBAC questions.
|
||||
</Card>
|
||||
|
||||
|
||||
|
||||
@@ -247,4 +247,3 @@ Tools & Integrations is the central hub for connecting third‑party apps and ma
|
||||
Automate workflows and integrate with external platforms and services.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
@@ -164,4 +164,3 @@ Here's a typical workflow for creating a crew with Crew Studio:
|
||||
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
||||
Contact our support team for assistance with Crew Studio or any other CrewAI AMP features.
|
||||
</Card>
|
||||
|
||||
|
||||
@@ -184,4 +184,3 @@ If an execution fails:
|
||||
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
||||
Contact our support team for assistance with execution issues or questions about the Enterprise platform.
|
||||
</Card>
|
||||
|
||||
|
||||
@@ -87,4 +87,3 @@ If you encounter any issues after updating, you can view deployment logs in the
|
||||
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
||||
Contact our support team for assistance with updating your crew or troubleshooting deployment issues.
|
||||
</Card>
|
||||
|
||||
|
||||
@@ -47,4 +47,3 @@ mode: "wide"
|
||||
<Tip>
|
||||
Use Cookbooks to learn a pattern quickly, then jump to Full Examples for production‑grade implementations.
|
||||
</Tip>
|
||||
|
||||
|
||||
213
docs/en/observability/tracing.mdx
Normal file
213
docs/en/observability/tracing.mdx
Normal file
@@ -0,0 +1,213 @@
|
||||
---
|
||||
title: CrewAI Tracing
|
||||
description: Built-in tracing for CrewAI Crews and Flows with the CrewAI AMP platform
|
||||
icon: magnifying-glass-chart
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# CrewAI Built-in Tracing
|
||||
|
||||
CrewAI provides built-in tracing capabilities that allow you to monitor and debug your Crews and Flows in real-time. This guide demonstrates how to enable tracing for both **Crews** and **Flows** using CrewAI's integrated observability platform.
|
||||
|
||||
> **What is CrewAI Tracing?** CrewAI's built-in tracing provides comprehensive observability for your AI agents, including agent decisions, task execution timelines, tool usage, and LLM calls - all accessible through the [CrewAI AMP platform](https://app.crewai.com).
|
||||
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you can use CrewAI tracing, you need:
|
||||
|
||||
1. **CrewAI AMP Account**: Sign up for a free account at [app.crewai.com](https://app.crewai.com)
|
||||
2. **CLI Authentication**: Use the CrewAI CLI to authenticate your local environment
|
||||
|
||||
```bash
|
||||
crewai login
|
||||
```
|
||||
|
||||
## Setup Instructions
|
||||
|
||||
### Step 1: Create Your CrewAI AMP Account
|
||||
|
||||
Visit [app.crewai.com](https://app.crewai.com) and create your free account. This will give you access to the CrewAI AMP platform where you can view traces, metrics, and manage your crews.
|
||||
|
||||
### Step 2: Install CrewAI CLI and Authenticate
|
||||
|
||||
If you haven't already, install CrewAI with the CLI tools:
|
||||
|
||||
```bash
|
||||
uv add crewai[tools]
|
||||
```
|
||||
|
||||
Then authenticate your CLI with your CrewAI AMP account:
|
||||
|
||||
```bash
|
||||
crewai login
|
||||
```
|
||||
|
||||
This command will:
|
||||
1. Open your browser to the authentication page
|
||||
2. Prompt you to enter a device code
|
||||
3. Authenticate your local environment with your CrewAI AMP account
|
||||
4. Enable tracing capabilities for your local development
|
||||
|
||||
### Step 3: Enable Tracing in Your Crew
|
||||
|
||||
You can enable tracing for your Crew by setting the `tracing` parameter to `True`:
|
||||
|
||||
```python
|
||||
from crewai import Agent, Crew, Process, Task
|
||||
from crewai_tools import SerperDevTool
|
||||
|
||||
# Define your agents
|
||||
researcher = Agent(
|
||||
role="Senior Research Analyst",
|
||||
goal="Uncover cutting-edge developments in AI and data science",
|
||||
backstory="""You work at a leading tech think tank.
|
||||
Your expertise lies in identifying emerging trends.
|
||||
You have a knack for dissecting complex data and presenting actionable insights.""",
|
||||
verbose=True,
|
||||
tools=[SerperDevTool()],
|
||||
)
|
||||
|
||||
writer = Agent(
|
||||
role="Tech Content Strategist",
|
||||
goal="Craft compelling content on tech advancements",
|
||||
backstory="""You are a renowned Content Strategist, known for your insightful and engaging articles.
|
||||
You transform complex concepts into compelling narratives.""",
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
# Create tasks for your agents
|
||||
research_task = Task(
|
||||
description="""Conduct a comprehensive analysis of the latest advancements in AI in 2024.
|
||||
Identify key trends, breakthrough technologies, and potential industry impacts.""",
|
||||
expected_output="Full analysis report in bullet points",
|
||||
agent=researcher,
|
||||
)
|
||||
|
||||
writing_task = Task(
|
||||
description="""Using the insights provided, develop an engaging blog
|
||||
post that highlights the most significant AI advancements.
|
||||
Your post should be informative yet accessible, catering to a tech-savvy audience.""",
|
||||
expected_output="Full blog post of at least 4 paragraphs",
|
||||
agent=writer,
|
||||
)
|
||||
|
||||
# Enable tracing in your crew
|
||||
crew = Crew(
|
||||
agents=[researcher, writer],
|
||||
tasks=[research_task, writing_task],
|
||||
process=Process.sequential,
|
||||
tracing=True, # Enable built-in tracing
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Execute your crew
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Step 4: Enable Tracing in Your Flow
|
||||
|
||||
Similarly, you can enable tracing for CrewAI Flows:
|
||||
|
||||
```python
|
||||
from crewai.flow.flow import Flow, listen, start
|
||||
from pydantic import BaseModel
|
||||
|
||||
class ExampleState(BaseModel):
|
||||
counter: int = 0
|
||||
message: str = ""
|
||||
|
||||
class ExampleFlow(Flow[ExampleState]):
|
||||
def __init__(self):
|
||||
super().__init__(tracing=True) # Enable tracing for the flow
|
||||
|
||||
@start()
|
||||
def first_method(self):
|
||||
print("Starting the flow")
|
||||
self.state.counter = 1
|
||||
self.state.message = "Flow started"
|
||||
return "continue"
|
||||
|
||||
@listen("continue")
|
||||
def second_method(self):
|
||||
print("Continuing the flow")
|
||||
self.state.counter += 1
|
||||
self.state.message = "Flow continued"
|
||||
return "finish"
|
||||
|
||||
@listen("finish")
|
||||
def final_method(self):
|
||||
print("Finishing the flow")
|
||||
self.state.counter += 1
|
||||
self.state.message = "Flow completed"
|
||||
|
||||
# Create and run the flow with tracing enabled
|
||||
flow = ExampleFlow(tracing=True)
|
||||
result = flow.kickoff()
|
||||
```
|
||||
|
||||
### Step 5: View Traces in the CrewAI AMP Dashboard
|
||||
|
||||
After running the crew or flow, you can view the traces generated by your CrewAI application in the CrewAI AMP dashboard. You should see detailed steps of the agent interactions, tool usages, and LLM calls.
|
||||
Just click on the link below to view the traces or head over to the traces tab in the dashboard [here](https://app.crewai.com/crewai_plus/trace_batches)
|
||||
|
||||
|
||||
|
||||
### Alternative: Environment Variable Configuration
|
||||
|
||||
You can also enable tracing globally by setting an environment variable:
|
||||
|
||||
```bash
|
||||
export CREWAI_TRACING_ENABLED=true
|
||||
```
|
||||
|
||||
Or add it to your `.env` file:
|
||||
|
||||
```env
|
||||
CREWAI_TRACING_ENABLED=true
|
||||
```
|
||||
|
||||
When this environment variable is set, all Crews and Flows will automatically have tracing enabled, even without explicitly setting `tracing=True`.
|
||||
|
||||
## Viewing Your Traces
|
||||
|
||||
### Access the CrewAI AMP Dashboard
|
||||
|
||||
1. Visit [app.crewai.com](https://app.crewai.com) and log in to your account
|
||||
2. Navigate to your project dashboard
|
||||
3. Click on the **Traces** tab to view execution details
|
||||
|
||||
### What You'll See in Traces
|
||||
|
||||
CrewAI tracing provides comprehensive visibility into:
|
||||
|
||||
- **Agent Decisions**: See how agents reason through tasks and make decisions
|
||||
- **Task Execution Timeline**: Visual representation of task sequences and dependencies
|
||||
- **Tool Usage**: Monitor which tools are called and their results
|
||||
- **LLM Calls**: Track all language model interactions, including prompts and responses
|
||||
- **Performance Metrics**: Execution times, token usage, and costs
|
||||
- **Error Tracking**: Detailed error information and stack traces
|
||||
|
||||
### Trace Features
|
||||
- **Execution Timeline**: Click through different stages of execution
|
||||
- **Detailed Logs**: Access comprehensive logs for debugging
|
||||
- **Performance Analytics**: Analyze execution patterns and optimize performance
|
||||
- **Export Capabilities**: Download traces for further analysis
|
||||
|
||||
### Authentication Issues
|
||||
|
||||
If you encounter authentication problems:
|
||||
|
||||
1. Ensure you're logged in: `crewai login`
|
||||
2. Check your internet connection
|
||||
3. Verify your account at [app.crewai.com](https://app.crewai.com)
|
||||
|
||||
### Traces Not Appearing
|
||||
|
||||
If traces aren't showing up in the dashboard:
|
||||
|
||||
1. Confirm `tracing=True` is set in your Crew/Flow
|
||||
2. Check that `CREWAI_TRACING_ENABLED=true` if using environment variables
|
||||
3. Ensure you're authenticated with `crewai login`
|
||||
4. Verify your crew/flow is actually executing
|
||||
@@ -432,4 +432,3 @@ components:
|
||||
example:
|
||||
error: "Internal Server Error"
|
||||
message: "An unexpected error occurred"
|
||||
|
||||
|
||||
@@ -228,4 +228,3 @@ components:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
|
||||
|
||||
@@ -265,4 +265,3 @@ components:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
|
||||
|
||||
BIN
docs/images/crewai-tracing.png
Normal file
BIN
docs/images/crewai-tracing.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 479 KiB |
BIN
docs/images/view-traces.png
Normal file
BIN
docs/images/view-traces.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
@@ -101,5 +101,3 @@ Git 없이 빠르게 배포 — 프로젝트 ZIP 패키지를 업로드하세요
|
||||
실시간 이벤트/업데이트 스트리밍
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -86,5 +86,3 @@ Crew Studio는 자연어와 시각적 워크플로 에디터로 처음부터 자
|
||||
React 컴포넌트를 내보내세요.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -43,5 +43,3 @@ mode: "wide"
|
||||
팀과 프로젝트 전반에서 에이전트 정의 저장, 공유 및 재사용.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -100,5 +100,3 @@ Owner는 항상 접근 가능하며, Private 모드에서는 화이트리스트
|
||||
<Card title="도움이 필요하신가요?" icon="headset" href="mailto:support@crewai.com">
|
||||
RBAC 구성과 점검에 대한 지원이 필요하면 연락해 주세요.
|
||||
</Card>
|
||||
|
||||
|
||||
|
||||
@@ -232,5 +232,3 @@ mode: "wide"
|
||||
워크플로를 자동화하고 외부 플랫폼/서비스와 통합하세요.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -105,5 +105,3 @@ crewai tool publish
|
||||
<Card title="도움이 필요하신가요?" icon="headset" href="mailto:support@crewai.com">
|
||||
API 통합 또는 문제 해결에 대한 지원이 필요하시면 지원팀에 문의해 주세요.
|
||||
</Card>
|
||||
|
||||
|
||||
|
||||
@@ -28,4 +28,3 @@ mode: "wide"
|
||||
</CardGroup>
|
||||
|
||||
Use these integrations to connect CrewAI with your infrastructure and workflows.
|
||||
|
||||
|
||||
@@ -154,5 +154,3 @@ crewai org list
|
||||
<Note>
|
||||
Ao carregar agentes de repositórios, você deve estar autenticado e ter alternado para a organização correta. Se você receber erros, verifique seu status de autenticação e as configurações de organização usando os comandos do CLI acima.
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
@@ -101,5 +101,3 @@ Após implantar, você pode ver os detalhes da automação e usar o menu **Optio
|
||||
Transmita eventos e atualizações em tempo real.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -86,5 +86,3 @@ Após publicar, você pode visualizar os detalhes da automação e usar o menu *
|
||||
Exporte um componente React.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -43,5 +43,3 @@ Você também pode baixar templates diretamente do marketplace clicando em `Down
|
||||
Armazene, compartilhe e reutilize definições de agentes entre equipes e projetos.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -100,5 +100,3 @@ O owner sempre possui acesso. Em modo privado, somente usuários/funções na wh
|
||||
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Fale com o nosso time para suporte em configuração e auditoria de RBAC.
|
||||
</Card>
|
||||
|
||||
|
||||
|
||||
@@ -232,5 +232,3 @@ Ferramentas & Integrações é o hub central para conectar aplicações de terce
|
||||
Automatize fluxos e integre com plataformas e serviços externos.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
||||
|
||||
@@ -105,5 +105,3 @@ Você pode verificar o status das verificações de segurança de uma ferramenta
|
||||
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
||||
Entre em contato com nossa equipe de suporte para assistência com integração de API ou resolução de problemas.
|
||||
</Card>
|
||||
|
||||
|
||||
|
||||
@@ -55,5 +55,3 @@ result = crew.kickoff()
|
||||
## Notes
|
||||
|
||||
- The adapter fetches available actions and generates `BaseTool` wrappers dynamically.
|
||||
|
||||
|
||||
|
||||
@@ -165,5 +165,3 @@ crew = Crew(
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -58,5 +58,3 @@ crew = Crew(
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -86,5 +86,3 @@ task = Task(
|
||||
crew = Crew(agents=[agent], tasks=[task])
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -73,5 +73,3 @@ PDFTextWritingTool().run(
|
||||
|
||||
- Coordinate origin is the bottom‑left corner.
|
||||
- If using a custom font (`font_file`), ensure it is a valid `.ttf`.
|
||||
|
||||
|
||||
|
||||
@@ -109,5 +109,3 @@ When `download_pdfs=True`, PDFs are saved to disk and the summary mentions saved
|
||||
## Error Handling
|
||||
|
||||
- Network issues, invalid XML, and OS errors are handled with informative messages.
|
||||
|
||||
|
||||
|
||||
@@ -77,5 +77,3 @@ print(result)
|
||||
- Authentication errors: verify `DATABRICKS_HOST` begins with `https://` and token is valid.
|
||||
- Permissions: ensure your SQL warehouse and schema are accessible by your token.
|
||||
- Limits: long‑running queries should be avoided in agent loops; add filters/limits.
|
||||
|
||||
|
||||
|
||||
@@ -62,5 +62,3 @@ result = crew.kickoff()
|
||||
## Notes
|
||||
|
||||
- This tool wraps SerpApi and returns structured search results.
|
||||
|
||||
|
||||
|
||||
@@ -58,5 +58,3 @@ result = crew.kickoff()
|
||||
|
||||
- `search_query` (str, required): Product search query.
|
||||
- `location` (str, optional): Geographic location parameter.
|
||||
|
||||
|
||||
|
||||
@@ -28,4 +28,3 @@ mode: "wide"
|
||||
</CardGroup>
|
||||
|
||||
Use these integrations to connect CrewAI with your infrastructure and workflows.
|
||||
|
||||
|
||||
@@ -108,5 +108,3 @@ crew = Crew(
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user