Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

feat(llm-monitoring): Docs for LLM monitoring #1285

Merged
merged 3 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/docs/sdk/performance/modules/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The list below contains SDK documentation for our various Performance Modules.

- [App Starts](/sdk/performance/modules/app-starts/)
- [Caches](/sdk/performance/modules/caches/)
- [LLM Monitoring](/sdk/performance/modules/llm-monitoring/)
- [Queues](/sdk/performance/modules/queues/)
- [Queries](/sdk/performance/modules/queries/)
- [Requests](/sdk/performance/modules/requests/)
Expand Down
66 changes: 66 additions & 0 deletions src/docs/sdk/performance/modules/llm-monitoring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: 'LLM Monitoring'
---

Sentry auto-generates LLM Monitoring data for common providers in Python, but you may need to manually annotate spans for other frameworks.

## Span conventions

### Span Operations

| Span OP | Description |
|:----------------|:-------------------------------------------------------------------------------------|
| `ai.pipeline.*` | The top-level span which corresponds to one or more AI operations & helper functions |
| `ai.run.*` | A unit of work - a tool call, LLM execution, or helper method. |

### Span Data

| Attribute | Type | Description | Examples |
|-----------------------------|---------|-------------------------------------------------------|------------------------------------------|
| `ai.input_messages` | string | The input messages sent to the model | `[{"role": "user", "message": "hello"}]` |
| `ai.completion_tоkens.used` | int | The number of tokens used to respond to the message | `10` |
| `ai.prompt_tоkens.used` | int | The number of tokens used to process just the prompt | `20` |
| `ai.total_tоkens.used` | int | The total number of tokens used to process the prompt | `30` |
| `ai.model_id` | list | The vendor-specific ID of the model used | `"gpt-4"` |
| `ai.streaming` | boolean | Whether the request was streamed back | `true` |
| `ai.responses` | list | The response messages sent back by the AI model | `["hello", "world"]` |
| `ai.pipeline.name` | string | The description of the parent ai.pipeline span | `My AI pipeline` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these all optional or are some required?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

everything but streaming is required


## Instrumentation

When a user creates a new AI pipeline, the SDK automatically creates spans that instrument both the pipeline and its AI operations.

**Example**

```python
from sentry_sdk.ai.monitoring import ai_track
from openai import OpenAI

sentry.init(...)

openai = OpenAI()

@ai_track(description="My AI pipeline")
def invoke_pipeline():
result = openai.chat.completions.create(
model="some-model", messages=[{"role": "system", "content": "hello"}]
).choices[0].message.content

return openai.chat.completions.create(
model="some-model", messages=[{"role": "system", "content": result}]
).choices[0].message.content



```

This should result in the following spans.

```
<span op:"ai.pipeline" description:"My AI pipeline">
<span op:"ai.run.openai" description:"OpenAI Chat Completion" data[ai.total_tokens.used]:15 data[ai.pipeline.name]:"My AI pipeline" />
<span op:"ai.run.openai" description:"OpenAI Chat Completion" data[ai.total_tokens.used]:20 data[ai.pipeline.name]:"My AI pipeline" />
</span>
```

Notice that the ai.pipeline.name span of the children spans is the description of the `ai.pipeline.*` span parent.
Loading