Skip to content

Antonpirker/OpenAI add async #4603

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 21, 2025
Merged

Antonpirker/OpenAI add async #4603

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ba8e9d
Make sure op and common attributes are set
antonpirker Jul 21, 2025
616110e
readability
antonpirker Jul 21, 2025
91757a6
Add async instrumentation for responses
antonpirker Jul 21, 2025
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
64 changes: 54 additions & 10 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@
except ImportError:
raise DidNotEnable("OpenAI not installed")

RESPONSES_API_ENABLED = True
try:
# responses API support was instroduces in v1.66.0
from openai.resources.responses import Responses
from openai.resources.responses import Responses, AsyncResponses
except ImportError:
Responses = None
RESPONSES_API_ENABLED = False


class OpenAIIntegration(Integration):
Expand All @@ -53,16 +54,17 @@ def __init__(self, include_prompts=True, tiktoken_encoding_name=None):
def setup_once():
# type: () -> None
Completions.create = _wrap_chat_completion_create(Completions.create)
Embeddings.create = _wrap_embeddings_create(Embeddings.create)

if Responses is not None:
Responses.create = _wrap_responses_create(Responses.create)

AsyncCompletions.create = _wrap_async_chat_completion_create(
AsyncCompletions.create
)

Embeddings.create = _wrap_embeddings_create(Embeddings.create)
AsyncEmbeddings.create = _wrap_async_embeddings_create(AsyncEmbeddings.create)

if RESPONSES_API_ENABLED:
Responses.create = _wrap_responses_create(Responses.create)
AsyncResponses.create = _wrap_async_responses_create(AsyncResponses.create)

def count_tokens(self, s):
# type: (OpenAIIntegration, str) -> int
if self.tiktoken_encoding is not None:
Expand Down Expand Up @@ -172,7 +174,7 @@ def _new_chat_completion_common(f, *args, **kwargs):

span = sentry_sdk.start_span(
op=consts.OP.GEN_AI_CHAT,
name=f"{consts.OP.GEN_AI_CHAT} {model}",
name=f"chat {model}",
origin=OpenAIIntegration.origin,
)
span.__enter__()
Expand All @@ -183,7 +185,9 @@ def _new_chat_completion_common(f, *args, **kwargs):
if should_send_default_pii() and integration.include_prompts:
set_data_normalized(span, SPANDATA.GEN_AI_REQUEST_MESSAGES, messages)

set_data_normalized(span, SPANDATA.GEN_AI_SYSTEM, "openai")
set_data_normalized(span, SPANDATA.GEN_AI_REQUEST_MODEL, model)
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "chat")
set_data_normalized(span, SPANDATA.AI_STREAMING, streaming)

if hasattr(res, "choices"):
Expand Down Expand Up @@ -357,9 +361,13 @@ def _new_embeddings_create_common(f, *args, **kwargs):

with sentry_sdk.start_span(
op=consts.OP.GEN_AI_EMBEDDINGS,
name=f"{consts.OP.GEN_AI_EMBEDDINGS} {model}",
name=f"embeddings {model}",
origin=OpenAIIntegration.origin,
) as span:
set_data_normalized(span, SPANDATA.GEN_AI_SYSTEM, "openai")
set_data_normalized(span, SPANDATA.GEN_AI_REQUEST_MODEL, model)
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")

if "input" in kwargs and (
should_send_default_pii() and integration.include_prompts
):
Expand Down Expand Up @@ -483,12 +491,14 @@ def _new_responses_create_common(f, *args, **kwargs):

span = sentry_sdk.start_span(
op=consts.OP.GEN_AI_RESPONSES,
name=f"{consts.OP.GEN_AI_RESPONSES} {model}",
name=f"responses {model}",
origin=OpenAIIntegration.origin,
)
span.__enter__()

set_data_normalized(span, SPANDATA.GEN_AI_SYSTEM, "openai")
set_data_normalized(span, SPANDATA.GEN_AI_REQUEST_MODEL, model)
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "responses")

if should_send_default_pii() and integration.include_prompts:
set_data_normalized(span, SPANDATA.GEN_AI_REQUEST_MESSAGES, input)
Expand Down Expand Up @@ -544,3 +554,37 @@ def _sentry_patched_create_sync(*args, **kwargs):
return _execute_sync(f, *args, **kwargs)

return _sentry_patched_create_sync


def _wrap_async_responses_create(f):
# type: (Any) -> Any
async def _execute_async(f, *args, **kwargs):
# type: (Any, *Any, **Any) -> Any
gen = _new_responses_create_common(f, *args, **kwargs)

try:
f, args, kwargs = next(gen)
except StopIteration as e:
return await e.value

try:
try:
result = await f(*args, **kwargs)
except Exception as e:
_capture_exception(e)
raise e from None

return gen.send(result)
except StopIteration as e:
return e.value

@wraps(f)
async def _sentry_patched_create_async(*args, **kwargs):
# type: (*Any, **Any) -> Any
integration = sentry_sdk.get_client().get_integration(OpenAIIntegration)
if integration is None:
return await f(*args, **kwargs)

return await _execute_async(f, *args, **kwargs)

return _sentry_patched_create_async
Loading