diff --git a/docs/docs.json b/docs/docs.json index 84eed2947..57a7dc2f1 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -1366,6 +1366,7 @@ "pt-BR/enterprise/guides/kickoff-crew", "pt-BR/enterprise/guides/update-crew", "pt-BR/enterprise/guides/enable-crew-studio", + "pt-BR/enterprise/guides/capture_telemetry_logs", "pt-BR/enterprise/guides/azure-openai-setup", "pt-BR/enterprise/guides/tool-repository", "pt-BR/enterprise/guides/react-component-export", @@ -1803,6 +1804,7 @@ "pt-BR/enterprise/guides/kickoff-crew", "pt-BR/enterprise/guides/update-crew", "pt-BR/enterprise/guides/enable-crew-studio", + "pt-BR/enterprise/guides/capture_telemetry_logs", "pt-BR/enterprise/guides/azure-openai-setup", "pt-BR/enterprise/guides/tool-repository", "pt-BR/enterprise/guides/react-component-export", @@ -2282,6 +2284,7 @@ "ko/enterprise/guides/kickoff-crew", "ko/enterprise/guides/update-crew", "ko/enterprise/guides/enable-crew-studio", + "ko/enterprise/guides/capture_telemetry_logs", "ko/enterprise/guides/azure-openai-setup", "ko/enterprise/guides/tool-repository", "ko/enterprise/guides/react-component-export", @@ -2731,6 +2734,7 @@ "ko/enterprise/guides/kickoff-crew", "ko/enterprise/guides/update-crew", "ko/enterprise/guides/enable-crew-studio", + "ko/enterprise/guides/capture_telemetry_logs", "ko/enterprise/guides/azure-openai-setup", "ko/enterprise/guides/tool-repository", "ko/enterprise/guides/react-component-export", diff --git a/docs/en/enterprise/guides/capture_telemetry_logs.mdx b/docs/en/enterprise/guides/capture_telemetry_logs.mdx index 597853772..c9288c942 100644 --- a/docs/en/enterprise/guides/capture_telemetry_logs.mdx +++ b/docs/en/enterprise/guides/capture_telemetry_logs.mdx @@ -1,30 +1,39 @@ --- -title: "Open Telemetry Logs" -description: "Understand how to capture telemetry logs from your CrewAI AMP deployments" +title: "OpenTelemetry Export" +description: "Export traces and logs from your CrewAI AMP deployments to your own OpenTelemetry collector" icon: "magnifying-glass-chart" mode: "wide" --- -CrewAI AMP provides a powerful way to capture telemetry logs from your deployments. This allows you to monitor the performance of your agents and workflows, and to debug issues that may arise. +CrewAI AMP can export OpenTelemetry **traces** and **logs** from your deployments directly to your own collector. This lets you monitor agent performance, track LLM calls, and debug issues using your existing observability stack. + +Telemetry data follows the [OpenTelemetry GenAI semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/) plus additional CrewAI-specific attributes. ## Prerequisites - - Your organization should have ENTERPRISE OTEL SETUP enabled + + Your organization must have an active CrewAI AMP account. - - Your organization should have an OTEL collector setup or a provider like - Datadog log intake setup + + You need an OpenTelemetry-compatible collector endpoint (e.g., your own OTel Collector, Datadog, Grafana, or any OTLP-compatible backend). -## How to capture telemetry logs +## Setting up a collector -1. Go to settings/organization tab -2. Configure your OTEL collector setup -3. Save +1. In CrewAI AMP, go to **Settings** > **OpenTelemetry Collectors**. +2. Click **Add Collector**. +3. Select an integration type — **OpenTelemetry Traces** or **OpenTelemetry Logs**. +4. Configure the connection: + - **Endpoint** — Your collector's OTLP endpoint (e.g., `https://otel-collector.example.com:4317`). + - **Service Name** — A name to identify this service in your observability platform. + - **Custom Headers** *(optional)* — Add authentication or routing headers as key-value pairs. + - **Certificate** *(optional)* — Provide a TLS certificate if your collector requires one. +5. Click **Save**. -Example to setup OTEL log collection capture to Datadog. +![OpenTelemetry Collector Configuration](/images/crewai-otel-collector-config.png) -![Capture Telemetry Logs](/images/crewai-otel-export.png) + + You can add multiple collectors — for example, one for traces and another for logs, or send to different backends for different purposes. + diff --git a/docs/images/crewai-otel-collector-config.png b/docs/images/crewai-otel-collector-config.png new file mode 100644 index 000000000..55639a1dd Binary files /dev/null and b/docs/images/crewai-otel-collector-config.png differ diff --git a/docs/images/crewai-otel-export.png b/docs/images/crewai-otel-export.png deleted file mode 100644 index 73b7b6d25..000000000 Binary files a/docs/images/crewai-otel-export.png and /dev/null differ diff --git a/docs/ko/enterprise/guides/capture_telemetry_logs.mdx b/docs/ko/enterprise/guides/capture_telemetry_logs.mdx new file mode 100644 index 000000000..459d7b2c5 --- /dev/null +++ b/docs/ko/enterprise/guides/capture_telemetry_logs.mdx @@ -0,0 +1,39 @@ +--- +title: "OpenTelemetry 내보내기" +description: "CrewAI AMP 배포에서 자체 OpenTelemetry 수집기로 트레이스와 로그를 내보내기" +icon: "magnifying-glass-chart" +mode: "wide" +--- + +CrewAI AMP는 배포에서 OpenTelemetry **트레이스**와 **로그**를 자체 수집기로 직접 내보낼 수 있습니다. 이를 통해 기존 관측 가능성 스택을 사용하여 에이전트 성능을 모니터링하고, LLM 호출을 추적하고, 문제를 디버깅할 수 있습니다. + +텔레메트리 데이터는 [OpenTelemetry GenAI 시맨틱 규칙](https://opentelemetry.io/docs/specs/semconv/gen-ai/)과 추가적인 CrewAI 전용 속성을 따릅니다. + +## 사전 요구 사항 + + + + 조직에 활성 CrewAI AMP 계정이 있어야 합니다. + + + OpenTelemetry 호환 수집기 엔드포인트가 필요합니다 (예: 자체 OTel Collector, Datadog, Grafana 또는 OTLP 호환 백엔드). + + + +## 수집기 설정 + +1. CrewAI AMP에서 **Settings** > **OpenTelemetry Collectors**로 이동합니다. +2. **Add Collector**를 클릭합니다. +3. 통합 유형을 선택합니다 — **OpenTelemetry Traces** 또는 **OpenTelemetry Logs**. +4. 연결을 구성합니다: + - **Endpoint** — 수집기의 OTLP 엔드포인트 (예: `https://otel-collector.example.com:4317`). + - **Service Name** — 관측 가능성 플랫폼에서 이 서비스를 식별하기 위한 이름. + - **Custom Headers** *(선택 사항)* — 인증 또는 라우팅 헤더를 키-값 쌍으로 추가합니다. + - **Certificate** *(선택 사항)* — 수집기에서 TLS 인증서가 필요한 경우 제공합니다. +5. **Save**를 클릭합니다. + +![OpenTelemetry 수집기 구성](/images/crewai-otel-collector-config.png) + + + 여러 수집기를 추가할 수 있습니다 — 예를 들어, 트레이스용 하나와 로그용 하나를 추가하거나, 다른 목적을 위해 다른 백엔드로 전송할 수 있습니다. + diff --git a/docs/pt-BR/enterprise/guides/capture_telemetry_logs.mdx b/docs/pt-BR/enterprise/guides/capture_telemetry_logs.mdx new file mode 100644 index 000000000..5efa60f46 --- /dev/null +++ b/docs/pt-BR/enterprise/guides/capture_telemetry_logs.mdx @@ -0,0 +1,39 @@ +--- +title: "Exportação OpenTelemetry" +description: "Exporte traces e logs das suas implantações CrewAI AMP para seu próprio coletor OpenTelemetry" +icon: "magnifying-glass-chart" +mode: "wide" +--- + +O CrewAI AMP pode exportar **traces** e **logs** do OpenTelemetry das suas implantações diretamente para seu próprio coletor. Isso permite que você monitore o desempenho dos agentes, rastreie chamadas de LLM e depure problemas usando sua stack de observabilidade existente. + +Os dados de telemetria seguem as [convenções semânticas GenAI do OpenTelemetry](https://opentelemetry.io/docs/specs/semconv/gen-ai/) além de atributos adicionais específicos do CrewAI. + +## Pré-requisitos + + + + Sua organização deve ter uma conta CrewAI AMP ativa. + + + Você precisa de um endpoint de coletor compatível com OpenTelemetry (por exemplo, seu próprio OTel Collector, Datadog, Grafana ou qualquer backend compatível com OTLP). + + + +## Configurando um coletor + +1. No CrewAI AMP, vá para **Settings** > **OpenTelemetry Collectors**. +2. Clique em **Add Collector**. +3. Selecione um tipo de integração — **OpenTelemetry Traces** ou **OpenTelemetry Logs**. +4. Configure a conexão: + - **Endpoint** — O endpoint OTLP do seu coletor (por exemplo, `https://otel-collector.example.com:4317`). + - **Service Name** — Um nome para identificar este serviço na sua plataforma de observabilidade. + - **Custom Headers** *(opcional)* — Adicione headers de autenticação ou roteamento como pares chave-valor. + - **Certificate** *(opcional)* — Forneça um certificado TLS se o seu coletor exigir um. +5. Clique em **Save**. + +![Configuração do Coletor OpenTelemetry](/images/crewai-otel-collector-config.png) + + + Você pode adicionar múltiplos coletores — por exemplo, um para traces e outro para logs, ou enviar para diferentes backends para diferentes propósitos. +