mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* 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>
139 lines
4.8 KiB
Plaintext
139 lines
4.8 KiB
Plaintext
---
|
|
title: Traces
|
|
description: "Usando Traces para monitorar seus Crews"
|
|
icon: "timeline"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
Traces fornecem visibilidade abrangente sobre as execuções dos seus crews, ajudando você a monitorar o desempenho, depurar problemas e otimizar os fluxos de trabalho dos seus agentes de IA.
|
|
|
|
## O que são Traces?
|
|
|
|
Traces no CrewAI AMP são registros detalhados de execução que capturam todos os aspectos da operação do seu crew, desde as entradas iniciais até as saídas finais. Eles registram:
|
|
|
|
- Pensamentos e raciocínio do agente
|
|
- Detalhes da execução das tarefas
|
|
- Uso de ferramentas e resultados
|
|
- Métricas de consumo de tokens
|
|
- Tempos de execução
|
|
- Estimativas de custo
|
|
|
|
<Frame></Frame>
|
|
|
|
## Acessando os Traces
|
|
|
|
<Steps>
|
|
<Step title="Navegue até a aba Traces">
|
|
No seu painel do CrewAI AMP, clique em **Traces** para ver todos os registros de execução.
|
|
</Step>
|
|
|
|
<Step title="Selecione uma Execução">
|
|
Você verá uma lista de todas as execuções do crew, ordenadas por data. Clique em qualquer execução para visualizar seu trace detalhado.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Entendendo a Interface do Trace
|
|
|
|
A interface do trace é dividida em várias seções, cada uma fornecendo diferentes insights sobre a execução do seu crew:
|
|
|
|
### 1. Resumo da Execução
|
|
|
|
A seção superior exibe métricas de alto nível sobre a execução:
|
|
|
|
- **Total de Tokens**: Número de tokens consumidos em todas as tarefas
|
|
- **Prompt Tokens**: Tokens usados em prompts para o LLM
|
|
- **Completion Tokens**: Tokens gerados nas respostas do LLM
|
|
- **Requisições**: Número de chamadas de API feitas
|
|
- **Tempo de Execução**: Duração total da execução do crew
|
|
- **Custo Estimado**: Custo aproximado com base no uso de tokens
|
|
|
|
<Frame></Frame>
|
|
|
|
### 2. Tarefas & Agentes
|
|
|
|
Esta seção mostra todas as tarefas e agentes que fizeram parte da execução do crew:
|
|
|
|
- Nome da tarefa e atribuição do agente
|
|
- Agentes e LLMs usados em cada tarefa
|
|
- Status (concluído/falhou)
|
|
- Tempo de execução individual da tarefa
|
|
|
|
<Frame></Frame>
|
|
|
|
### 3. Saída Final
|
|
|
|
Exibe o resultado final produzido pelo crew após a conclusão de todas as tarefas.
|
|
|
|
<Frame></Frame>
|
|
|
|
### 4. Linha do Tempo da Execução
|
|
|
|
Uma representação visual de quando cada tarefa começou e terminou, ajudando a identificar gargalos ou padrões de execução paralela.
|
|
|
|
<Frame></Frame>
|
|
|
|
### 5. Visão Detalhada da Tarefa
|
|
|
|
Ao clicar em uma tarefa específica na linha do tempo ou na lista de tarefas, você verá:
|
|
|
|
<Frame></Frame>
|
|
|
|
- **Task Key**: Identificador único da tarefa
|
|
- **Task ID**: Identificador técnico no sistema
|
|
- **Status**: Estado atual (concluída/em execução/falhou)
|
|
- **Agente**: Qual agente executou a tarefa
|
|
- **LLM**: Modelo de linguagem usado nesta tarefa
|
|
- **Início/Fim**: Quando a tarefa foi iniciada e concluída
|
|
- **Tempo de Execução**: Duração desta tarefa específica
|
|
- **Descrição da Tarefa**: O que o agente foi instruído a fazer
|
|
- **Expected Output**: Qual formato de saída foi solicitado
|
|
- **Input**: Qualquer entrada fornecida a essa tarefa vinda de tarefas anteriores
|
|
- **Output**: O resultado real produzido pelo agente
|
|
|
|
## Usando Traces para Depuração
|
|
|
|
Traces são indispensáveis para solucionar problemas nos seus crews:
|
|
|
|
<Steps>
|
|
<Step title="Identifique Pontos de Falha">
|
|
Quando uma execução de crew não produzir os resultados esperados, examine o trace para encontrar onde ocorreu o problema. Procure por:
|
|
|
|
- Tarefas que falharam
|
|
- Decisões inesperadas dos agentes
|
|
- Erros no uso de ferramentas
|
|
- Instruções mal interpretadas
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="Otimizar Desempenho">
|
|
Use métricas de execução para identificar gargalos de desempenho:
|
|
|
|
- Tarefas que demoraram mais do que o esperado
|
|
- Uso excessivo de tokens
|
|
- Operações redundantes de ferramentas
|
|
- Chamadas de API desnecessárias
|
|
|
|
</Step>
|
|
|
|
<Step title="Melhore a Eficiência de Custos">
|
|
Analise o uso de tokens e as estimativas de custo para otimizar a eficiência do seu crew:
|
|
|
|
- Considere usar modelos menores para tarefas mais simples
|
|
- Refine prompts para serem mais concisos
|
|
- Faça cache de informações acessadas frequentemente
|
|
- Estruture tarefas para minimizar operações redundantes
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nossa equipe de suporte para assistência com análise de
|
|
traces ou outros recursos do CrewAI AMP.
|
|
</Card>
|