mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
215 lines
7.5 KiB
Plaintext
215 lines
7.5 KiB
Plaintext
---
|
|
title: CrewAI Tracing
|
|
description: CrewAI AMP 플랫폼을 사용한 CrewAI Crews 및 Flows의 내장 추적
|
|
icon: magnifying-glass-chart
|
|
mode: "wide"
|
|
---
|
|
|
|
# CrewAI 내장 추적 (Built-in Tracing)
|
|
|
|
CrewAI는 Crews와 Flows를 실시간으로 모니터링하고 디버깅할 수 있는 내장 추적 기능을 제공합니다. 이 가이드는 CrewAI의 통합 관측 가능성 플랫폼을 사용하여 **Crews**와 **Flows** 모두에 대한 추적을 활성화하는 방법을 보여줍니다.
|
|
|
|
> **CrewAI Tracing이란?** CrewAI의 내장 추적은 agent 결정, 작업 실행 타임라인, 도구 사용, LLM 호출을 포함한 AI agent에 대한 포괄적인 관측 가능성을 제공하며, 모두 [CrewAI AMP 플랫폼](https://app.crewai.com)을 통해 액세스할 수 있습니다.
|
|
|
|

|
|
|
|
## 사전 요구 사항
|
|
|
|
CrewAI 추적을 사용하기 전에 다음이 필요합니다:
|
|
|
|
1. **CrewAI AMP 계정**: [app.crewai.com](https://app.crewai.com)에서 무료 계정에 가입하세요
|
|
2. **CLI 인증**: CrewAI CLI를 사용하여 로컬 환경을 인증하세요
|
|
|
|
```bash
|
|
crewai login
|
|
```
|
|
|
|
## 설정 지침
|
|
|
|
### 1단계: CrewAI AMP 계정 생성
|
|
|
|
[app.crewai.com](https://app.crewai.com)을 방문하여 무료 계정을 만드세요. 이를 통해 추적, 메트릭을 보고 crews를 관리할 수 있는 CrewAI AMP 플랫폼에 액세스할 수 있습니다.
|
|
|
|
### 2단계: CrewAI CLI 설치 및 인증
|
|
|
|
아직 설치하지 않았다면 CLI 도구와 함께 CrewAI를 설치하세요:
|
|
|
|
```bash
|
|
uv add 'crewai[tools]'
|
|
```
|
|
|
|
그런 다음 CrewAI AMP 계정으로 CLI를 인증하세요:
|
|
|
|
```bash
|
|
crewai login
|
|
```
|
|
|
|
이 명령은 다음을 수행합니다:
|
|
|
|
1. 브라우저에서 인증 페이지를 엽니다
|
|
2. 장치 코드를 입력하라는 메시지를 표시합니다
|
|
3. CrewAI AMP 계정으로 로컬 환경을 인증합니다
|
|
4. 로컬 개발을 위한 추적 기능을 활성화합니다
|
|
|
|
### 3단계: Crew에서 추적 활성화
|
|
|
|
`tracing` 매개변수를 `True`로 설정하여 Crew에 대한 추적을 활성화할 수 있습니다:
|
|
|
|
```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()
|
|
```
|
|
|
|
### 4단계: Flow에서 추적 활성화
|
|
|
|
마찬가지로 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()
|
|
```
|
|
|
|
### 5단계: CrewAI AMP 대시보드에서 추적 보기
|
|
|
|
crew 또는 flow를 실행한 후 CrewAI AMP 대시보드에서 CrewAI 애플리케이션이 생성한 추적을 볼 수 있습니다. agent 상호 작용, 도구 사용 및 LLM 호출의 세부 단계를 볼 수 있습니다.
|
|
아래 링크를 클릭하여 추적을 보거나 대시보드의 추적 탭으로 이동하세요 [여기](https://app.crewai.com/crewai_plus/trace_batches)
|
|

|
|
|
|
### 대안: 환경 변수 구성
|
|
|
|
환경 변수를 설정하여 전역적으로 추적을 활성화할 수도 있습니다:
|
|
|
|
```bash
|
|
export CREWAI_TRACING_ENABLED=true
|
|
```
|
|
|
|
또는 `.env` 파일에 추가하세요:
|
|
|
|
```env
|
|
CREWAI_TRACING_ENABLED=true
|
|
```
|
|
|
|
이 환경 변수가 설정되면 `tracing=True`를 명시적으로 설정하지 않아도 모든 Crews와 Flows에 자동으로 추적이 활성화됩니다.
|
|
|
|
## 추적 보기
|
|
|
|
### CrewAI AMP 대시보드 액세스
|
|
|
|
1. [app.crewai.com](https://app.crewai.com)을 방문하여 계정에 로그인하세요
|
|
2. 프로젝트 대시보드로 이동하세요
|
|
3. **Traces** 탭을 클릭하여 실행 세부 정보를 확인하세요
|
|
|
|
### 추적에서 볼 수 있는 내용
|
|
|
|
CrewAI 추적은 다음에 대한 포괄적인 가시성을 제공합니다:
|
|
|
|
- **Agent 결정**: agent가 작업을 통해 어떻게 추론하고 결정을 내리는지 확인하세요
|
|
- **작업 실행 타임라인**: 작업 시퀀스 및 종속성의 시각적 표현
|
|
- **도구 사용**: 어떤 도구가 호출되고 그 결과를 모니터링하세요
|
|
- **LLM 호출**: 프롬프트 및 응답을 포함한 모든 언어 모델 상호 작용을 추적하세요
|
|
- **성능 메트릭**: 실행 시간, 토큰 사용량 및 비용
|
|
- **오류 추적**: 세부 오류 정보 및 스택 추적
|
|
|
|
### 추적 기능
|
|
|
|
- **실행 타임라인**: 실행의 다양한 단계를 클릭하여 확인하세요
|
|
- **세부 로그**: 디버깅을 위한 포괄적인 로그에 액세스하세요
|
|
- **성능 분석**: 실행 패턴을 분석하고 성능을 최적화하세요
|
|
- **내보내기 기능**: 추가 분석을 위해 추적을 다운로드하세요
|
|
|
|
### 인증 문제
|
|
|
|
인증 문제가 발생하는 경우:
|
|
|
|
1. 로그인되어 있는지 확인하세요: `crewai login`
|
|
2. 인터넷 연결을 확인하세요
|
|
3. [app.crewai.com](https://app.crewai.com)에서 계정을 확인하세요
|
|
|
|
### 추적이 나타나지 않음
|
|
|
|
대시보드에 추적이 표시되지 않는 경우:
|
|
|
|
1. Crew/Flow에서 `tracing=True`가 설정되어 있는지 확인하세요
|
|
2. 환경 변수를 사용하는 경우 `CREWAI_TRACING_ENABLED=true`인지 확인하세요
|
|
3. `crewai login`으로 인증되었는지 확인하세요
|
|
4. crew/flow가 실제로 실행되고 있는지 확인하세요
|