Skip to content

Commit fa89ac4

Browse files
authored
docs: add Datadog integration guide with importable operations dashboard (#6225)
Adds a consolidated `datadog.mdx` under `docs/edge/{en,pt-BR,ko,ar}/enterprise/guides/` covering both the Datadog Agent path (stdout JSON logs via `CREWAI_LOG_FORMAT=json`) and the Datadog OTLP intake, with a JSON log schema reference and a ready-to-import operations dashboard (`datadog_dashboard.json`). Reframes `capture_telemetry_logs.mdx` to lead with OpenTelemetry as the vendor-neutral path and point readers to the new Datadog page for that ecosystem's setup.
1 parent b0816e0 commit fa89ac4

10 files changed

Lines changed: 1782 additions & 44 deletions

File tree

docs/docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,7 @@
515515
"edge/en/enterprise/guides/update-crew",
516516
"edge/en/enterprise/guides/enable-crew-studio",
517517
"edge/en/enterprise/guides/capture_telemetry_logs",
518+
"edge/en/enterprise/guides/datadog",
518519
"edge/en/enterprise/guides/azure-openai-setup",
519520
"edge/en/enterprise/guides/vertex-ai-workload-identity-setup",
520521
"edge/en/enterprise/guides/tool-repository",
@@ -8647,6 +8648,7 @@
86478648
"edge/pt-BR/enterprise/guides/update-crew",
86488649
"edge/pt-BR/enterprise/guides/enable-crew-studio",
86498650
"edge/pt-BR/enterprise/guides/capture_telemetry_logs",
8651+
"edge/pt-BR/enterprise/guides/datadog",
86508652
"edge/pt-BR/enterprise/guides/azure-openai-setup",
86518653
"edge/pt-BR/enterprise/guides/tool-repository",
86528654
"edge/pt-BR/enterprise/guides/custom-mcp-server",
@@ -16510,6 +16512,7 @@
1651016512
"edge/ko/enterprise/guides/update-crew",
1651116513
"edge/ko/enterprise/guides/enable-crew-studio",
1651216514
"edge/ko/enterprise/guides/capture_telemetry_logs",
16515+
"edge/ko/enterprise/guides/datadog",
1651316516
"edge/ko/enterprise/guides/azure-openai-setup",
1651416517
"edge/ko/enterprise/guides/tool-repository",
1651516518
"edge/ko/enterprise/guides/custom-mcp-server",
@@ -24565,6 +24568,7 @@
2456524568
"edge/ar/enterprise/guides/update-crew",
2456624569
"edge/ar/enterprise/guides/enable-crew-studio",
2456724570
"edge/ar/enterprise/guides/capture_telemetry_logs",
24571+
"edge/ar/enterprise/guides/datadog",
2456824572
"edge/ar/enterprise/guides/azure-openai-setup",
2456924573
"edge/ar/enterprise/guides/tool-repository",
2457024574
"edge/ar/enterprise/guides/custom-mcp-server",

docs/edge/ar/enterprise/guides/capture_telemetry_logs.mdx

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ mode: "wide"
99

1010
تتبع بيانات القياس [اتفاقيات OpenTelemetry GenAI الدلالية](https://opentelemetry.io/docs/specs/semconv/gen-ai/) بالإضافة إلى سمات خاصة بـ CrewAI.
1111

12+
<Tip>
13+
تُعدّ OpenTelemetry **مسار المراقبة الموصى به** — محايدة تجاه الموردين، وتعمل مع أي خلفية متوافقة مع OTLP (Grafana, Honeycomb, NewRelic، أو مجمّعك الخاص). إذا كنت تستخدم Datadog تحديدًا، فراجع دليل [تكامل Datadog](./datadog) المخصص، الذي يغطي كلًا من مسار وكيل Datadog واستيعاب OTLP من Datadog.
14+
</Tip>
15+
1216
## المتطلبات المسبقة
1317

1418
<CardGroup cols={2}>
@@ -41,17 +45,7 @@ mode: "wide"
4145
<Frame>![تهيئة مجمّع OpenTelemetry](/images/crewai-otel-collector-opentelemetry.png)</Frame>
4246
</Tab>
4347
<Tab title="Datadog">
44-
- **Datadog Site Domain** — مضيف OTLP لموقع Datadog الخاص بك فقط، دون بروتوكول أو مسار. يقوم CrewAI ببناء نقطة نهاية HTTPS OTLP الكاملة نيابةً عنك. استخدم المضيف المطابق لـ [موقع Datadog](https://docs.datadoghq.com/getting_started/site/) الخاص بك:
45-
- `otlp.datadoghq.com` (US1)
46-
- `otlp.us3.datadoghq.com` (US3)
47-
- `otlp.us5.datadoghq.com` (US5)
48-
- `otlp.datadoghq.eu` (EU1)
49-
- `otlp.ap1.datadoghq.com` (AP1)
50-
- **API Key** — مفتاح واجهة برمجة تطبيقات Datadog الخاص بك. راجع [كيفية إنشاء واحد](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys).
51-
52-
يصدّر تكامل Datadog **التتبعات**.
53-
54-
<Frame>![تهيئة مجمّع Datadog](/images/crewai-otel-collector-datadog.png)</Frame>
48+
لإعداد Datadog، راجع دليل [تكامل Datadog](./datadog) المخصص — فهو يغطي كلًا من مسار وكيل Datadog (الموصى به، أرخص لحجم السجلات الكبير) واستيعاب OTLP من Datadog، مع خطوات تهيئة كاملة للمجمّع.
5549
</Tab>
5650
</Tabs>
5751

docs/edge/ar/enterprise/guides/datadog.mdx

Lines changed: 295 additions & 0 deletions
Large diffs are not rendered by default.

docs/edge/en/enterprise/guides/capture_telemetry_logs.mdx

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ CrewAI AMP can export OpenTelemetry **traces** and **logs** from your deployment
99

1010
Telemetry data follows the [OpenTelemetry GenAI semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/) plus additional CrewAI-specific attributes.
1111

12+
<Tip>
13+
OpenTelemetry is the **recommended observability path** — vendor-neutral, works with any OTLP-compatible backend (Grafana, Honeycomb, NewRelic, your own collector). If you specifically use Datadog, see the dedicated [Datadog Integration](./datadog) guide which covers both the Datadog Agent path and Datadog's OTLP intake.
14+
</Tip>
15+
1216
## Prerequisites
1317

1418
<CardGroup cols={2}>
@@ -41,17 +45,7 @@ Telemetry data follows the [OpenTelemetry GenAI semantic conventions](https://op
4145
<Frame>![OpenTelemetry collector configuration](/images/crewai-otel-collector-opentelemetry.png)</Frame>
4246
</Tab>
4347
<Tab title="Datadog">
44-
- **Datadog Site Domain** — Your Datadog site's OTLP host only, with no protocol or path. CrewAI builds the full HTTPS OTLP endpoint for you. Use the host that matches your [Datadog site](https://docs.datadoghq.com/getting_started/site/):
45-
- `otlp.datadoghq.com` (US1)
46-
- `otlp.us3.datadoghq.com` (US3)
47-
- `otlp.us5.datadoghq.com` (US5)
48-
- `otlp.datadoghq.eu` (EU1)
49-
- `otlp.ap1.datadoghq.com` (AP1)
50-
- **API Key** — Your Datadog API key. See [how to create one](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys).
51-
52-
The Datadog integration exports **traces**.
53-
54-
<Frame>![Datadog collector configuration](/images/crewai-otel-collector-datadog.png)</Frame>
48+
For Datadog setup, see the dedicated [Datadog Integration](./datadog) guide — it covers both the Datadog Agent path (recommended, cheaper for log volume) and Datadog's OTLP intake with full collector configuration steps.
5549
</Tab>
5650
</Tabs>
5751

0 commit comments

Comments
 (0)