Skip to content

feat(openai): Make include_prompts override data collection when set #6981

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

Closed
ericapisani wants to merge 4 commits into from
+604 −69
Closed

feat(openai): Make include_prompts override data collection when set #6981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0aa794e
feat(openai): Gate embeddings input collection on data_collection
ericapisani Jul 31, 2026
c41a9ce
lint
ericapisani Jul 31, 2026
c75e763
Merge branch 'master' into py-2588-openai-embeddings-input-data
ericapisani Jul 31, 2026
a033d03
feat(openai): Make include_prompts override data collection when set
ericapisani Jul 31, 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
141 changes: 86 additions & 55 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class OpenAIIntegration(Integration):

def __init__(
self: "OpenAIIntegration",
include_prompts: bool = True,
include_prompts: "Optional[bool]" = None,
tiktoken_encoding_name: "Optional[str]" = None,
) -> None:
self.include_prompts = include_prompts
Expand Down Expand Up @@ -325,6 +325,18 @@ def _calculate_responses_token_usage(
)


def _set_tool_definitions_responses_api(
set_on_span: "Callable[[str, Any], None]",
kwargs: "dict[str, Any]",
) -> None:
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
json.dumps(_transform_tool_definitions_responses(tools)),
)


def _set_responses_api_input_data(
span: "Union[Span, StreamedSpan]",
kwargs: "dict[str, Any]",
Expand Down Expand Up @@ -371,33 +383,24 @@ def _set_responses_api_input_data(

client_options = sentry_sdk.get_client().options
if has_data_collection_enabled(client_options):
if (
integration.include_prompts
and client_options["data_collection"]["gen_ai"]["inputs"]
):
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
json.dumps(_transform_tool_definitions_responses(tools)),
)
if integration.include_prompts is not None:
if integration.include_prompts:
_set_tool_definitions_responses_api(set_on_span, kwargs)
elif client_options["data_collection"]["gen_ai"]["inputs"]:
_set_tool_definitions_responses_api(set_on_span, kwargs)
else:
# Pre-data collection this was always set, so this needs to be left here for now until
# we deprecate `send_default_pii`. Once we do, this 'else' branch should be removed,
# and the above branch placed below the "if not should_send_default_pii() or not integration.include_prompts"
# line below
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
json.dumps(_transform_tool_definitions_responses(tools)),
)
_set_tool_definitions_responses_api(set_on_span, kwargs)

if has_data_collection_enabled(client_options):
# This takes precedence over the global data collection settings
if not integration.include_prompts:
return
if not client_options["data_collection"]["gen_ai"]["inputs"]:
if integration.include_prompts is not None:
if not integration.include_prompts:
return
elif not client_options["data_collection"]["gen_ai"]["inputs"]:
return
elif not should_send_default_pii() or not integration.include_prompts:
return
Expand Down Expand Up @@ -478,6 +481,18 @@ def _set_responses_api_input_data(
)


def _set_tool_definitions_completions_api(
set_on_span: "Callable[[str, Any], None]",
kwargs: "dict[str, Any]",
) -> None:
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
json.dumps(_transform_tool_definitions_completions(tools)),
)


def _set_completions_api_input_data(
span: "Union[Span, StreamedSpan]",
kwargs: "dict[str, Any]",
Expand Down Expand Up @@ -519,37 +534,28 @@ def _set_completions_api_input_data(

client = sentry_sdk.get_client()
if has_data_collection_enabled(client.options):
if (
integration.include_prompts
and client.options["data_collection"]["gen_ai"]["inputs"]
):
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
json.dumps(_transform_tool_definitions_completions(tools)),
)
if integration.include_prompts is not None:
if integration.include_prompts:
_set_tool_definitions_completions_api(set_on_span, kwargs)
elif client.options["data_collection"]["gen_ai"]["inputs"]:
_set_tool_definitions_completions_api(set_on_span, kwargs)
else:
# Pre-data collection this was always set, so this needs to be left here for now until
# we deprecate `send_default_pii`. Once we do, this 'else' branch should be removed,
# and the above branch placed below the "if not should_send_default_pii() or not integration.include_prompts"
# line below
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
json.dumps(_transform_tool_definitions_completions(tools)),
)
_set_tool_definitions_completions_api(set_on_span, kwargs)

messages: "Optional[Union[str, Iterable[ChatCompletionMessageParam]]]" = kwargs.get(
"messages"
)

if has_data_collection_enabled(client.options):
# This takes precedence over the global data collection settings
if not integration.include_prompts:
return
if not client.options["data_collection"]["gen_ai"]["inputs"]:
if integration.include_prompts is not None:
if not integration.include_prompts:
return
elif not client.options["data_collection"]["gen_ai"]["inputs"]:
return
elif not should_send_default_pii() or not integration.include_prompts:
return
Expand Down Expand Up @@ -610,31 +616,37 @@ def _set_embeddings_input_data(
kwargs: "dict[str, Any]",
integration: "OpenAIIntegration",
) -> None:
messages: "Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]]" = kwargs.get(
"input"
)

set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")

set_on_span = (
span.set_attribute if isinstance(span, StreamedSpan) else span.set_data
)

model = kwargs.get("model")
if model is not None:
set_on_span(SPANDATA.GEN_AI_REQUEST_MODEL, model)

if (
not should_send_default_pii()
or not integration.include_prompts
or messages is None
):
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")
messages: "Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]]" = kwargs.get(
"input"
)

client = sentry_sdk.get_client()
if has_data_collection_enabled(client.options):
# This takes precedence over the global data collection settings
if integration.include_prompts is not None:
if not integration.include_prompts:
return
elif not client.options["data_collection"]["gen_ai"]["inputs"]:
return
elif not should_send_default_pii() or not integration.include_prompts:
return

if isinstance(messages, str):
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")
if messages is None:
return

if isinstance(messages, str):
normalized_messages = normalize_message_roles([messages]) # type: ignore
client = sentry_sdk.get_client()
scope = sentry_sdk.get_current_scope()
messages_data = (
truncate_and_annotate_embedding_inputs(normalized_messages, span, scope)
Expand All @@ -650,15 +662,13 @@ def _set_embeddings_input_data(

# dict special case following https://github.com/openai/openai-python/blob/3e0c05b84a2056870abf3bd6a5e7849020209cc3/src/openai/_utils/_transform.py#L194-L197
if not isinstance(messages, Iterable) or isinstance(messages, dict):
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")
return

messages = list(messages)
kwargs["input"] = messages

if len(messages) > 0:
normalized_messages = normalize_message_roles(messages)
client = sentry_sdk.get_client()
scope = sentry_sdk.get_current_scope()
messages_data = (
truncate_and_annotate_embedding_inputs(normalized_messages, span, scope)
Expand All @@ -670,8 +680,6 @@ def _set_embeddings_input_data(
span, SPANDATA.GEN_AI_EMBEDDINGS_INPUT, messages_data, unpack=False
)

set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")


def _set_common_output_data(
span: "Union[Span, StreamedSpan]",
Expand Down Expand Up @@ -762,12 +770,25 @@ def _set_common_output_data(
span.__exit__(None, None, None)


def _resolve_include_prompts(
integration: "OpenAIIntegration", options: "Optional[dict[str, Any]]"
) -> None:
if integration.include_prompts is None and not has_data_collection_enabled(options):
# Pre-data-collection behavior: prompts were included by default (subject
# to send_default_pii). Resolve the unset default here, at call time,
# rather than in __init__ so that integrations constructed before
# sentry_sdk.init() still see the active client's options.
integration.include_prompts = True

@cursor cursor Bot Jul 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unset prompts skip response capture

Medium Severity

When data collection is enabled, _resolve_include_prompts leaves include_prompts as None. Input paths handle that, but response-body gates still use truthiness checks like should_send_default_pii() and integration.include_prompts, so None suppresses gen_ai.response.text even when send_default_pii is on. The default path therefore silently drops AI outputs.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit a033d03. Configure here.



def _new_sync_chat_completion(f: "Any", *args: "Any", **kwargs: "Any") -> "Any":
client = sentry_sdk.get_client()
integration = client.get_integration(OpenAIIntegration)
if integration is None:
return f(*args, **kwargs)

_resolve_include_prompts(integration, client.options)

if "messages" not in kwargs:
# invalid call (in all versions of openai), let it return error
return f(*args, **kwargs)
Expand Down Expand Up @@ -849,6 +870,8 @@ async def _new_async_chat_completion(f: "Any", *args: "Any", **kwargs: "Any") ->
if integration is None:
return await f(*args, **kwargs)

_resolve_include_prompts(integration, client.options)

if "messages" not in kwargs:
# invalid call (in all versions of openai), let it return error
return await f(*args, **kwargs)
Expand Down Expand Up @@ -1279,6 +1302,8 @@ def _new_sync_embeddings_create(f: "Any", *args: "Any", **kwargs: "Any") -> "Any
if integration is None:
return f(*args, **kwargs)

_resolve_include_prompts(integration, client.options)

model = kwargs.get("model")

if has_span_streaming_enabled(client.options):
Expand Down Expand Up @@ -1337,6 +1362,8 @@ async def _new_async_embeddings_create(
if integration is None:
return await f(*args, **kwargs)

_resolve_include_prompts(integration, client.options)

model = kwargs.get("model")

if has_span_streaming_enabled(client.options):
Expand Down Expand Up @@ -1417,6 +1444,8 @@ def _new_sync_responses_create(f: "Any", *args: "Any", **kwargs: "Any") -> "Any"
if integration is None:
return f(*args, **kwargs)

_resolve_include_prompts(integration, client.options)

model = kwargs.get("model")

# Same bool handling as in https://github.com/openai/openai-python/blob/acd0c54d8a68efeedde0e5b4e6c310eef1ce7867/src/openai/resources/responses/responses.py#L940
Expand Down Expand Up @@ -1487,6 +1516,8 @@ async def _new_async_responses_create(f: "Any", *args: "Any", **kwargs: "Any") -
if integration is None:
return await f(*args, **kwargs)

_resolve_include_prompts(integration, client.options)

model = kwargs.get("model")

# Same bool handling as in https://github.com/openai/openai-python/blob/acd0c54d8a68efeedde0e5b4e6c310eef1ce7867/src/openai/resources/responses/responses.py#L940
Expand Down
Loading
Loading