-
Notifications
You must be signed in to change notification settings - Fork 71
docs: add Respan observability integration #579
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
drPod
wants to merge
2
commits into
agno-agi:main
Choose a base branch
from
drPod:docs/add-respan-observability
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: Respan | ||
| description: Integrate Agno with Respan to trace agent workflows and monitor performance. | ||
| --- | ||
|
|
||
| ## Integrating Agno with Respan | ||
|
|
||
| [Respan](https://respan.ai) is an observability platform for tracing and monitoring AI agents. The `respan-exporter-agno` package captures Agno's OpenInference trace data and sends it to Respan. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. **Install Dependencies** | ||
|
|
||
| ```bash | ||
| uv pip install agno openinference-instrumentation-agno respan-exporter-agno | ||
| ``` | ||
|
|
||
| 2. **Setup Respan Account** | ||
|
|
||
| - Create an account at [platform.respan.ai](https://platform.respan.ai). | ||
| - Generate an API key on the [API keys page](https://platform.respan.ai/platform/api/api-keys). | ||
|
|
||
| 3. **Set Environment Variables** | ||
|
|
||
| ```bash | ||
| export RESPAN_API_KEY=<your-api-key> | ||
| ``` | ||
|
|
||
| ## Sending Traces to Respan | ||
|
|
||
| ```python | ||
| from agno.agent import Agent | ||
| from agno.models.openai import OpenAIChat | ||
| from respan_exporter_agno import RespanAgnoInstrumentor | ||
|
|
||
| # Initialize Respan instrumentation | ||
| RespanAgnoInstrumentor.instrument() | ||
|
|
||
| # Create and configure the agent | ||
| agent = Agent( | ||
| model=OpenAIChat(id="gpt-4o-mini"), | ||
| instructions="You are a helpful assistant.", | ||
| ) | ||
|
|
||
| # Use the agent | ||
| agent.print_response("Tell me a joke about AI") | ||
| ``` | ||
|
|
||
| View your traces on the [Traces page](https://platform.respan.ai/platform/traces) in the Respan dashboard. | ||
|
|
||
| ## Configuration | ||
|
|
||
| `RespanAgnoInstrumentor.instrument()` accepts the following parameters: | ||
|
|
||
| | Parameter | Type | Default | Description | | ||
| | --------------------- | ------------- | ------------------------ | ---------------------------- | | ||
| | `api_key` | `str` | `RESPAN_API_KEY` env var | Respan API key. | | ||
| | `endpoint` | `str \| None` | `None` | Custom ingest endpoint URL. | | ||
| | `base_url` | `str \| None` | `None` | API base URL. | | ||
| | `environment` | `str \| None` | `None` | Environment label. | | ||
| | `customer_identifier` | `str \| None` | `None` | Default customer identifier. | | ||
|
|
||
| ## Notes | ||
|
|
||
| - **Environment Variables**: Set `RESPAN_API_KEY` to avoid passing `api_key` directly in code. | ||
| - **Initialization Order**: Call `RespanAgnoInstrumentor.instrument()` before creating any agents. | ||
| - **Respan Docs**: See the [Respan Agno integration guide](https://respan.ai/docs/integrations/tracing/agno) for additional details. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.