Skip to content

feat(google-genai): Gate prompt/response collection on data_collection option #7139

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

Open
ericapisani wants to merge 1 commit into
base: master
Choose a base branch
from
+1,226 −44
Open

feat(google-genai): Gate prompt/response collection on data_collection option #7139

Show file tree
Hide file tree
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
47 changes: 31 additions & 16 deletions sentry_sdk/integrations/google_genai/streaming.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
from typing import TYPE_CHECKING, Any, List, Optional, TypedDict, Union

import sentry_sdk
from sentry_sdk.ai.utils import set_data_normalized
from sentry_sdk.consts import SPANDATA
from sentry_sdk.scope import should_send_default_pii
from sentry_sdk.traces import StreamedSpan
from sentry_sdk.utils import (
has_data_collection_enabled,
safe_serialize,
)

Expand Down Expand Up @@ -106,16 +108,7 @@ def set_span_data_for_streaming_response(
set_on_span = (
span.set_attribute if isinstance(span, StreamedSpan) else span.set_data
)

if (
should_send_default_pii()
and integration.include_prompts
and accumulated_response.get("text")
):
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TEXT,
safe_serialize([accumulated_response["text"]]),
)
client = sentry_sdk.get_client()

if accumulated_response.get("finish_reasons"):
set_data_normalized(
Expand All @@ -124,12 +117,6 @@ def set_span_data_for_streaming_response(
accumulated_response["finish_reasons"],
)

if accumulated_response.get("tool_calls"):
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TOOL_CALLS,
safe_serialize(accumulated_response["tool_calls"]),
)

response_id = accumulated_response.get("id")
if response_id is not None:
set_on_span(SPANDATA.GEN_AI_RESPONSE_ID, response_id)
Expand Down Expand Up @@ -170,3 +157,31 @@ def set_span_data_for_streaming_response(
SPANDATA.GEN_AI_USAGE_TOTAL_TOKENS,
accumulated_response["usage_metadata"]["total_tokens"],
)

if accumulated_response.get("tool_calls"):
if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["outputs"]:
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TOOL_CALLS,
safe_serialize(accumulated_response["tool_calls"]),
)
else:
# Before data collection was introduced this was unconditionally set
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TOOL_CALLS,
safe_serialize(accumulated_response["tool_calls"]),
)

if accumulated_response.get("text"):
if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["outputs"]:
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TEXT,
safe_serialize([accumulated_response["text"]]),
)

elif should_send_default_pii() and integration.include_prompts:
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TEXT,
safe_serialize([accumulated_response["text"]]),
)
97 changes: 69 additions & 28 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 @@ -36,6 +36,7 @@
from sentry_sdk.utils import (
capture_internal_exceptions,
event_from_exception,
has_data_collection_enabled,
safe_serialize,
)

Expand Down Expand Up @@ -887,6 +888,7 @@ def set_span_data_for_request(
kwargs: "dict[str, Any]",
) -> None:
"""Set span data for the request."""
client = sentry_sdk.get_client()
set_on_span = (
span.set_attribute if isinstance(span, StreamedSpan) else span.set_data
)
Expand All @@ -898,8 +900,37 @@ def set_span_data_for_request(

config: "Optional[GenerateContentConfig]" = kwargs.get("config")

# Set input messages/prompts if PII is allowed
if should_send_default_pii() and integration.include_prompts:
# Set tools if available
if config is not None and hasattr(config, "tools"):
tools = config.tools
if tools:
formatted_tools = _format_tools_for_span(tools)
if formatted_tools:
if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["inputs"]:
set_data_normalized(
span,
SPANDATA.GEN_AI_REQUEST_AVAILABLE_TOOLS,
formatted_tools,
unpack=False,
)
else:
# To remove once data collection has been fully rolled out
set_data_normalized(
span,
SPANDATA.GEN_AI_REQUEST_AVAILABLE_TOOLS,
formatted_tools,
unpack=False,
)

record_inputs = False
if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["inputs"]:
record_inputs = True
elif should_send_default_pii() and integration.include_prompts:
record_inputs = True

if record_inputs:
messages = []

# Add system instruction if present
Expand Down Expand Up @@ -951,42 +982,19 @@ def set_span_data_for_request(
if value is not None:
set_on_span(span_key, value)

# Set tools if available
if config is not None and hasattr(config, "tools"):
tools = config.tools
if tools:
formatted_tools = _format_tools_for_span(tools)
if formatted_tools:
set_data_normalized(
span,
SPANDATA.GEN_AI_REQUEST_AVAILABLE_TOOLS,
formatted_tools,
unpack=False,
)


def set_span_data_for_response(
span: "Union[Span, StreamedSpan]",
integration: "Any",
response: "GenerateContentResponse",
) -> None:
"""Set span data for the response."""
if not response:
return

client = sentry_sdk.get_client()
set_on_span = (
span.set_attribute if isinstance(span, StreamedSpan) else span.set_data
)
if should_send_default_pii() and integration.include_prompts:
response_texts = _extract_response_text(response)
if response_texts:
# Format as JSON string array as per documentation
set_on_span(SPANDATA.GEN_AI_RESPONSE_TEXT, safe_serialize(response_texts))

tool_calls = extract_tool_calls(response)
if tool_calls:
# Tool calls should be JSON serialized
set_on_span(SPANDATA.GEN_AI_RESPONSE_TOOL_CALLS, safe_serialize(tool_calls))

finish_reasons = extract_finish_reasons(response)
if finish_reasons:
Expand Down Expand Up @@ -1023,6 +1031,31 @@ def set_span_data_for_response(
if usage_data["total_tokens"]:
set_on_span(SPANDATA.GEN_AI_USAGE_TOTAL_TOKENS, usage_data["total_tokens"])

tool_calls = extract_tool_calls(response)
if tool_calls:
if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["outputs"]:
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TOOL_CALLS, safe_serialize(tool_calls)
)
else:
# Before data collection was introduced, this was set unconditionally
set_on_span(SPANDATA.GEN_AI_RESPONSE_TOOL_CALLS, safe_serialize(tool_calls))

if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["outputs"]:
response_texts = _extract_response_text(response)
if response_texts:
set_on_span(
SPANDATA.GEN_AI_RESPONSE_TEXT, safe_serialize(response_texts)
)
elif should_send_default_pii() and integration.include_prompts:
# TODO: Delete this block once data collection has been completely rolled out
response_texts = _extract_response_text(response)
if response_texts:
# Format as JSON string array as per documentation
set_on_span(SPANDATA.GEN_AI_RESPONSE_TEXT, safe_serialize(response_texts))


def prepare_generate_content_args(
args: "tuple[Any, ...]", kwargs: "dict[str, Any]"
Expand Down Expand Up @@ -1062,8 +1095,16 @@ def set_span_data_for_embed_request(
kwargs: "dict[str, Any]",
) -> None:
"""Set span data for embedding request."""
# Include input contents if PII is allowed
if should_send_default_pii() and integration.include_prompts:
client = sentry_sdk.get_client()

record_inputs = False
if has_data_collection_enabled(client.options):
if client.options["data_collection"]["gen_ai"]["inputs"]:
record_inputs = True
elif should_send_default_pii() and integration.include_prompts:
record_inputs = True

if record_inputs:
if contents:
# For embeddings, contents is typically a list of strings/texts
input_texts = []
Expand Down
Loading
Loading