mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 06:08:15 +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>
116 lines
3.8 KiB
Plaintext
116 lines
3.8 KiB
Plaintext
---
|
||
title: Galileo
|
||
description: Galileo integration for CrewAI tracing and evaluation
|
||
icon: telescope
|
||
mode: "wide"
|
||
---
|
||
|
||
## Overview
|
||
|
||
This guide demonstrates how to integrate **Galileo** with **CrewAI**
|
||
for comprehensive tracing and Evaluation Engineering.
|
||
By the end of this guide, you will be able to trace your CrewAI agents,
|
||
monitor their performance, and evaluate their behaviour with
|
||
Galileo's powerful observability platform.
|
||
|
||
> **What is Galileo?** [Galileo](https://galileo.ai) is AI evaluation and observability
|
||
platform that delivers end-to-end tracing, evaluation,
|
||
and monitoring for AI applications. It enables teams to capture ground truth,
|
||
create robust guardrails, and run systematic experiments with
|
||
built-in experiment tracking and performance analytics—ensuring reliability,
|
||
transparency, and continuous improvement across the AI lifecycle.
|
||
|
||
## Getting started
|
||
|
||
This tutorial follows the [CrewAI quickstart](/en/quickstart) and shows how to add
|
||
Galileo's [CrewAIEventListener](https://v2docs.galileo.ai/sdk-api/python/reference/handlers/crewai/handler),
|
||
an event handler.
|
||
For more information, see Galileo’s
|
||
[Add Galileo to a CrewAI Application](https://v2docs.galileo.ai/how-to-guides/third-party-integrations/add-galileo-to-crewai/add-galileo-to-crewai)
|
||
how-to guide.
|
||
|
||
> **Note** This tutorial assumes you have completed the [CrewAI quickstart](/en/quickstart).
|
||
If you want a completed comprehensive example, see the Galileo
|
||
[CrewAI sdk-example repo](https://github.com/rungalileo/sdk-examples/tree/main/python/agent/crew-ai).
|
||
|
||
### Step 1: Install dependencies
|
||
|
||
Install the required dependencies for your app.
|
||
Create a virtual environment using your preferred method,
|
||
then install dependencies inside that environment using your
|
||
preferred tool:
|
||
|
||
```bash
|
||
uv add galileo
|
||
```
|
||
|
||
### Step 2: Add to the .env file from the [CrewAI quickstart](/en/quickstart)
|
||
|
||
```bash
|
||
# Your Galileo API key
|
||
GALILEO_API_KEY="your-galileo-api-key"
|
||
|
||
# Your Galileo project name
|
||
GALILEO_PROJECT="your-galileo-project-name"
|
||
|
||
# The name of the Log stream you want to use for logging
|
||
GALILEO_LOG_STREAM="your-galileo-log-stream "
|
||
```
|
||
|
||
### Step 3: Add the Galileo event listener
|
||
|
||
To enable logging with Galileo, you need to create an instance of the `CrewAIEventListener`.
|
||
Import the Galileo CrewAI handler package by
|
||
adding the following code at the top of your main.py file:
|
||
|
||
```python
|
||
from galileo.handlers.crewai.handler import CrewAIEventListener
|
||
```
|
||
|
||
At the start of your run function, create the event listener:
|
||
|
||
```python
|
||
def run():
|
||
# Create the event listener
|
||
CrewAIEventListener()
|
||
# The rest of your existing code goes here
|
||
```
|
||
|
||
When you create the listener instance, it is automatically
|
||
registered with CrewAI.
|
||
|
||
### Step 4: Run your crew
|
||
|
||
Run your crew with the CrewAI CLI:
|
||
|
||
```bash
|
||
crewai run
|
||
```
|
||
|
||
### Step 5: View the traces in Galileo
|
||
|
||
Once your crew has finished, the traces will be flushed and appear in Galileo.
|
||
|
||

|
||
|
||
## Understanding the Galileo Integration
|
||
|
||
Galileo integrates with CrewAI by registering an event listener
|
||
that captures Crew execution events (e.g., agent actions, tool calls, model responses)
|
||
and forwards them to Galileo for observability and evaluation.
|
||
|
||
### Understanding the event listener
|
||
|
||
Creating a `CrewAIEventListener()` instance is all that’s
|
||
required to enable Galileo for a CrewAI run. When instantiated, the listener:
|
||
|
||
- Automatically registers itself with CrewAI
|
||
- Reads Galileo configuration from environment variables
|
||
- Logs all run data to the Galileo project and log stream specified by
|
||
`GALILEO_PROJECT` and `GALILEO_LOG_STREAM`
|
||
|
||
No additional configuration or code changes are required.
|
||
All data from this run is logged to the Galileo project and
|
||
log stream specified by your environment configuration
|
||
(for example, GALILEO_PROJECT and GALILEO_LOG_STREAM).
|