mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 22:19:27 +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
5.7 KiB
Plaintext
113 lines
5.7 KiB
Plaintext
---
|
|
title: "Watch your Automations"
|
|
description: "Watch fleet health, LLM consumption, and per-automation behavior from the Automations tab."
|
|
sidebarTitle: "Monitoring"
|
|
icon: "gauge"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Info>
|
|
**ACP (Beta) Docs Navigation**
|
|
|
|
- [Overview](/en/enterprise/features/agent-control-plane/overview)
|
|
- **Monitoring** *(you are here)*
|
|
- [Rules](/en/enterprise/features/agent-control-plane/rules)
|
|
</Info>
|
|
|
|
## Overview
|
|
|
|
The **Automations** tab is the read-only operations view of the [Agent Control Plane](/en/enterprise/features/agent-control-plane/overview). It combines two metric cards, an interactive sankey, and two sub-tables — **Automations** and **Consumption** — that you can search, filter, and sort.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
All charts and tables respect the **Last 24 hours / Last Week / Last 30 days** selector at the top right. Deltas compare the selected window against the previous one of the same length.
|
|
|
|
<Note>
|
|
Rows only show data for deployments on **crewAI v1.13 or higher** — older deployments appear in the *"We've detected N other automations that we can't display"* banner under the sankey and contribute zero metrics until they're updated and re-deployed. See [Overview — Requirements](/en/enterprise/features/agent-control-plane/overview#requirements).
|
|
</Note>
|
|
|
|
## Dashboard
|
|
|
|
The header of the page has two metric cards and an interactive sankey. Clicking either card switches the sankey between two modes:
|
|
|
|
- **Health mode** — `Total Automations → status buckets (Critical / Warning / Healthy)`. Click a bucket to filter the Automations table to just those deployments.
|
|
- **Consumption mode** — `Model Providers → Automations → Total Cost`. Click a provider to filter the Consumption table to that provider.
|
|
|
|
| Card | What it shows |
|
|
|------|---------------|
|
|
| **Automations** | `active` automations (and total count), total `errors` in the window, currently `active executions` (and total in the window), with a delta vs the previous period. |
|
|
| **Consumption** | Total `cost` and `tokens used`, with a cost delta vs the previous period. |
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## Automations table
|
|
|
|
The **Automations** sub-tab is the per-deployment breakdown of fleet health. Each row is one deployed crew or flow.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
| Column | What it shows |
|
|
|--------|---------------|
|
|
| **Automation** | Deployment name and any tags assigned to it (e.g. `production`, `financial`). |
|
|
| **Last execution** | Time since the most recent run. |
|
|
| **Health Status Breakdown** | Stacked bar of `Critical` / `Warning` / `Healthy` percentages for executions in the window. |
|
|
| **Executions with Errors** | Total failed executions in the window. |
|
|
| **PII detection applied** | `Yes` if a per-deployment PII config or a matching [PII rule](/en/enterprise/features/agent-control-plane/rules) is active. |
|
|
| **Executions** | Total executions in the window. |
|
|
| **Last updated** | When the deployment was last re-deployed. |
|
|
| **Crew Version** | The `crewai` version reported by the deployment. An info icon next to versions below `1.13` flags rows that can't contribute metrics. |
|
|
|
|
Search by name, filter by `Status` (`Healthy` / `Warning` / `Critical`), and sort by any column header. Click a deployment name to open the **Automation panel** (see below).
|
|
|
|
## Consumption table
|
|
|
|
The **Consumption** sub-tab is the per-deployment breakdown of LLM spend and token usage.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
| Column | What it shows |
|
|
|--------|---------------|
|
|
| **Automation** | Deployment name. |
|
|
| **Last execution** | Time since the most recent run. |
|
|
| **Tokens used** | One row per LLM provider used by this automation, with the delta vs the previous period. |
|
|
| **Cost** | Cost per LLM provider, with the delta vs the previous period. |
|
|
| **Total cost** | Sum across all providers, with the delta. |
|
|
| **Executions** | Total executions in the window. |
|
|
| **Last updated** | When the deployment was last re-deployed. |
|
|
| **Crew Version** | The `crewai` version reported by the deployment. |
|
|
|
|
Filter by **LLM provider** and sort by `Cost`, `Executions`, or `Last run`.
|
|
|
|
<Info>
|
|
**Empty cells (`—` or `$0.00`) usually mean the deployment is below crewAI v1.13.** In the screenshot above, *Automation F* (`1.7.0`) and *Automation I* (`1.12.2`) show blanks for tokens and cost — their executions still run, but they don't emit the provider-level telemetry that powers this table. Update and re-deploy these crews to start collecting consumption data.
|
|
</Info>
|
|
|
|
## Related
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Agent Control Plane — Overview" icon="book-open" href="/en/enterprise/features/agent-control-plane/overview">
|
|
What ACP is, requirements, plan tiers, and RBAC.
|
|
</Card>
|
|
<Card title="Agent Control Plane — Rules" icon="shield-check" href="/en/enterprise/features/agent-control-plane/rules">
|
|
Apply organization-wide PII Redaction rules across many automations.
|
|
</Card>
|
|
<Card title="Traces" icon="timeline" href="/en/enterprise/features/traces">
|
|
Drill into a single execution to see agent reasoning, tool calls, and token usage.
|
|
</Card>
|
|
<Card title="Deploy to AMP" icon="rocket" href="/en/enterprise/guides/deploy-to-amp">
|
|
Deploy a crew on a crewAI version that supports the Agent Control Plane.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
|
Contact our support team for help interpreting metrics in the Agent Control Plane.
|
|
</Card>
|