mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
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>
110 lines
4.7 KiB
Plaintext
110 lines
4.7 KiB
Plaintext
---
|
|
title: تكامل Datadog
|
|
description: تعلم كيفية دمج Datadog مع CrewAI لإرسال تتبعات مراقبة LLM إلى Datadog.
|
|
icon: dog
|
|
mode: "wide"
|
|
---
|
|
|
|
# دمج Datadog مع CrewAI
|
|
|
|
سيوضح هذا الدليل كيفية دمج **[Datadog LLM Observability](https://docs.datadoghq.com/llm_observability/)** مع **CrewAI** باستخدام [أداة Datadog للتجهيز التلقائي](https://docs.datadoghq.com/llm_observability/instrumentation/auto_instrumentation?tab=python). بنهاية هذا الدليل، ستتمكن من إرسال تتبعات مراقبة LLM إلى Datadog وعرض تشغيلات وكلاء CrewAI في [عرض التنفيذ الوكيلي](https://docs.datadoghq.com/llm_observability/monitoring/agent_monitoring) من Datadog LLM Observability.
|
|
|
|
## ما هو Datadog LLM Observability؟
|
|
|
|
[Datadog LLM Observability](https://www.datadoghq.com/product/llm-observability/) يساعد مهندسي الذكاء الاصطناعي وعلماء البيانات ومطوري التطبيقات على تطوير وتقييم ومراقبة تطبيقات LLM بسرعة. حسّن جودة المخرجات والأداء والتكاليف والمخاطر الإجمالية بثقة مع تجارب منظمة وتتبع شامل عبر وكلاء الذكاء الاصطناعي والتقييمات.
|
|
|
|
## البدء
|
|
|
|
### تثبيت الاعتماديات
|
|
|
|
```shell
|
|
pip install ddtrace crewai crewai-tools
|
|
```
|
|
|
|
### تعيين متغيرات البيئة
|
|
|
|
إذا لم يكن لديك مفتاح API من Datadog، يمكنك [إنشاء حساب](https://www.datadoghq.com/) و[الحصول على مفتاح API](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys).
|
|
|
|
ستحتاج أيضاً إلى تحديد اسم تطبيق ML في متغيرات البيئة التالية. تطبيق ML هو تجميع لتتبعات LLM Observability المرتبطة بتطبيق محدد قائم على LLM.
|
|
|
|
```shell
|
|
export DD_API_KEY=<YOUR_DD_API_KEY>
|
|
export DD_SITE=<YOUR_DD_SITE>
|
|
export DD_LLMOBS_ENABLED=true
|
|
export DD_LLMOBS_ML_APP=<YOUR_ML_APP_NAME>
|
|
export DD_LLMOBS_AGENTLESS_ENABLED=true
|
|
export DD_APM_TRACING_ENABLED=false
|
|
```
|
|
|
|
بالإضافة إلى ذلك، قم بإعداد مفاتيح API لمزودي LLM
|
|
|
|
```shell
|
|
export OPENAI_API_KEY=<YOUR_OPENAI_API_KEY>
|
|
export ANTHROPIC_API_KEY=<YOUR_ANTHROPIC_API_KEY>
|
|
export GEMINI_API_KEY=<YOUR_GEMINI_API_KEY>
|
|
...
|
|
```
|
|
|
|
### إنشاء تطبيق وكيل CrewAI
|
|
|
|
```python
|
|
# crewai_agent.py
|
|
from crewai import Agent, Task, Crew
|
|
|
|
from crewai_tools import (
|
|
WebsiteSearchTool
|
|
)
|
|
|
|
web_rag_tool = WebsiteSearchTool()
|
|
|
|
writer = Agent(
|
|
role="Writer",
|
|
goal="You make math engaging and understandable for young children through poetry",
|
|
backstory="You're an expert in writing haikus but you know nothing of math.",
|
|
tools=[web_rag_tool],
|
|
)
|
|
|
|
task = Task(
|
|
description=("What is {multiplication}?"),
|
|
expected_output=("Compose a haiku that includes the answer."),
|
|
agent=writer
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[writer],
|
|
tasks=[task],
|
|
share_crew=False
|
|
)
|
|
|
|
output = crew.kickoff(dict(multiplication="2 * 2"))
|
|
```
|
|
|
|
### تشغيل التطبيق مع التجهيز التلقائي من Datadog
|
|
|
|
مع تعيين [متغيرات البيئة](#تعيين-متغيرات-البيئة)، يمكنك الآن تشغيل التطبيق مع التجهيز التلقائي من Datadog.
|
|
|
|
```shell
|
|
ddtrace-run python crewai_agent.py
|
|
```
|
|
|
|
### عرض التتبعات في Datadog
|
|
|
|
بعد تشغيل التطبيق، يمكنك عرض التتبعات في [عرض تتبعات Datadog LLM Observability](https://app.datadoghq.com/llm/traces)، باختيار اسم تطبيق ML الذي اخترته من القائمة المنسدلة أعلى اليسار.
|
|
|
|
النقر على تتبع سيعرض لك تفاصيل التتبع، بما في ذلك إجمالي الرموز المستخدمة وعدد استدعاءات LLM والنماذج المستخدمة والتكلفة المقدرة.
|
|
|
|
<Frame>
|
|
<img src="/images/datadog-llm-observability-1.png" alt="عرض تتبع Datadog LLM Observability" />
|
|
</Frame>
|
|
|
|
بالإضافة إلى ذلك، يمكنك عرض رسم بياني لتنفيذ التتبع، الذي يوضح تدفق التحكم والبيانات للتتبع.
|
|
|
|
<Frame>
|
|
<img src="/images/datadog-llm-observability-2.png" alt="عرض تدفق تنفيذ وكيل Datadog LLM Observability" />
|
|
</Frame>
|
|
|
|
## المراجع
|
|
|
|
- [Datadog LLM Observability](https://www.datadoghq.com/product/llm-observability/)
|
|
- [التجهيز التلقائي لـ CrewAI من Datadog LLM Observability](https://docs.datadoghq.com/llm_observability/instrumentation/auto_instrumentation?tab=python#crew-ai)
|