Add Arize Phoenix docs and tutorials

[exiao]

For customers and prospects who use Arize Phoenix for observability and crewAI for building their agents, we wrote some instructions on how to do so! If you could merge them, that would be amazing!

https://docs.arize.com/phoenix/tracing/integrations-tracing/crewai

[joaomdmoura]

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comments for the Phoenix Observability Documentation PR

Overview

The PR introduces insightful documentation for integrating Arize Phoenix observability with CrewAI. The document serves as a comprehensive guide, enhancing user understanding of this integration.

Positive Aspects

• Clarity: The documentation provides clear, step-by-step instructions making it easy for the reader to follow along.
• Examples: The inclusion of code examples for each integration step is commendably helpful for users.
• Formatting: Effective usage of MDX formatting elevates the readability of the documentation.
• Visuals and Links: Helpful visuals combined with relevant links enhance the context and usability of the document.
• Environment Setup: Thorough environment setup details are beneficial for new users.

Suggested Improvements

1. Code Block Language Specification

Observation: Some code blocks lack language specifications.
Improvement: Specify the programming language in all code blocks to enhance readability and syntax highlighting. For example:

```python
import os
from getpass import getpass

### 2. Environment Variables Security
**Observation**: The document shows examples of storing API keys in environment variables without warning.
**Improvement**: Add a security notice to remind users of best practices:
```mdx
> **Security Note**: Never commit API keys to version control. Use a dedicated secrets management solution for production environments.

3. Error Handling Guidance

Observation: There is currently no guidance on handling errors while implementing the integration.
Improvement: Introduce a "Troubleshooting" section that includes common issues and their resolutions:

## Troubleshooting

### Common Issues
1. **Authentication Errors**
   ```python
   try:
       tracer_provider = register(
           project_name="crewai-tracing-demo",
           auto_instrument=True,
       )
   except Exception as e:
       print(f"Failed to initialize Phoenix: {e}")

2. Missing Dependencies
   Ensure all required packages are installed:

   pip install -r requirements.txt

### 4. Version Compatibility Information
**Observation**: The document omits mention of version requirements.
**Improvement**: Include a section specifying version compatibility to prevent runtime errors:
```mdx
## Prerequisites
- Python 3.8+
- CrewAI >= 0.x.x
- Arize Phoenix >= x.x.x
- OpenTelemetry >= x.x.x

5. Link Context Enhancements

Observation: Some external links could better serve the user with additional context.
Improvement: Improve the references section with enhanced descriptions:

## References
- [Phoenix Documentation](https://docs.arize.com/phoenix/) - Comprehensive overview of the Phoenix platform.
- [CrewAI Documentation](https://docs.crewai.com/) - Detailed usage of the CrewAI framework.
- [OpenTelemetry Docs](https://opentelemetry.io/docs/) - Official instrumentation guide.
- [OpenInference GitHub](https://github.com/openinference/openinference) - Source code for OpenInference SDK.

6. Configuration Options

Observation: Coverage of configuration options is limited.
Improvement: Add a section on advanced configuration options:

## Advanced Configuration

### Custom Trace Sampling
```python
from opentelemetry.sdk.trace.sampling import TraceIdRatioBased

tracer_provider = register(
    project_name="crewai-tracing-demo",
    auto_instrument=True,
    sampler=TraceIdRatioBased(0.5)  # Sample 50% of traces
)

Custom Tags

from opentelemetry import trace

tracer = trace.get_tracer(__name__)
with tracer.start_as_current_span("custom_operation") as span:
    span.set_attribute("custom.tag", "value")

## Final Recommendations
- Provide an example of a `requirements.txt` file.
- Include a fully working example in a dedicated GitHub repository.
- Expand on the error handling section.
- Document version compatibility explicitly.
- Enhance troubleshooting guidance.
- Offer further configuration examples.
- Consider including a section on local development setup.
- Address potential performance impact considerations.

In summary, this documentation is a valuable contribution that greatly enhance user experience and understanding. The suggested improvements will make it even more robust and better suited for production deployments.

[exiao]

I've responded to the feedback around references and version control up above! I think the configuration options are not quite valid. Let me know if you'd like to make further edits!

[lorenzejay]

LGTM ! cc: @tonykipkemboi if you have time, can you take a look at this

[tonykipkemboi]

One tiny ask, @exiao, please add the file name (how-to/phoenix-observability.mdx) to the docs/docs.json file so it shows up on the docs. Will merge after this change. See the image for the section to add to below:

[exiao]

@tonykipkemboi , I added it and made it alphabetical to match the rest of your docs! LMK if this is not what you meant!

[tonykipkemboi]

@tonykipkemboi , I added it and made it alphabetical to match the rest of your docs! LMK if this is not what you meant!

this is good. meant to do that anyways, thank you.

[tonykipkemboi]

G2G!