Skip to content

ref: Replace gen_ai.system with gen_ai.provider.name #5488

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
Draft

ref: Replace gen_ai.system with gen_ai.provider.name #5488

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
9 changes: 9 additions & 0 deletions sentry_sdk/consts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,12 @@ class SPANDATA:
Example: "qa-pipeline"
"""

GEN_AI_PROVIDER_NAME = "gen_ai.provider.name"
"""
The Generative AI provider as identified by the client or server instrumentation.
Example: "openai"
"""

GEN_AI_RESPONSE_FINISH_REASONS = "gen_ai.response.finish_reasons"
"""
The reason why the model stopped generating.
Expand Down Expand Up @@ -605,6 +611,9 @@ class SPANDATA:

GEN_AI_SYSTEM = "gen_ai.system"
"""
.. deprecated::
This attribute is deprecated. Use the GEN_AI_PROVIDER_NAME attribute instead.

The name of the AI system being used.
Example: "openai"
"""
Expand Down
12 changes: 6 additions & 6 deletions sentry_sdk/integrations/google_genai/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def new_generate_content_stream(
)
chat_span.__enter__()
chat_span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "chat")
chat_span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model_name)
set_span_data_for_request(chat_span, integration, model_name, contents, kwargs)
chat_span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, True)
Expand Down Expand Up @@ -166,7 +166,7 @@ async def new_async_generate_content_stream(
)
chat_span.__enter__()
chat_span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "chat")
chat_span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model_name)
set_span_data_for_request(chat_span, integration, model_name, contents, kwargs)
chat_span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, True)
Expand Down Expand Up @@ -234,7 +234,7 @@ def new_generate_content(self: "Any", *args: "Any", **kwargs: "Any") -> "Any":
origin=ORIGIN,
) as chat_span:
chat_span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "chat")
chat_span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model_name)
chat_span.set_data(SPANDATA.GEN_AI_AGENT_NAME, model_name)
set_span_data_for_request(
Expand Down Expand Up @@ -282,7 +282,7 @@ async def new_async_generate_content(
origin=ORIGIN,
) as chat_span:
chat_span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "chat")
chat_span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
chat_span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model_name)
set_span_data_for_request(
chat_span, integration, model_name, contents, kwargs
Expand Down Expand Up @@ -317,7 +317,7 @@ def new_embed_content(self: "Any", *args: "Any", **kwargs: "Any") -> "Any":
origin=ORIGIN,
) as span:
span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")
span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model_name)
set_span_data_for_embed_request(span, integration, contents, kwargs)

Expand Down Expand Up @@ -352,7 +352,7 @@ async def new_async_embed_content(
origin=ORIGIN,
) as span:
span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "embeddings")
span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model_name)
set_span_data_for_embed_request(span, integration, contents, kwargs)

Expand Down
2 changes: 1 addition & 1 deletion sentry_sdk/integrations/google_genai/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -789,7 +789,7 @@ def set_span_data_for_request(
kwargs: "dict[str, Any]",
) -> None:
"""Set span data for the request."""
span.set_data(SPANDATA.GEN_AI_SYSTEM, GEN_AI_SYSTEM)
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM)
span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model)

if kwargs.get("stream", False):
Expand Down
8 changes: 4 additions & 4 deletions sentry_sdk/integrations/langchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,9 +383,9 @@ def on_llm_start(

ai_type = all_params.get("_type", "")
if "anthropic" in ai_type:
span.set_data(SPANDATA.GEN_AI_SYSTEM, "anthropic")
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, "anthropic")
elif "openai" in ai_type:
span.set_data(SPANDATA.GEN_AI_SYSTEM, "openai")
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, "openai")

for key, attribute in DATA_FIELDS.items():
if key in all_params and all_params[key] is not None:
Expand Down Expand Up @@ -451,9 +451,9 @@ def on_chat_model_start(

ai_type = all_params.get("_type", "")
if "anthropic" in ai_type:
span.set_data(SPANDATA.GEN_AI_SYSTEM, "anthropic")
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, "anthropic")
elif "openai" in ai_type:
span.set_data(SPANDATA.GEN_AI_SYSTEM, "openai")
span.set_data(SPANDATA.GEN_AI_PROVIDER_NAME, "openai")

agent_name = _get_current_agent()
if agent_name:
Expand Down
2 changes: 1 addition & 1 deletion sentry_sdk/integrations/litellm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def _input_callback(kwargs: "Dict[str, Any]") -> None:
_get_metadata_dict(kwargs)["_sentry_span"] = span

# Set basic data
set_data_normalized(span, SPANDATA.GEN_AI_SYSTEM, provider)
set_data_normalized(span, SPANDATA.GEN_AI_PROVIDER_NAME, provider)
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, operation)

# Record input/messages if allowed
Expand Down
2 changes: 1 addition & 1 deletion sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ def _commmon_set_input_data(
kwargs: "dict[str, Any]",
) -> None:
# Input attributes: Common
set_data_normalized(span, SPANDATA.GEN_AI_SYSTEM, "openai")
set_data_normalized(span, SPANDATA.GEN_AI_PROVIDER_NAME, "openai")

# Input attributes: Optional
kwargs_keys_to_attributes = {
Expand Down
2 changes: 1 addition & 1 deletion sentry_sdk/integrations/openai_agents/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def _record_exception_on_span(span: "Span", error: Exception) -> "Any":

def _set_agent_data(span: "sentry_sdk.tracing.Span", agent: "agents.Agent") -> None:
span.set_data(
SPANDATA.GEN_AI_SYSTEM, "openai"
SPANDATA.GEN_AI_PROVIDER_NAME, "openai"
) # See footnote for https://opentelemetry.io/docs/specs/semconv/registry/attributes/gen-ai/#gen-ai-system for explanation why.

span.set_data(SPANDATA.GEN_AI_AGENT_NAME, agent.name)
Expand Down
Loading