mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-06 07:29:24 +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>
113 lines
6.3 KiB
Plaintext
113 lines
6.3 KiB
Plaintext
---
|
|
title: "Observe suas Automações"
|
|
description: "Acompanhe a saúde da frota, o consumo de LLM e o comportamento por automação a partir da aba Automações."
|
|
sidebarTitle: "Monitoramento"
|
|
icon: "gauge"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Info>
|
|
**Navegação da Documentação do ACP (Beta)**
|
|
|
|
- [Visão Geral](/pt-BR/enterprise/features/agent-control-plane/overview)
|
|
- **Monitoramento** *(você está aqui)*
|
|
- [Regras](/pt-BR/enterprise/features/agent-control-plane/rules)
|
|
</Info>
|
|
|
|
## Visão Geral
|
|
|
|
A aba **Automações** é a visão de operações somente leitura do [Agent Control Plane](/pt-BR/enterprise/features/agent-control-plane/overview). Ela combina dois cards de métricas, um sankey interativo e duas sub-tabelas — **Automações** e **Consumo** — nas quais você pode buscar, filtrar e ordenar.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
Todos os gráficos e tabelas respeitam o seletor **Últimas 24 horas / Última Semana / Últimos 30 dias** no canto superior direito. As variações comparam a janela selecionada com a janela anterior de mesma duração.
|
|
|
|
<Note>
|
|
As linhas só mostram dados de deployments em **crewAI v1.13 ou superior** — deployments mais antigos aparecem no banner *"We've detected N other automations that we can't display"* abaixo do sankey e não contribuem com nenhuma métrica até que sejam atualizados e re-implantados. Veja [Visão Geral — Requisitos](/pt-BR/enterprise/features/agent-control-plane/overview#requisitos).
|
|
</Note>
|
|
|
|
## Dashboard
|
|
|
|
O topo da página tem dois cards de métricas e um sankey interativo. Clicar em qualquer um dos cards alterna o sankey entre dois modos:
|
|
|
|
- **Modo Saúde** — `Total de Automações → buckets de status (Critical / Warning / Healthy)`. Clique em um bucket para filtrar a tabela Automações para esses deployments.
|
|
- **Modo Consumo** — `Provedores de Modelo → Automações → Custo Total`. Clique em um provedor para filtrar a tabela Consumo para esse provedor.
|
|
|
|
| Card | O que mostra |
|
|
|------|---------------|
|
|
| **Automações** | Automações `active` (e total), total de `errors` na janela, `active executions` no momento (e total na janela), com variação em relação ao período anterior. |
|
|
| **Consumo** | `cost` total e `tokens used`, com variação de custo em relação ao período anterior. |
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## Tabela de Automações
|
|
|
|
A sub-aba **Automações** é o detalhamento por deployment da saúde da frota. Cada linha é uma crew ou flow implantada.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
| Coluna | O que mostra |
|
|
|--------|---------------|
|
|
| **Automação** | Nome do deployment e quaisquer tags atribuídas a ele (ex.: `production`, `financial`). |
|
|
| **Última execução** | Tempo decorrido desde a execução mais recente. |
|
|
| **Health Status Breakdown** | Barra empilhada com percentuais de `Critical` / `Warning` / `Healthy` para as execuções na janela. |
|
|
| **Executions with Errors** | Total de execuções com falha na janela. |
|
|
| **PII detection applied** | `Yes` se houver configuração de PII por deployment ou uma [regra de PII](/pt-BR/enterprise/features/agent-control-plane/rules) correspondente ativa. |
|
|
| **Executions** | Total de execuções na janela. |
|
|
| **Last updated** | Quando o deployment foi re-implantado pela última vez. |
|
|
| **Crew Version** | A versão do `crewai` reportada pelo deployment. Um ícone de informação ao lado de versões abaixo de `1.13` indica linhas que não conseguem contribuir com métricas. |
|
|
|
|
Busque por nome, filtre por `Status` (`Healthy` / `Warning` / `Critical`) e ordene por qualquer cabeçalho de coluna. Clique no nome de um deployment para abrir o **painel da Automação**.
|
|
|
|
## Tabela de Consumo
|
|
|
|
A sub-aba **Consumo** é o detalhamento por deployment de gasto com LLM e uso de tokens.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
| Coluna | O que mostra |
|
|
|--------|---------------|
|
|
| **Automação** | Nome do deployment. |
|
|
| **Última execução** | Tempo decorrido desde a execução mais recente. |
|
|
| **Tokens used** | Uma linha por provedor de LLM usado por esta automação, com variação em relação ao período anterior. |
|
|
| **Cost** | Custo por provedor de LLM, com variação em relação ao período anterior. |
|
|
| **Total cost** | Soma entre todos os provedores, com a variação. |
|
|
| **Executions** | Total de execuções na janela. |
|
|
| **Last updated** | Quando o deployment foi re-implantado pela última vez. |
|
|
| **Crew Version** | A versão do `crewai` reportada pelo deployment. |
|
|
|
|
Filtre por **LLM provider** e ordene por `Cost`, `Executions` ou `Last run`.
|
|
|
|
<Info>
|
|
**Células vazias (`—` ou `$0.00`) normalmente significam que o deployment está abaixo do crewAI v1.13.** Na captura acima, *Automation F* (`1.7.0`) e *Automation I* (`1.12.2`) mostram valores em branco para tokens e custo — suas execuções ainda rodam, mas não emitem a telemetria a nível de provedor que alimenta esta tabela. Atualize e re-implante essas crews para começar a coletar dados de consumo.
|
|
</Info>
|
|
|
|
## Relacionados
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Agent Control Plane — Visão Geral" icon="book-open" href="/pt-BR/enterprise/features/agent-control-plane/overview">
|
|
O que é o ACP, requisitos, planos suportados e RBAC.
|
|
</Card>
|
|
<Card title="Agent Control Plane — Regras" icon="shield-check" href="/pt-BR/enterprise/features/agent-control-plane/rules">
|
|
Aplique regras de PII Redaction em nível de organização em muitas automações.
|
|
</Card>
|
|
<Card title="Traces" icon="timeline" href="/pt-BR/enterprise/features/traces">
|
|
Aprofunde em uma única execução para ver o raciocínio do agente, chamadas de ferramentas e uso de tokens.
|
|
</Card>
|
|
<Card title="Deploy no AMP" icon="rocket" href="/pt-BR/enterprise/guides/deploy-to-amp">
|
|
Implante uma crew em uma versão do crewAI que suporta o Agent Control Plane.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nosso time de suporte para ajudar a interpretar métricas no Agent Control Plane.
|
|
</Card>
|