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>
149 lines
6.9 KiB
Plaintext
149 lines
6.9 KiB
Plaintext
---
|
|
title: التتبعات
|
|
description: "استخدام التتبعات لمراقبة طواقمك"
|
|
icon: "timeline"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
توفر التتبعات رؤية شاملة لعمليات تنفيذ طواقمك، مما يساعدك على مراقبة الأداء وتصحيح الأخطاء وتحسين سير عمل وكلاء الذكاء الاصطناعي.
|
|
|
|
## ما هي التتبعات؟
|
|
|
|
التتبعات في CrewAI AMP هي سجلات تنفيذ مفصلة تلتقط كل جانب من جوانب عمل طاقمك، من المدخلات الأولية إلى المخرجات النهائية. تسجل:
|
|
|
|
- أفكار الوكلاء واستدلالاتهم
|
|
- تفاصيل تنفيذ المهام
|
|
- استخدام الأدوات ومخرجاتها
|
|
- مقاييس استهلاك الرموز
|
|
- أوقات التنفيذ
|
|
- تقديرات التكلفة
|
|
|
|
<Frame></Frame>
|
|
|
|
## الوصول إلى التتبعات
|
|
|
|
<Steps>
|
|
<Step title="الانتقال إلى علامة تبويب التتبعات">
|
|
في لوحة تحكم CrewAI AMP، انقر على **Traces** لعرض جميع سجلات التنفيذ.
|
|
</Step>
|
|
|
|
<Step title="اختيار عملية تنفيذ">
|
|
سترى قائمة بجميع عمليات تنفيذ الطاقم، مرتبة حسب التاريخ. انقر على أي عملية تنفيذ لعرض تتبعها المفصل.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## فهم واجهة التتبع
|
|
|
|
تنقسم واجهة التتبع إلى عدة أقسام، يقدم كل منها رؤى مختلفة حول تنفيذ طاقمك:
|
|
|
|
### 1. ملخص التنفيذ
|
|
|
|
يعرض القسم العلوي مقاييس عالية المستوى حول التنفيذ:
|
|
|
|
- **إجمالي الرموز**: عدد الرموز المستهلكة عبر جميع المهام
|
|
- **رموز الطلب**: الرموز المستخدمة في الطلبات إلى LLM
|
|
- **رموز الإكمال**: الرموز المُنشأة في استجابات LLM
|
|
- **الطلبات**: عدد استدعاءات API المُجراة
|
|
- **وقت التنفيذ**: المدة الإجمالية لتشغيل الطاقم
|
|
- **التكلفة المقدرة**: التكلفة التقريبية بناءً على استخدام الرموز
|
|
|
|
<Frame></Frame>
|
|
|
|
### 2. المهام والوكلاء
|
|
|
|
يعرض هذا القسم جميع المهام والوكلاء الذين كانوا جزءاً من تنفيذ الطاقم:
|
|
|
|
- اسم المهمة وتعيين الوكيل
|
|
- الوكلاء ونماذج LLM المستخدمة لكل مهمة
|
|
- الحالة (مكتملة/فاشلة)
|
|
- وقت التنفيذ الفردي للمهمة
|
|
|
|
<Frame></Frame>
|
|
|
|
### 3. المخرجات النهائية
|
|
|
|
يعرض النتيجة النهائية التي أنتجها الطاقم بعد اكتمال جميع المهام.
|
|
|
|
<Frame></Frame>
|
|
|
|
### 4. الجدول الزمني للتنفيذ
|
|
|
|
تمثيل مرئي لوقت بدء وانتهاء كل مهمة، يساعدك على تحديد نقاط الاختناق أو أنماط التنفيذ المتوازي.
|
|
|
|
<Frame></Frame>
|
|
|
|
### 5. عرض المهمة المفصل
|
|
|
|
عند النقر على مهمة محددة في الجدول الزمني أو قائمة المهام، سترى:
|
|
|
|
<Frame></Frame>
|
|
|
|
- **مفتاح المهمة**: معرّف فريد للمهمة
|
|
- **معرّف المهمة**: معرّف تقني في النظام
|
|
- **الحالة**: الحالة الحالية (مكتملة/قيد التشغيل/فاشلة)
|
|
- **الوكيل**: الوكيل الذي نفّذ المهمة
|
|
- **LLM**: نموذج اللغة المستخدم لهذه المهمة
|
|
- **وقت البدء/الانتهاء**: متى بدأت المهمة واكتملت
|
|
- **وقت التنفيذ**: مدة هذه المهمة المحددة
|
|
- **وصف المهمة**: ما طُلب من الوكيل تنفيذه
|
|
- **المخرجات المتوقعة**: تنسيق المخرجات المطلوب
|
|
- **المدخلات**: أي مدخلات مقدمة لهذه المهمة من مهام سابقة
|
|
- **المخرجات**: النتيجة الفعلية التي أنتجها الوكيل
|
|
|
|
## استخدام التتبعات لتصحيح الأخطاء
|
|
|
|
التتبعات لا تقدر بثمن لاستكشاف المشكلات في طواقمك:
|
|
|
|
<Steps>
|
|
<Step title="تحديد نقاط الفشل">
|
|
عندما لا ينتج تنفيذ الطاقم النتائج المتوقعة، افحص التتبع لمعرفة أين حدث الخطأ. ابحث عن:
|
|
|
|
- المهام الفاشلة
|
|
- قرارات الوكيل غير المتوقعة
|
|
- أخطاء استخدام الأدوات
|
|
- التعليمات المُساء فهمها
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="تحسين الأداء">
|
|
استخدم مقاييس التنفيذ لتحديد نقاط اختناق الأداء:
|
|
|
|
- المهام التي استغرقت وقتاً أطول من المتوقع
|
|
- الاستخدام المفرط للرموز
|
|
- عمليات الأدوات المكررة
|
|
- استدعاءات API غير الضرورية
|
|
|
|
</Step>
|
|
|
|
<Step title="تحسين كفاءة التكلفة">
|
|
حلل استخدام الرموز وتقديرات التكلفة لتحسين كفاءة طاقمك:
|
|
|
|
- فكّر في استخدام نماذج أصغر للمهام الأبسط
|
|
- صقل الطلبات لتكون أكثر إيجازاً
|
|
- خزّن المعلومات المُوصول إليها بشكل متكرر مؤقتاً
|
|
- نظّم المهام لتقليل العمليات المكررة
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## الأداء والتجميع
|
|
|
|
يجمّع CrewAI تحميلات التتبع لتقليل العبء في عمليات التشغيل ذات الحجم الكبير:
|
|
|
|
- يقوم TraceBatchManager بتخزين الأحداث مؤقتاً وإرسالها في دفعات عبر عميل Plus API
|
|
- يقلل حركة الشبكة ويحسّن الموثوقية في الاتصالات غير المستقرة
|
|
- يُفعّل تلقائياً في مستمع التتبع الافتراضي؛ لا حاجة لتهيئة
|
|
|
|
يوفر ذلك تتبعاً أكثر استقراراً تحت الحمل مع الحفاظ على بيانات القياس المفصلة للمهام/الوكلاء.
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للمساعدة في تحليل التتبعات أو أي ميزات أخرى في
|
|
CrewAI AMP.
|
|
</Card>
|