feat(attributes): add gen_ai.provider.name, deprecate gen_ai.system, remove unused gen_ai attributes (#253)

Author: obostjancic

javascript/sentry-conventions/src/attributes.ts

@@ -252,9 +252,9 @@ export type AI_MODEL_ID_TYPE = string;
  *
  * Attribute defined in OTEL: No
  *
- * Aliases: {@link GEN_AI_SYSTEM} `gen_ai.system`
+ * Aliases: {@link GEN_AI_PROVIDER_NAME} `gen_ai.provider.name`, {@link GEN_AI_SYSTEM} `gen_ai.system`
  *
- * @deprecated Use {@link GEN_AI_SYSTEM} (gen_ai.system) instead
+ * @deprecated Use {@link GEN_AI_PROVIDER_NAME} (gen_ai.provider.name) instead
  * @example "openai"
  */
 export const AI_MODEL_PROVIDER = 'ai.model.provider';
@@ -2125,46 +2125,6 @@ export const GEN_AI_AGENT_NAME = 'gen_ai.agent.name';
  */
 export type GEN_AI_AGENT_NAME_TYPE = string;
 
-// Path: model/attributes/gen_ai/gen_ai__assistant__message.json
-
-/**
- * The assistant message passed to the model. `gen_ai.assistant.message`
- *
- * Attribute Value Type: `string` {@link GEN_AI_ASSISTANT_MESSAGE_TYPE}
- *
- * Contains PII: true
- *
- * Attribute defined in OTEL: No
- *
- * @example "get_weather tool call"
- */
-export const GEN_AI_ASSISTANT_MESSAGE = 'gen_ai.assistant.message';
-
-/**
- * Type for {@link GEN_AI_ASSISTANT_MESSAGE} gen_ai.assistant.message
- */
-export type GEN_AI_ASSISTANT_MESSAGE_TYPE = string;
-
-// Path: model/attributes/gen_ai/gen_ai__choice.json
-
-/**
- * The model's response message. `gen_ai.choice`
- *
- * Attribute Value Type: `string` {@link GEN_AI_CHOICE_TYPE}
- *
- * Contains PII: true
- *
- * Attribute defined in OTEL: No
- *
- * @example "The weather in Paris is rainy and overcast, with temperatures around 57°F"
- */
-export const GEN_AI_CHOICE = 'gen_ai.choice';
-
-/**
- * Type for {@link GEN_AI_CHOICE} gen_ai.choice
- */
-export type GEN_AI_CHOICE_TYPE = string;
-
 // Path: model/attributes/gen_ai/gen_ai__conversation__id.json
 
 /**
@@ -2388,6 +2348,28 @@ export const GEN_AI_PROMPT = 'gen_ai.prompt';
  */
 export type GEN_AI_PROMPT_TYPE = string;
 
+// Path: model/attributes/gen_ai/gen_ai__provider__name.json
+
+/**
+ * The Generative AI provider as identified by the client or server instrumentation. `gen_ai.provider.name`
+ *
+ * Attribute Value Type: `string` {@link GEN_AI_PROVIDER_NAME_TYPE}
+ *
+ * Contains PII: maybe
+ *
+ * Attribute defined in OTEL: Yes
+ *
+ * Aliases: {@link AI_MODEL_PROVIDER} `ai.model.provider`, {@link GEN_AI_SYSTEM} `gen_ai.system`
+ *
+ * @example "openai"
+ */
+export const GEN_AI_PROVIDER_NAME = 'gen_ai.provider.name';
+
+/**
+ * Type for {@link GEN_AI_PROVIDER_NAME} gen_ai.provider.name
+ */
+export type GEN_AI_PROVIDER_NAME_TYPE = string;
+
 // Path: model/attributes/gen_ai/gen_ai__request__available_tools.json
 
 /**
@@ -2785,8 +2767,9 @@ export type GEN_AI_RESPONSE_TOOL_CALLS_TYPE = string;
  *
  * Attribute defined in OTEL: Yes
  *
- * Aliases: {@link AI_MODEL_PROVIDER} `ai.model.provider`
+ * Aliases: {@link AI_MODEL_PROVIDER} `ai.model.provider`, {@link GEN_AI_PROVIDER_NAME} `gen_ai.provider.name`
  *
+ * @deprecated Use {@link GEN_AI_PROVIDER_NAME} (gen_ai.provider.name) instead
  * @example "openai"
  */
 export const GEN_AI_SYSTEM = 'gen_ai.system';
@@ -3191,26 +3174,6 @@ export const GEN_AI_USAGE_TOTAL_TOKENS = 'gen_ai.usage.total_tokens';
  */
 export type GEN_AI_USAGE_TOTAL_TOKENS_TYPE = number;
 
-// Path: model/attributes/gen_ai/gen_ai__user__message.json
-
-/**
- * The user message passed to the model. `gen_ai.user.message`
- *
- * Attribute Value Type: `string` {@link GEN_AI_USER_MESSAGE_TYPE}
- *
- * Contains PII: true
- *
- * Attribute defined in OTEL: No
- *
- * @example "What's the weather in Paris?"
- */
-export const GEN_AI_USER_MESSAGE = 'gen_ai.user.message';
-
-/**
- * Type for {@link GEN_AI_USER_MESSAGE} gen_ai.user.message
- */
-export type GEN_AI_USER_MESSAGE_TYPE = string;
-
 // Path: model/attributes/graphql/graphql__operation__name.json
 
 /**
@@ -9024,8 +8987,6 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
   [FRAMES_TOTAL]: 'integer',
   [FS_ERROR]: 'string',
   [GEN_AI_AGENT_NAME]: 'string',
-  [GEN_AI_ASSISTANT_MESSAGE]: 'string',
-  [GEN_AI_CHOICE]: 'string',
   [GEN_AI_CONVERSATION_ID]: 'string',
   [GEN_AI_COST_INPUT_TOKENS]: 'double',
   [GEN_AI_COST_OUTPUT_TOKENS]: 'double',
@@ -9037,6 +8998,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
   [GEN_AI_OUTPUT_MESSAGES]: 'string',
   [GEN_AI_PIPELINE_NAME]: 'string',
   [GEN_AI_PROMPT]: 'string',
+  [GEN_AI_PROVIDER_NAME]: 'string',
   [GEN_AI_REQUEST_AVAILABLE_TOOLS]: 'string',
   [GEN_AI_REQUEST_FREQUENCY_PENALTY]: 'double',
   [GEN_AI_REQUEST_MAX_TOKENS]: 'integer',
@@ -9075,7 +9037,6 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
   [GEN_AI_USAGE_OUTPUT_TOKENS_REASONING]: 'integer',
   [GEN_AI_USAGE_PROMPT_TOKENS]: 'integer',
   [GEN_AI_USAGE_TOTAL_TOKENS]: 'integer',
-  [GEN_AI_USER_MESSAGE]: 'string',
   [GRAPHQL_OPERATION_NAME]: 'string',
   [GRAPHQL_OPERATION_TYPE]: 'string',
   [HTTP_CLIENT_IP]: 'string',
@@ -9455,8 +9416,6 @@ export type AttributeName =
   | typeof FRAMES_TOTAL
   | typeof FS_ERROR
   | typeof GEN_AI_AGENT_NAME
-  | typeof GEN_AI_ASSISTANT_MESSAGE
-  | typeof GEN_AI_CHOICE
   | typeof GEN_AI_CONVERSATION_ID
   | typeof GEN_AI_COST_INPUT_TOKENS
   | typeof GEN_AI_COST_OUTPUT_TOKENS
@@ -9468,6 +9427,7 @@ export type AttributeName =
   | typeof GEN_AI_OUTPUT_MESSAGES
   | typeof GEN_AI_PIPELINE_NAME
   | typeof GEN_AI_PROMPT
+  | typeof GEN_AI_PROVIDER_NAME
   | typeof GEN_AI_REQUEST_AVAILABLE_TOOLS
   | typeof GEN_AI_REQUEST_FREQUENCY_PENALTY
   | typeof GEN_AI_REQUEST_MAX_TOKENS
@@ -9506,7 +9466,6 @@ export type AttributeName =
   | typeof GEN_AI_USAGE_OUTPUT_TOKENS_REASONING
   | typeof GEN_AI_USAGE_PROMPT_TOKENS
   | typeof GEN_AI_USAGE_TOTAL_TOKENS
-  | typeof GEN_AI_USER_MESSAGE
   | typeof GRAPHQL_OPERATION_NAME
   | typeof GRAPHQL_OPERATION_TYPE
   | typeof HTTP_CLIENT_IP
@@ -9925,9 +9884,9 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     isInOtel: false,
     example: 'openai',
     deprecation: {
-      replacement: 'gen_ai.system',
+      replacement: 'gen_ai.provider.name',
     },
-    aliases: [GEN_AI_SYSTEM],
+    aliases: [GEN_AI_PROVIDER_NAME, GEN_AI_SYSTEM],
   },
   [AI_PIPELINE_NAME]: {
     brief: 'The name of the AI pipeline.',
@@ -10873,24 +10832,6 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     isInOtel: true,
     example: 'ResearchAssistant',
   },
-  [GEN_AI_ASSISTANT_MESSAGE]: {
-    brief: 'The assistant message passed to the model.',
-    type: 'string',
-    pii: {
-      isPii: 'true',
-    },
-    isInOtel: false,
-    example: 'get_weather tool call',
-  },
-  [GEN_AI_CHOICE]: {
-    brief: "The model's response message.",
-    type: 'string',
-    pii: {
-      isPii: 'true',
-    },
-    isInOtel: false,
-    example: 'The weather in Paris is rainy and overcast, with temperatures around 57°F',
-  },
   [GEN_AI_CONVERSATION_ID]: {
     brief:
       'The unique identifier for a conversation (session, thread), used to store and correlate messages within this conversation.',
@@ -11001,6 +10942,16 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
       reason: 'Deprecated from OTEL, use gen_ai.input.messages with the new format instead.',
     },
   },
+  [GEN_AI_PROVIDER_NAME]: {
+    brief: 'The Generative AI provider as identified by the client or server instrumentation.',
+    type: 'string',
+    pii: {
+      isPii: 'maybe',
+    },
+    isInOtel: true,
+    example: 'openai',
+    aliases: [AI_MODEL_PROVIDER, GEN_AI_SYSTEM],
+  },
   [GEN_AI_REQUEST_AVAILABLE_TOOLS]: {
     brief: 'The available tools for the model. It has to be a stringified version of an array of objects.',
     type: 'string',
@@ -11204,7 +11155,10 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     },
     isInOtel: true,
     example: 'openai',
-    aliases: [AI_MODEL_PROVIDER],
+    deprecation: {
+      replacement: 'gen_ai.provider.name',
+    },
+    aliases: [AI_MODEL_PROVIDER, GEN_AI_PROVIDER_NAME],
   },
   [GEN_AI_SYSTEM_INSTRUCTIONS]: {
     brief: 'The system instructions passed to the model.',
@@ -11393,15 +11347,6 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     example: 20,
     aliases: [AI_TOTAL_TOKENS_USED],
   },
-  [GEN_AI_USER_MESSAGE]: {
-    brief: 'The user message passed to the model.',
-    type: 'string',
-    pii: {
-      isPii: 'true',
-    },
-    isInOtel: false,
-    example: "What's the weather in Paris?",
-  },
   [GRAPHQL_OPERATION_NAME]: {
     brief: 'The name of the operation being executed.',
     type: 'string',
@@ -14263,8 +14208,6 @@ export type Attributes = {
   [FRAMES_TOTAL]?: FRAMES_TOTAL_TYPE;
   [FS_ERROR]?: FS_ERROR_TYPE;
   [GEN_AI_AGENT_NAME]?: GEN_AI_AGENT_NAME_TYPE;
-  [GEN_AI_ASSISTANT_MESSAGE]?: GEN_AI_ASSISTANT_MESSAGE_TYPE;
-  [GEN_AI_CHOICE]?: GEN_AI_CHOICE_TYPE;
   [GEN_AI_CONVERSATION_ID]?: GEN_AI_CONVERSATION_ID_TYPE;
   [GEN_AI_COST_INPUT_TOKENS]?: GEN_AI_COST_INPUT_TOKENS_TYPE;
   [GEN_AI_COST_OUTPUT_TOKENS]?: GEN_AI_COST_OUTPUT_TOKENS_TYPE;
@@ -14276,6 +14219,7 @@ export type Attributes = {
   [GEN_AI_OUTPUT_MESSAGES]?: GEN_AI_OUTPUT_MESSAGES_TYPE;
   [GEN_AI_PIPELINE_NAME]?: GEN_AI_PIPELINE_NAME_TYPE;
   [GEN_AI_PROMPT]?: GEN_AI_PROMPT_TYPE;
+  [GEN_AI_PROVIDER_NAME]?: GEN_AI_PROVIDER_NAME_TYPE;
   [GEN_AI_REQUEST_AVAILABLE_TOOLS]?: GEN_AI_REQUEST_AVAILABLE_TOOLS_TYPE;
   [GEN_AI_REQUEST_FREQUENCY_PENALTY]?: GEN_AI_REQUEST_FREQUENCY_PENALTY_TYPE;
   [GEN_AI_REQUEST_MAX_TOKENS]?: GEN_AI_REQUEST_MAX_TOKENS_TYPE;
@@ -14314,7 +14258,6 @@ export type Attributes = {
   [GEN_AI_USAGE_OUTPUT_TOKENS_REASONING]?: GEN_AI_USAGE_OUTPUT_TOKENS_REASONING_TYPE;
   [GEN_AI_USAGE_PROMPT_TOKENS]?: GEN_AI_USAGE_PROMPT_TOKENS_TYPE;
   [GEN_AI_USAGE_TOTAL_TOKENS]?: GEN_AI_USAGE_TOTAL_TOKENS_TYPE;
-  [GEN_AI_USER_MESSAGE]?: GEN_AI_USER_MESSAGE_TYPE;
   [GRAPHQL_OPERATION_NAME]?: GRAPHQL_OPERATION_NAME_TYPE;
   [GRAPHQL_OPERATION_TYPE]?: GRAPHQL_OPERATION_TYPE_TYPE;
   [HTTP_CLIENT_IP]?: HTTP_CLIENT_IP_TYPE;

model/attributes/ai/ai__model__provider.json

@@ -9,7 +9,7 @@
   "example": "openai",
   "deprecation": {
     "_status": null,
-    "replacement": "gen_ai.system"
+    "replacement": "gen_ai.provider.name"
   },
-  "alias": ["gen_ai.system"]
+  "alias": ["gen_ai.provider.name", "gen_ai.system"]
 }

model/attributes/gen_ai/gen_ai__assistant__message.json

@@ -0,0 +1,11 @@
+{
+  "key": "gen_ai.provider.name",
+  "brief": "The Generative AI provider as identified by the client or server instrumentation.",
+  "type": "string",
+  "pii": {
+    "key": "maybe"
+  },
+  "is_in_otel": true,
+  "example": "openai",
+  "alias": ["ai.model.provider", "gen_ai.system"]
+}

model/attributes/gen_ai/gen_ai__choice.json

@@ -7,5 +7,9 @@
   },
   "is_in_otel": true,
   "example": "openai",
-  "alias": ["ai.model.provider"]
+  "deprecation": {
+    "_status": null,
+    "replacement": "gen_ai.provider.name"
+  },
+  "alias": ["ai.model.provider", "gen_ai.provider.name"]
 }