Skip to content

ref(openai): Separate output handling #5543

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
alexander-alderman-webb merged 4 commits into from
Mar 2, 2026
Merged

ref(openai): Separate output handling #5543

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cee69e
ref(openai): Separate output handling
alexander-alderman-webb Feb 26, 2026
d94f953
.
alexander-alderman-webb Feb 26, 2026
fb12a44
.
alexander-alderman-webb Feb 26, 2026
63acf10
rename function
alexander-alderman-webb Mar 2, 2026
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
116 changes: 112 additions & 4 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ def _set_embeddings_input_data(
_commmon_set_input_data(span, kwargs)


def _set_output_data(
def _common_set_output_data(
Copy link
Copy Markdown
Member

@ericapisani ericapisani Feb 26, 2026

Choose a reason for hiding this comment

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

Nit: _set_common_output_data

Copy link
Copy Markdown
Contributor Author

@alexander-alderman-webb alexander-alderman-webb Mar 2, 2026

Choose a reason for hiding this comment

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

addressed 63acf10

span: "Span",
response: "Any",
kwargs: "dict[str, Any]",
Expand Down Expand Up @@ -706,11 +706,109 @@ def _new_chat_completion_common(f: "Any", *args: "Any", **kwargs: "Any") -> "Any
start_time = time.perf_counter()
response = yield f, args, kwargs

_set_output_data(span, response, kwargs, integration, start_time, finish_span=True)
is_streaming_response = kwargs.get("stream", False)
if is_streaming_response:
_set_streaming_completions_api_output_data(
span, response, kwargs, integration, start_time, finish_span=True
)
else:
_set_completions_api_output_data(
span, response, kwargs, integration, start_time, finish_span=True
)

return response


def _set_completions_api_output_data(
span: "Span",
response: "Any",
kwargs: "dict[str, Any]",
integration: "OpenAIIntegration",
start_time: "Optional[float]" = None,
finish_span: bool = True,
Copy link
Copy Markdown
Member

@ericapisani ericapisani Feb 26, 2026

Choose a reason for hiding this comment

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

Nit: I can see there being a possibility that the name finish_span could be interpreted as the "ending span" (a noun) rather than "mark the span as finished" (a verb/action).

If it's not a massive pain, it might be worth renaming to mark_span_as_finished

Copy link
Copy Markdown
Contributor Author

@alexander-alderman-webb alexander-alderman-webb Mar 2, 2026

Choose a reason for hiding this comment

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

very good point, naming is hard 😅
I'll follow up later with readability changes to keep this PR atomic

) -> None:
_common_set_output_data(
span,
response,
kwargs,
integration,
start_time,
finish_span,
)


def _set_streaming_completions_api_output_data(
span: "Span",
response: "Any",
kwargs: "dict[str, Any]",
integration: "OpenAIIntegration",
start_time: "Optional[float]" = None,
finish_span: bool = True,
) -> None:
_common_set_output_data(
span,
response,
kwargs,
integration,
start_time,
finish_span,
)


def _set_responses_api_output_data(
span: "Span",
response: "Any",
kwargs: "dict[str, Any]",
integration: "OpenAIIntegration",
start_time: "Optional[float]" = None,
finish_span: bool = True,
) -> None:
_common_set_output_data(
span,
response,
kwargs,
integration,
start_time,
finish_span,
)


def _set_streaming_responses_api_output_data(
span: "Span",
response: "Any",
kwargs: "dict[str, Any]",
integration: "OpenAIIntegration",
start_time: "Optional[float]" = None,
finish_span: bool = True,
) -> None:
_common_set_output_data(
span,
response,
kwargs,
integration,
start_time,
finish_span,
)


def _set_embeddings_output_data(
span: "Span",
response: "Any",
kwargs: "dict[str, Any]",
integration: "OpenAIIntegration",
start_time: "Optional[float]" = None,
finish_span: bool = True,
) -> None:
_common_set_output_data(
span,
response,
kwargs,
integration,
start_time,
finish_span,
)
Comment thread
alexander-alderman-webb marked this conversation as resolved.


def _wrap_chat_completion_create(f: "Callable[..., Any]") -> "Callable[..., Any]":
def _execute_sync(f: "Any", *args: "Any", **kwargs: "Any") -> "Any":
gen = _new_chat_completion_common(f, *args, **kwargs)
Expand Down Expand Up @@ -795,7 +893,9 @@ def _new_embeddings_create_common(f: "Any", *args: "Any", **kwargs: "Any") -> "A

response = yield f, args, kwargs

_set_output_data(span, response, kwargs, integration, finish_span=False)
_set_embeddings_output_data(
span, response, kwargs, integration, finish_span=False
)

return response

Expand Down Expand Up @@ -885,7 +985,15 @@ def _new_responses_create_common(f: "Any", *args: "Any", **kwargs: "Any") -> "An
start_time = time.perf_counter()
response = yield f, args, kwargs

_set_output_data(span, response, kwargs, integration, start_time, finish_span=True)
is_streaming_response = kwargs.get("stream", False)
if is_streaming_response:
_set_streaming_responses_api_output_data(
span, response, kwargs, integration, start_time, finish_span=True
)
else:
_set_responses_api_output_data(
span, response, kwargs, integration, start_time, finish_span=True
)
Comment thread
alexander-alderman-webb marked this conversation as resolved.

return response

Expand Down
Loading