Skip to content

ref(google-genai): Remove set_data_normalized for the gen_ai.response.finish_reasons attribute #5506

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

Draft
alexander-alderman-webb wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −2
Draft

ref(google-genai): Remove set_data_normalized for the gen_ai.response.finish_reasons attribute #5506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions sentry_sdk/integrations/google_genai/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,8 +881,8 @@ def set_span_data_for_response(

finish_reasons = extract_finish_reasons(response)
if finish_reasons:
set_data_normalized(
span, SPANDATA.GEN_AI_RESPONSE_FINISH_REASONS, finish_reasons
span.set_data(
SPANDATA.GEN_AI_RESPONSE_FINISH_REASONS, json.dumps(finish_reasons)
Copy link

@cursor cursor bot Feb 23, 2026

Choose a reason for hiding this comment

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

Inconsistent finish_reasons format between streaming and non-streaming

High Severity

The change creates inconsistent serialization for gen_ai.response.finish_reasons between streaming and non-streaming paths. Non-streaming now always stores as JSON array (e.g., '["STOP"]'), while streaming still uses set_data_normalized which unpacks single-element lists to plain strings (e.g., "STOP"). OpenTelemetry specifies this attribute as string[] type, requiring consistent array format. Consumers parsing this attribute will encounter different formats depending on whether streaming was used, breaking data consistency.

Fix in Cursor Fix in Web

Copy link
Contributor Author

@alexander-alderman-webb alexander-alderman-webb Feb 23, 2026

Choose a reason for hiding this comment

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

The aim is to have a consistent type for an attribute, so if lists are possible they should always be lists.

)
Comment on lines +884 to 886
Copy link

@sentry sentry bot Feb 23, 2026

Choose a reason for hiding this comment

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

Bug: Using json.dumps instead of set_data_normalized incorrectly serializes single-element finish_reasons lists, creating an inconsistency with the streaming path.
Severity: MEDIUM

Suggested Fix

Revert to using set_data_normalized(span, SPANDATA.GEN_AI_RESPONSE_FINISH_REASONS, finish_reasons). This function correctly handles both single-element lists by unpacking them and multi-element lists by JSON-serializing them, maintaining consistency with the streaming code path.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: sentry_sdk/integrations/google_genai/utils.py#L884-L886

Potential issue: The switch from `set_data_normalized` to `json.dumps` for setting the
`finish_reasons` data on a span introduces a data format inconsistency. The
`set_data_normalized` function unpacks single-element lists, meaning a list like
`["STOP"]` becomes the plain string `"STOP"`. The new implementation using `json.dumps`
will serialize it as the string `'["STOP"]'`. This creates a discrepancy with the
streaming implementation, which still uses `set_data_normalized` and produces a plain
string for a single finish reason. This change will break consumers of the span data
that expect a plain string for a single reason in non-streaming scenarios.

Did we get this right? 👍 / 👎 to inform future reviews.

Copy link
Contributor Author

@alexander-alderman-webb alexander-alderman-webb Feb 23, 2026

Choose a reason for hiding this comment

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

The aim is to have a consistent type for an attribute, so if lists are possible they should always be lists.


if getattr(response, "response_id", None):
Expand Down
Loading