mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +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>
121 lines
5.4 KiB
Plaintext
121 lines
5.4 KiB
Plaintext
---
|
|
title: "Visão Geral"
|
|
description: "Monitore, avalie e otimize seus agentes CrewAI com ferramentas de observabilidade abrangentes"
|
|
icon: "face-smile"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Observabilidade para CrewAI
|
|
|
|
A observabilidade é fundamental para entender como seus agentes CrewAI estão desempenhando, identificar gargalos e garantir uma operação confiável em ambientes de produção. Esta seção aborda diversas ferramentas e plataformas que oferecem recursos de monitoramento, avaliação e otimização dos fluxos de trabalho dos seus agentes.
|
|
|
|
## Por que a Observabilidade é Importante
|
|
|
|
- **Monitoramento de Desempenho**: Acompanhe tempos de execução dos agentes, uso de tokens e consumo de recursos
|
|
- **Garantia de Qualidade**: Avalie a qualidade e a consistência das saídas em diferentes cenários
|
|
- **Depuração**: Identifique e resolva problemas no comportamento dos agentes e na execução de tarefas
|
|
- **Gestão de Custos**: Monitore o uso das APIs do LLM e os custos associados
|
|
- **Melhoria Contínua**: Colete insights para otimizar o desempenho dos agentes ao longo do tempo
|
|
|
|
## Ferramentas de Observabilidade Disponíveis
|
|
|
|
### Plataformas de Monitoramento e Rastreamento
|
|
|
|
<CardGroup cols={2}>
|
|
|
|
<Card title="LangDB" icon="database" href="/pt-BR/observability/langdb">
|
|
Rastreamento ponta a ponta para fluxos de trabalho CrewAI com captura automática de interações de agentes.
|
|
</Card>
|
|
|
|
<Card title="OpenLIT" icon="magnifying-glass-chart" href="/pt-BR/observability/openlit">
|
|
Monitoramento nativo OpenTelemetry com rastreamento de custos e análises de desempenho.
|
|
</Card>
|
|
|
|
<Card title="MLflow" icon="bars-staggered" href="/pt-BR/observability/mlflow">
|
|
Gerenciamento do ciclo de vida de machine learning com rastreamento e avaliação.
|
|
</Card>
|
|
|
|
<Card title="Langfuse" icon="link" href="/pt-BR/observability/langfuse">
|
|
Plataforma de engenharia de LLM com rastreamento detalhado e análises.
|
|
</Card>
|
|
|
|
<Card title="Langtrace" icon="chart-line" href="/pt-BR/observability/langtrace">
|
|
Observabilidade open-source para LLMs e frameworks de agentes.
|
|
</Card>
|
|
|
|
<Card title="Arize Phoenix" icon="meteor" href="/pt-BR/observability/arize-phoenix">
|
|
Plataforma de observabilidade de IA para monitoramento e solução de problemas.
|
|
</Card>
|
|
|
|
<Card title="Portkey" icon="key" href="/pt-BR/observability/portkey">
|
|
Gateway de IA com monitoramento abrangente e recursos de confiabilidade.
|
|
</Card>
|
|
|
|
<Card title="Opik" icon="meteor" href="/pt-BR/observability/opik">
|
|
Depure, avalie e monitore aplicações LLM com rastreamento abrangente.
|
|
</Card>
|
|
|
|
<Card title="Weave" icon="network-wired" href="/pt-BR/observability/weave">
|
|
Plataforma Weights & Biases para acompanhamento e avaliação de aplicações de IA.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
### Avaliação & Garantia de Qualidade
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Patronus AI" icon="shield-check" href="/pt-BR/observability/patronus-evaluation">
|
|
Plataforma abrangente de avaliação para saídas de LLM e comportamentos de agentes.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Principais Métricas de Observabilidade
|
|
|
|
### Métricas de Desempenho
|
|
- **Tempo de Execução**: Quanto tempo os agentes levam para concluir as tarefas
|
|
- **Uso de Tokens**: Tokens de entrada/saída consumidos pelas chamadas ao LLM
|
|
- **Latência de API**: Tempo de resposta de serviços externos
|
|
- **Taxa de Sucesso**: Percentual de tarefas concluídas com sucesso
|
|
|
|
### Métricas de Qualidade
|
|
- **Acurácia da Saída**: Correção das respostas dos agentes
|
|
- **Consistência**: Confiabilidade em entradas semelhantes
|
|
- **Relevância**: Quão bem as saídas correspondem aos resultados esperados
|
|
- **Segurança**: Conformidade com políticas de conteúdo e diretrizes
|
|
|
|
### Métricas de Custo
|
|
- **Custos de API**: Gastos decorrentes do uso do provedor LLM
|
|
- **Utilização de Recursos**: Consumo de processamento e memória
|
|
- **Custo por Tarefa**: Eficiência econômica das operações dos agentes
|
|
- **Acompanhamento de Orçamento**: Monitoramento em relação a limites de gastos
|
|
|
|
## Primeiros Passos
|
|
|
|
1. **Escolha suas Ferramentas**: Selecione plataformas de observabilidade que atendam às suas necessidades
|
|
2. **Instrumente seu Código**: Adicione monitoramento às suas aplicações CrewAI
|
|
3. **Configure Dashboards**: Prepare visualizações para as métricas principais
|
|
4. **Defina Alertas**: Crie notificações para eventos importantes
|
|
5. **Estabeleça Bases de Referência**: Meça o desempenho inicial para comparação futura
|
|
6. **Itere e Melhore**: Use os insights para otimizar seus agentes
|
|
|
|
## Boas Práticas
|
|
|
|
### Fase de Desenvolvimento
|
|
- Utilize rastreamento detalhado para entender o comportamento dos agentes
|
|
- Implemente métricas de avaliação desde o início do desenvolvimento
|
|
- Monitore o uso de recursos durante os testes
|
|
- Estabeleça verificações automatizadas de qualidade
|
|
|
|
### Fase de Produção
|
|
- Implemente monitoramento e alertas abrangentes
|
|
- Acompanhe tendências de desempenho ao longo do tempo
|
|
- Monitore anomalias e degradações
|
|
- Mantenha visibilidade e controle dos custos
|
|
|
|
### Melhoria Contínua
|
|
- Revisões regulares de desempenho e otimização
|
|
- Testes A/B de diferentes configurações de agentes
|
|
- Ciclos de feedback para aprimoramento da qualidade
|
|
- Documentação de lições aprendidas
|
|
|
|
Escolha as ferramentas de observabilidade que melhor se encaixam no seu caso de uso, infraestrutura e requisitos de monitoramento para garantir que seus agentes CrewAI operem de forma confiável e eficiente.
|