mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
93dafe2637
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>
121 lines
6.2 KiB
Plaintext
121 lines
6.2 KiB
Plaintext
---
|
|
title: "نظرة عامة"
|
|
description: "راقب وقيّم وحسّن وكلاء CrewAI الخاصين بك باستخدام أدوات مراقبة شاملة"
|
|
icon: "face-smile"
|
|
mode: "wide"
|
|
---
|
|
|
|
## المراقبة في CrewAI
|
|
|
|
تعد المراقبة أمراً بالغ الأهمية لفهم كيفية أداء وكلاء CrewAI، وتحديد الاختناقات، وضمان التشغيل الموثوق في بيئات الإنتاج. يغطي هذا القسم مختلف الأدوات والمنصات التي توفر إمكانيات المراقبة والتقييم والتحسين لسير عمل وكلائك.
|
|
|
|
## لماذا تعد المراقبة مهمة
|
|
|
|
- **مراقبة الأداء**: تتبع أوقات تنفيذ الوكلاء واستخدام الرموز المميزة واستهلاك الموارد
|
|
- **ضمان الجودة**: تقييم جودة المخرجات واتساقها عبر سيناريوهات مختلفة
|
|
- **تصحيح الأخطاء**: تحديد وحل المشكلات في سلوك الوكلاء وتنفيذ المهام
|
|
- **إدارة التكاليف**: مراقبة استخدام API لنماذج LLM والتكاليف المرتبطة بها
|
|
- **التحسين المستمر**: جمع الرؤى لتحسين أداء الوكلاء بمرور الوقت
|
|
|
|
## أدوات المراقبة المتاحة
|
|
|
|
### منصات المراقبة والتتبع
|
|
|
|
<CardGroup cols={2}>
|
|
|
|
<Card title="LangDB" icon="database" href="/ar/observability/langdb">
|
|
تتبع شامل لسير عمل CrewAI مع التقاط تلقائي لتفاعلات الوكلاء.
|
|
</Card>
|
|
|
|
<Card title="OpenLIT" icon="magnifying-glass-chart" href="/ar/observability/openlit">
|
|
مراقبة أصلية لـ OpenTelemetry مع تتبع التكاليف وتحليلات الأداء.
|
|
</Card>
|
|
|
|
<Card title="MLflow" icon="bars-staggered" href="/ar/observability/mlflow">
|
|
إدارة دورة حياة تعلم الآلة مع إمكانيات التتبع والتقييم.
|
|
</Card>
|
|
|
|
<Card title="Langfuse" icon="link" href="/ar/observability/langfuse">
|
|
منصة هندسة LLM مع تتبع وتحليلات تفصيلية.
|
|
</Card>
|
|
|
|
<Card title="Langtrace" icon="chart-line" href="/ar/observability/langtrace">
|
|
مراقبة مفتوحة المصدر لنماذج LLM وأطر العمل الوكيلية.
|
|
</Card>
|
|
|
|
<Card title="Arize Phoenix" icon="meteor" href="/ar/observability/arize-phoenix">
|
|
منصة مراقبة الذكاء الاصطناعي للمراقبة واستكشاف الأخطاء وإصلاحها.
|
|
</Card>
|
|
|
|
<Card title="Portkey" icon="key" href="/ar/observability/portkey">
|
|
بوابة ذكاء اصطناعي مع مراقبة شاملة وميزات موثوقية.
|
|
</Card>
|
|
|
|
<Card title="Opik" icon="meteor" href="/ar/observability/opik">
|
|
تصحيح الأخطاء وتقييم ومراقبة تطبيقات LLM مع تتبع شامل.
|
|
</Card>
|
|
|
|
<Card title="Weave" icon="network-wired" href="/ar/observability/weave">
|
|
منصة Weights & Biases لتتبع وتقييم تطبيقات الذكاء الاصطناعي.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
### التقييم وضمان الجودة
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Patronus AI" icon="shield-check" href="/ar/observability/patronus-evaluation">
|
|
منصة تقييم شاملة لمخرجات LLM وسلوكيات الوكلاء.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## مقاييس المراقبة الرئيسية
|
|
|
|
### مقاييس الأداء
|
|
- **وقت التنفيذ**: المدة التي يستغرقها الوكلاء لإكمال المهام
|
|
- **استخدام الرموز المميزة**: الرموز المدخلة/المخرجة المستهلكة من استدعاءات LLM
|
|
- **زمن استجابة API**: أوقات الاستجابة من الخدمات الخارجية
|
|
- **معدل النجاح**: نسبة المهام المكتملة بنجاح
|
|
|
|
### مقاييس الجودة
|
|
- **دقة المخرجات**: صحة استجابات الوكلاء
|
|
- **الاتساق**: الموثوقية عبر مدخلات متشابهة
|
|
- **الصلة**: مدى تطابق المخرجات مع النتائج المتوقعة
|
|
- **السلامة**: الامتثال لسياسات المحتوى والإرشادات
|
|
|
|
### مقاييس التكلفة
|
|
- **تكاليف API**: النفقات من استخدام مزودي LLM
|
|
- **استخدام الموارد**: استهلاك الحوسبة والذاكرة
|
|
- **التكلفة لكل مهمة**: الكفاءة الاقتصادية لعمليات الوكلاء
|
|
- **تتبع الميزانية**: المراقبة مقابل حدود الإنفاق
|
|
|
|
## البدء
|
|
|
|
1. **اختر أدواتك**: حدد منصات المراقبة التي تتوافق مع احتياجاتك
|
|
2. **أضف الأدوات لكودك**: أضف المراقبة لتطبيقات CrewAI الخاصة بك
|
|
3. **أعدّ لوحات المعلومات**: هيئ العروض المرئية للمقاييس الرئيسية
|
|
4. **حدد التنبيهات**: أنشئ إشعارات للأحداث المهمة
|
|
5. **أنشئ خطوط الأساس**: قس الأداء الأولي للمقارنة
|
|
6. **كرر وحسّن**: استخدم الرؤى لتحسين وكلائك
|
|
|
|
## أفضل الممارسات
|
|
|
|
### مرحلة التطوير
|
|
- استخدم التتبع التفصيلي لفهم سلوك الوكلاء
|
|
- طبّق مقاييس التقييم مبكراً في التطوير
|
|
- راقب استخدام الموارد أثناء الاختبار
|
|
- أعدّ فحوصات جودة آلية
|
|
|
|
### مرحلة الإنتاج
|
|
- طبّق مراقبة وتنبيهات شاملة
|
|
- تتبع اتجاهات الأداء بمرور الوقت
|
|
- راقب الشذوذ والتدهور
|
|
- حافظ على رؤية التكاليف والتحكم بها
|
|
|
|
### التحسين المستمر
|
|
- مراجعات أداء وتحسين منتظمة
|
|
- اختبار A/B لتكوينات وكلاء مختلفة
|
|
- حلقات تغذية راجعة لتحسين الجودة
|
|
- توثيق الدروس المستفادة
|
|
|
|
اختر أدوات المراقبة التي تناسب حالة الاستخدام والبنية التحتية ومتطلبات المراقبة الخاصة بك لضمان أن وكلاء CrewAI يعملون بشكل موثوق وفعال.
|