mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
* 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>
181 lines
8.3 KiB
Plaintext
181 lines
8.3 KiB
Plaintext
---
|
|
title: Integração OpenLIT
|
|
description: Comece a monitorar seus Agentes rapidamente com apenas uma linha de código usando OpenTelemetry.
|
|
icon: magnifying-glass-chart
|
|
mode: "wide"
|
|
---
|
|
|
|
# Visão Geral do OpenLIT
|
|
|
|
[OpenLIT](https://github.com/openlit/openlit?src=crewai-docs) é uma ferramenta open-source que simplifica o monitoramento de desempenho de agentes de IA, LLMs, VectorDBs e GPUs com apenas **uma** linha de código.
|
|
|
|
Ela oferece rastreamento e métricas nativos do OpenTelemetry para acompanhar parâmetros importantes como custo, latência, interações e sequências de tarefas.
|
|
Essa configuração permite acompanhar hiperparâmetros e monitorar problemas de desempenho, ajudando a encontrar formas de aprimorar e refinar seus agentes com o tempo.
|
|
|
|
<Frame caption="Painel do OpenLIT">
|
|
<img src="/images/openlit1.png" alt="Visão geral do uso de agentes, incluindo custo e tokens" />
|
|
<img src="/images/openlit2.png" alt="Visão geral dos rastreamentos e métricas otel do agente" />
|
|
<img src="/images/openlit3.png" alt="Visão detalhada dos rastreamentos do agente" />
|
|
</Frame>
|
|
|
|
### Funcionalidades
|
|
|
|
- **Painel Analítico**: Monitore a saúde e desempenho dos seus Agentes com dashboards detalhados que acompanham métricas, custos e interações dos usuários.
|
|
- **SDK de Observabilidade Nativo OpenTelemetry**: SDKs neutros de fornecedor para enviar rastreamentos e métricas para suas ferramentas de observabilidade existentes como Grafana, DataDog e outros.
|
|
- **Rastreamento de Custos para Modelos Customizados e Ajustados**: Adapte estimativas de custo para modelos específicos usando arquivos de precificação customizados para orçamentos precisos.
|
|
- **Painel de Monitoramento de Exceções**: Identifique e solucione rapidamente problemas ao rastrear exceções comuns e erros por meio de um painel de monitoramento.
|
|
- **Conformidade e Segurança**: Detecte ameaças potenciais como profanidade e vazamento de dados sensíveis (PII).
|
|
- **Detecção de Prompt Injection**: Identifique possíveis injeções de código e vazamentos de segredos.
|
|
- **Gerenciamento de Chaves de API e Segredos**: Gerencie suas chaves de API e segredos do LLM de forma centralizada e segura, evitando práticas inseguras.
|
|
- **Gerenciamento de Prompt**: Gerencie e versiona prompts de Agente usando o PromptHub para acesso consistente e fácil entre os agentes.
|
|
- **Model Playground** Teste e compare diferentes modelos para seus agentes CrewAI antes da implantação.
|
|
|
|
## Instruções de Configuração
|
|
|
|
<Steps>
|
|
<Step title="Implantar o OpenLIT">
|
|
<Steps>
|
|
<Step title="Clonar o Repositório do OpenLIT">
|
|
```shell
|
|
git clone git@github.com:openlit/openlit.git
|
|
```
|
|
</Step>
|
|
<Step title="Iniciar o Docker Compose">
|
|
A partir do diretório raiz do [Repositório OpenLIT](https://github.com/openlit/openlit), execute o comando abaixo:
|
|
```shell
|
|
docker compose up -d
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
</Step>
|
|
<Step title="Instalar o SDK OpenLIT">
|
|
```shell
|
|
pip install openlit
|
|
```
|
|
</Step>
|
|
<Step title="Inicializar o OpenLIT em Sua Aplicação">
|
|
Adicione as duas linhas abaixo ao seu código de aplicação:
|
|
<Tabs>
|
|
<Tab title="Configuração usando argumentos de função">
|
|
```python
|
|
import openlit
|
|
openlit.init(otlp_endpoint="http://127.0.0.1:4318")
|
|
```
|
|
|
|
Exemplo de uso para monitoramento de um Agente CrewAI:
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
import openlit
|
|
|
|
openlit.init(disable_metrics=True)
|
|
# Definir seus agentes
|
|
pesquisador = Agent(
|
|
role="Pesquisador",
|
|
goal="Realizar pesquisas e análises aprofundadas sobre IA e agentes de IA",
|
|
backstory="Você é um pesquisador especialista em tecnologia, engenharia de software, IA e startups. Trabalha como freelancer e está atualmente pesquisando para um novo cliente.",
|
|
allow_delegation=False,
|
|
llm='command-r'
|
|
)
|
|
|
|
|
|
# Definir sua task
|
|
task = Task(
|
|
description="Gere uma lista com 5 ideias interessantes para um artigo e escreva um parágrafo cativante para cada ideia, mostrando o potencial de um artigo completo sobre o tema. Retorne a lista de ideias com seus parágrafos e suas anotações.",
|
|
expected_output="5 tópicos, cada um com um parágrafo e notas complementares.",
|
|
)
|
|
|
|
# Definir o agente gerente
|
|
gerente = Agent(
|
|
role="Gerente de Projeto",
|
|
goal="Gerenciar eficientemente a equipe e garantir a conclusão de tarefas de alta qualidade",
|
|
backstory="Você é um gerente de projetos experiente, habilidoso em supervisionar projetos complexos e guiar equipes para o sucesso. Sua função é coordenar os esforços dos membros da equipe, garantindo que cada tarefa seja concluída no prazo e com o mais alto padrão.",
|
|
allow_delegation=True,
|
|
llm='command-r'
|
|
)
|
|
|
|
# Instanciar sua crew com um manager personalizado
|
|
crew = Crew(
|
|
agents=[pesquisador],
|
|
tasks=[task],
|
|
manager_agent=gerente,
|
|
process=Process.hierarchical,
|
|
)
|
|
|
|
# Iniciar o trabalho da crew
|
|
result = crew.kickoff()
|
|
|
|
print(result)
|
|
```
|
|
</Tab>
|
|
<Tab title="Configuração usando Variáveis de Ambiente">
|
|
|
|
Adicione as duas linhas abaixo ao seu código de aplicação:
|
|
```python
|
|
import openlit
|
|
|
|
openlit.init()
|
|
```
|
|
|
|
Execute o seguinte comando para configurar o endpoint de exportação OTEL:
|
|
```shell
|
|
export OTEL_EXPORTER_OTLP_ENDPOINT = "http://127.0.0.1:4318"
|
|
```
|
|
|
|
Exemplo de uso para monitoramento de um Agente CrewAI Async:
|
|
|
|
```python
|
|
import asyncio
|
|
from crewai import Crew, Agent, Task
|
|
import openlit
|
|
|
|
openlit.init(otlp_endpoint="http://127.0.0.1:4318")
|
|
|
|
# Criar um agente com execução de código habilitada
|
|
coding_agent = Agent(
|
|
role="Analista de Dados Python",
|
|
goal="Analisar dados e fornecer insights usando Python",
|
|
backstory="Você é um analista de dados experiente com fortes habilidades em Python.",
|
|
allow_code_execution=True,
|
|
llm="command-r"
|
|
)
|
|
|
|
# Criar uma task que exige execução de código
|
|
data_analysis_task = Task(
|
|
description="Analise o conjunto de dados fornecido e calcule a idade média dos participantes. Idades: {ages}",
|
|
agent=coding_agent,
|
|
expected_output="5 tópicos, cada um com um parágrafo e notas complementares.",
|
|
)
|
|
|
|
# Criar uma crew e adicionar a task
|
|
analysis_crew = Crew(
|
|
agents=[coding_agent],
|
|
tasks=[data_analysis_task]
|
|
)
|
|
|
|
# Função async para iniciar a crew de forma assíncrona
|
|
async def async_crew_execution():
|
|
result = await analysis_crew.kickoff_async(inputs={"ages": [25, 30, 35, 40, 45]})
|
|
print("Crew Result:", result)
|
|
|
|
# Executar a função async
|
|
asyncio.run(async_crew_execution())
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
Consulte o [repositório do SDK Python do OpenLIT](https://github.com/openlit/openlit/tree/main/sdk/python) para configurações e casos de uso avançados.
|
|
</Step>
|
|
<Step title="Visualizar e Analisar">
|
|
Com os dados de Observabilidade dos Agentes agora sendo coletados e enviados ao OpenLIT, o próximo passo é visualizar e analisar esses dados para obter insights sobre o desempenho, comportamento e identificar oportunidades de melhoria dos seus Agentes.
|
|
|
|
Basta acessar o OpenLIT em `127.0.0.1:3000` no seu navegador para começar a explorar. Você pode fazer login usando as credenciais padrão
|
|
- **Email**: `user@openlit.io`
|
|
- **Senha**: `openlituser`
|
|
|
|
<Frame caption="Painel do OpenLIT">
|
|
<img src="/images/openlit1.png" alt="Visão geral do uso de agentes, incluindo custo e tokens" />
|
|
<img src="/images/openlit2.png" alt="Visão geral dos rastreamentos e métricas otel do agente" />
|
|
</Frame>
|
|
|
|
</Step>
|
|
</Steps> |