Skip to content

fix(attributes): Apply consistent scrubbing across deprecations #692

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

Merged
mjq merged 2 commits into from
Oct 14, 2026
Merged

fix(attributes): Apply consistent scrubbing across deprecations #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e97278
fix(attributes): Apply consistent scrubbing across deprecations
mjq Oct 9, 2026
2c1fdc4
Merge branch 'main' into mjq/deprecation-inconsistency
Lms24 Oct 14, 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
52 changes: 26 additions & 26 deletions javascript/sentry-conventions/src/attributes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export type AI_FREQUENCY_PENALTY_TYPE = number;
*
* Attribute Value Type: `string` {@link AI_FUNCTION_CALL_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -359,7 +359,7 @@ export type AI_PIPELINE_NAME_TYPE = string;
*
* Attribute Value Type: `string` {@link AI_PREAMBLE_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -867,7 +867,7 @@ export type AI_TEMPERATURE_TYPE = number;
*
* Attribute Value Type: `Array<string>` {@link AI_TEXTS_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -961,7 +961,7 @@ export type AI_TOOLS_TYPE = Array<string>;
*
* Attribute Value Type: `Array<string>` {@link AI_TOOL_CALLS_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -6678,7 +6678,7 @@ export type EFFECTIVECONNECTIONTYPE_TYPE = string;
*
* Attribute Value Type: `string` {@link ENVIRONMENT_TYPE}
*
* Apply Scrubbing: manual
* Apply Scrubbing: never
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -8881,7 +8881,7 @@ export type GEN_AI_SYSTEM_INSTRUCTIONS_TYPE = string;
*
* Attribute Value Type: `string` {@link GEN_AI_SYSTEM_MESSAGE_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -9017,7 +9017,7 @@ export type GEN_AI_TOOL_INPUT_TYPE = string;
*
* Attribute Value Type: `string` {@link GEN_AI_TOOL_MESSAGE_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -12353,7 +12353,7 @@ export type MCP_TOOL_NAME_TYPE = string;
*
* Attribute Value Type: `string` {@link MCP_TOOL_RESULT_CONTENT_TYPE}
*
* Apply Scrubbing: auto - Tool results can contain user data
* Apply Scrubbing: manual - Tool results can contain user data
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -13986,7 +13986,7 @@ export type NET_PEER_IP_TYPE = string;
*
* Attribute Value Type: `string` {@link NET_PEER_NAME_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: Yes
* Visibility: public
Expand Down Expand Up @@ -15365,7 +15365,7 @@ export type REPLAY_ID_TYPE = string;
*
* Attribute Value Type: `string` {@link RESOURCE_DEPLOYMENT_ENVIRONMENT_TYPE}
*
* Apply Scrubbing: manual
* Apply Scrubbing: never
*
* Attribute defined in OTEL: Yes
* Visibility: public
Expand All @@ -15387,7 +15387,7 @@ export type RESOURCE_DEPLOYMENT_ENVIRONMENT_TYPE = string;
*
* Attribute Value Type: `string` {@link RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME_TYPE}
*
* Apply Scrubbing: manual
* Apply Scrubbing: never
*
* Attribute defined in OTEL: Yes
* Visibility: public
Expand Down Expand Up @@ -17632,7 +17632,7 @@ export type SENTRY_TRACE_STATUS_TYPE = string;
*
* Attribute Value Type: `string` {@link SENTRY_TRANSACTION_TYPE}
*
* Apply Scrubbing: never
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -17863,7 +17863,7 @@ export type SERVER_ADDRESS_TYPE = string;
*
* Attribute Value Type: `string` {@link SERVER_NAME_TYPE}
*
* Apply Scrubbing: auto
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
Expand Down Expand Up @@ -22375,7 +22375,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['gen_ai.tool.name', 'ai.function_call', 'mcp.tool.name'],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -22549,7 +22549,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['gen_ai.system_instructions', 'ai.preamble', 'gen_ai.system.message'],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -22958,7 +22958,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
'gen_ai.prompt',
],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -23042,7 +23042,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string[]',
keys: ['gen_ai.output.messages', 'ai.response.text', 'ai.response.toolCalls', 'ai.responses', 'ai.tool_calls'],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -26923,7 +26923,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
'resource.deployment.environment.name',
],
applyScrubbing: {
key: 'manual',
key: 'never',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -28510,7 +28510,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['gen_ai.system_instructions', 'ai.preamble', 'gen_ai.system.message'],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -28630,7 +28630,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
'mcp.tool.result.content',
],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -31242,7 +31242,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
'mcp.tool.result.content',
],
applyScrubbing: {
key: 'auto',
key: 'manual',
reason: 'Tool results can contain user data',
},
isInOtel: false,
Expand Down Expand Up @@ -32697,7 +32697,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['net.peer.name'],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: true,
visibility: 'public',
Expand Down Expand Up @@ -33652,7 +33652,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
'resource.deployment.environment.name',
],
applyScrubbing: {
key: 'manual',
key: 'never',
},
isInOtel: true,
visibility: 'public',
Expand All @@ -33673,7 +33673,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
'resource.deployment.environment.name',
],
applyScrubbing: {
key: 'manual',
key: 'never',
},
isInOtel: true,
visibility: 'public',
Expand Down Expand Up @@ -35220,7 +35220,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['sentry.segment.name', 'transaction', 'sentry.transaction'],
applyScrubbing: {
key: 'never',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down Expand Up @@ -35413,7 +35413,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['server.address', 'address', 'http.server_name', 'net.host.name', 'server_name'],
applyScrubbing: {
key: 'auto',
key: 'manual',
},
isInOtel: false,
visibility: 'public',
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/ai/ai__function_call.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "For an AI model call, the function that was called. This is deprecated for OpenAI, and replaced by tool_calls",
"type": "string",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": "function_name",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/ai/ai__preamble.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "For an AI model call, the preamble parameter. Preambles are a part of the prompt used to adjust the model's overall behavior and conversation style.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": "You are now a clown.",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/ai/ai__texts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "Raw text inputs provided to the model.",
"type": "string[]",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": ["Hello, how are you?", "What is the capital of France?"],
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/ai/ai__tool_calls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "For an AI model call, the tool calls that were made.",
"type": "string[]",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": ["tool_call_1", "tool_call_2"],
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/environment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The sentry environment.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
"key": "never"
},
"is_in_otel": false,
"example": "production",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/gen_ai/gen_ai__system__message.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The system instructions passed to the model.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": "You are a helpful assistant",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/gen_ai/gen_ai__tool__message.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The response from a tool or function call passed to the model.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": "rainy, 57°F",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/mcp/mcp__tool__result__content.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The content of the tool result.",
"type": "string",
"apply_scrubbing": {
"key": "auto",
"key": "manual",
"reason": "Tool results can contain user data"
Comment on lines +6 to 7

@elramen elramen Oct 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

How come we align on the weaker setting for attributes that can contain user data? Or is the reason text incorrect?

@mjq mjq Oct 13, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@elramen I'm trying to avoid user-visible changes. We prioritize the latest version of attributes in the product, so effectively, that's the scrubbing rule we're applying - so I took the latest rule and applied it to the older deprecated aliases.

},
"is_in_otel": false,
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/net/net__peer__name.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": true,
"example": "example.com",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/resource/resource__deployment__environment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The software deployment environment name.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
"key": "never"
},
"is_in_otel": true,
"example": "production",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/resource/resource__deployment__environment__name.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The software deployment environment name.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
"key": "never"
},
"is_in_otel": true,
"example": "production",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/sentry/sentry__transaction.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The sentry transaction (segment name).",
"type": "string",
"apply_scrubbing": {
"key": "never"
"key": "manual"
},
"is_in_otel": false,
"example": "GET /",
Expand Down
2 changes: 1 addition & 1 deletion model/attributes/server_name.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"brief": "The name of the device. On servers and desktops, this is typically the hostname.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
"key": "manual"
},
"is_in_otel": false,
"example": "example.com",
Expand Down
Loading
Loading