From 9ea4fb8c82dea9ea10c13daa4ba851a940ee8087 Mon Sep 17 00:00:00 2001 From: exiao Date: Thu, 20 Mar 2025 02:23:13 -0400 Subject: [PATCH 1/4] Add Phoenix docs and tutorials --- docs/how-to/phoenix-observability.mdx | 136 ++++++++++++++++++++++++++ 1 file changed, 136 insertions(+) create mode 100644 docs/how-to/phoenix-observability.mdx diff --git a/docs/how-to/phoenix-observability.mdx b/docs/how-to/phoenix-observability.mdx new file mode 100644 index 000000000..e962f981d --- /dev/null +++ b/docs/how-to/phoenix-observability.mdx @@ -0,0 +1,136 @@ +--- +title: Agent Monitoring with Arize Phoenix +description: Learn how to integrate Arize Phoenix with CrewAI via OpenTelemetry using OpenInference +icon: magnifying-glass-chart +--- + +# Integrate Arize Phoenix with CrewAI + +This guide demonstrates how to integrate **Arize Phoenix** with **CrewAI** using OpenTelemetry via the [OpenInference](https://github.com/openinference/openinference) SDK. By the end of this guide, you will be able to trace your CrewAI agents and easily debug your agents. + +> **What is Arize Phoenix?** [Arize Phoenix](https://phoenix.arize.com) is an LLM observability platform that provides tracing and evaluation for AI applications. + +[![Watch a Video Demo of Our Integration with Phoenix](https://storage.googleapis.com/arize-assets/fixtures/setup_crewai.png)](https://www.youtube.com/watch?v=Yc5q3l6F7Ww) + +## Get Started + +We'll walk through a simple example of using CrewAI and integrating it with Arize Phoenix via OpenTelemetry using OpenInference. + +You can also access this guide on [Google Colab](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/crewai_tracing_tutorial.ipynb). + +### Step 1: Install Dependencies + +```bash +pip install openinference-instrumentation-crewai crewai crewai-tools arize-phoenix-otel +``` + +### Step 2: Set Up Environment Variables + +Setup Phoenix Cloud API keys and configure OpenTelemetry to send traces to Phoenix. Phoenix Cloud is a hosted version of Arize Phoenix, but it is not required to use this integration. + +You can get your free Serper API key [here](https://serper.dev/). + +```python +import os +from getpass import getpass + +# Get your Phoenix Cloud credentials +PHOENIX_API_KEY = getpass("🔑 Enter your Phoenix Cloud API Key: ") + +# Get API keys for services +OPENAI_API_KEY = getpass("🔑 Enter your OpenAI API key: ") +SERPER_API_KEY = getpass("🔑 Enter your Serper API key: ") + +# Set environment variables +os.environ["PHOENIX_CLIENT_HEADERS"] = f"api_key={PHOENIX_API_KEY}" +os.environ["PHOENIX_COLLECTOR_ENDPOINT"] = "https://app.phoenix.arize.com" # Phoenix Cloud, change this to your own endpoint if you are using a self-hosted instance +os.environ["OPENAI_API_KEY"] = OPENAI_API_KEY +os.environ["SERPER_API_KEY"] = SERPER_API_KEY +``` + +### Step 3: Initialize OpenTelemetry with Phoenix + +Initialize the OpenInference OpenTelemetry instrumentation SDK to start capturing traces and send them to Phoenix. + +```python +from phoenix.otel import register + +tracer_provider = register( + project_name="crewai-tracing-demo", + auto_instrument=True, +) +``` + +### Step 4: Create a CrewAI Application + +We'll create a CrewAI application where two agents collaborate to research and write a blog post about AI advancements. + +```python +from crewai import Agent, Crew, Process, Task +from crewai_tools import SerperDevTool + +search_tool = SerperDevTool() + +# Define your agents with roles and goals +researcher = Agent( + role="Senior Research Analyst", + goal="Uncover cutting-edge developments in AI and data science", + backstory="""You work at a leading tech think tank. + Your expertise lies in identifying emerging trends. + You have a knack for dissecting complex data and presenting actionable insights.""", + verbose=True, + allow_delegation=False, + # You can pass an optional llm attribute specifying what model you wanna use. + # llm=ChatOpenAI(model_name="gpt-3.5", temperature=0.7), + tools=[search_tool], +) +writer = Agent( + role="Tech Content Strategist", + goal="Craft compelling content on tech advancements", + backstory="""You are a renowned Content Strategist, known for your insightful and engaging articles. + You transform complex concepts into compelling narratives.""", + verbose=True, + allow_delegation=True, +) + +# Create tasks for your agents +task1 = Task( + description="""Conduct a comprehensive analysis of the latest advancements in AI in 2024. + Identify key trends, breakthrough technologies, and potential industry impacts.""", + expected_output="Full analysis report in bullet points", + agent=researcher, +) + +task2 = Task( + description="""Using the insights provided, develop an engaging blog + post that highlights the most significant AI advancements. + Your post should be informative yet accessible, catering to a tech-savvy audience. + Make it sound cool, avoid complex words so it doesn't sound like AI.""", + expected_output="Full blog post of at least 4 paragraphs", + agent=writer, +) + +# Instantiate your crew with a sequential process +crew = Crew( + agents=[researcher, writer], tasks=[task1, task2], verbose=1, process=Process.sequential +) + +# Get your crew to work! +result = crew.kickoff() + +print("######################") +print(result) +``` + +### Step 5: View Traces in Phoenix + +After running the agent, you can view the traces generated by your CrewAI application in Phoenix. You should see detailed steps of the agent interactions and LLM calls, which can help you debug and optimize your AI agents. + +Log into your Phoenix Cloud account and navigate to the project you specified in the `project_name` parameter. You'll see a timeline view of your trace with all the agent interactions, tool usages, and LLM calls. + +![Example trace in Phoenix showing agent interactions](https://storage.googleapis.com/arize-assets/fixtures/crewai_traces.png) + +## References + +- [Phoenix Documentation](https://docs.arize.com/phoenix/) +- [CrewAI Documentation](https://docs.crewai.com/) From 06950921e9a270d953cc9d3143af625a728d82f7 Mon Sep 17 00:00:00 2001 From: exiao Date: Thu, 27 Mar 2025 13:07:16 -0400 Subject: [PATCH 2/4] Update phoenix-observability.mdx --- docs/how-to/phoenix-observability.mdx | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/how-to/phoenix-observability.mdx b/docs/how-to/phoenix-observability.mdx index e962f981d..c1815d0d6 100644 --- a/docs/how-to/phoenix-observability.mdx +++ b/docs/how-to/phoenix-observability.mdx @@ -130,7 +130,14 @@ Log into your Phoenix Cloud account and navigate to the project you specified in ![Example trace in Phoenix showing agent interactions](https://storage.googleapis.com/arize-assets/fixtures/crewai_traces.png) -## References -- [Phoenix Documentation](https://docs.arize.com/phoenix/) -- [CrewAI Documentation](https://docs.crewai.com/) +### Version Compatibility Information +- Python 3.8+ +- CrewAI >= 0.86.0 +- Arize Phoenix >= 7.0.1 +- OpenTelemetry SDK >= 1.31.0 + +- [Phoenix Documentation](https://docs.arize.com/phoenix/) - Overview of the Phoenix platform. +- [CrewAI Documentation](https://docs.crewai.com/) - Overview of the CrewAI framework. +- [OpenTelemetry Docs](https://opentelemetry.io/docs/) - OpenTelemetry guide +- [OpenInference GitHub](https://github.com/openinference/openinference) - Source code for OpenInference SDK. From b6c32b014c1846f636c3557eda55672de1333424 Mon Sep 17 00:00:00 2001 From: exiao Date: Thu, 27 Mar 2025 13:22:33 -0400 Subject: [PATCH 3/4] Update phoenix-observability.mdx --- docs/how-to/phoenix-observability.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/how-to/phoenix-observability.mdx b/docs/how-to/phoenix-observability.mdx index c1815d0d6..0f101d1b8 100644 --- a/docs/how-to/phoenix-observability.mdx +++ b/docs/how-to/phoenix-observability.mdx @@ -50,7 +50,7 @@ os.environ["SERPER_API_KEY"] = SERPER_API_KEY ### Step 3: Initialize OpenTelemetry with Phoenix -Initialize the OpenInference OpenTelemetry instrumentation SDK to start capturing traces and send them to Phoenix. +Initialize the OpenInference OpenTelemetry instrumentation SDK to start capturing traces and send them to Phoenix. ```python from phoenix.otel import register @@ -137,6 +137,8 @@ Log into your Phoenix Cloud account and navigate to the project you specified in - Arize Phoenix >= 7.0.1 - OpenTelemetry SDK >= 1.31.0 + +### References - [Phoenix Documentation](https://docs.arize.com/phoenix/) - Overview of the Phoenix platform. - [CrewAI Documentation](https://docs.crewai.com/) - Overview of the CrewAI framework. - [OpenTelemetry Docs](https://opentelemetry.io/docs/) - OpenTelemetry guide From bce4bb5c4e734eb21df4314a3beb73e158fd84e1 Mon Sep 17 00:00:00 2001 From: exiao Date: Tue, 1 Apr 2025 14:51:01 -0400 Subject: [PATCH 4/4] Update docs.json --- docs/docs.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs.json b/docs/docs.json index dc3acdaa6..d2d7d629e 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -103,14 +103,15 @@ { "group": "Agent Monitoring & Observability", "pages": [ - "how-to/weave-integration", "how-to/agentops-observability", "how-to/langfuse-observability", "how-to/langtrace-observability", "how-to/mlflow-observability", "how-to/openlit-observability", "how-to/opik-observability", - "how-to/portkey-observability" + "how-to/phoenix-observability", + "how-to/portkey-observability", + "how-to/weave-integration" ] }, {