Skip to content

ref(attributes): Scrub S3 object keys by default #713

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
pabloDeputter wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ref(attributes): Scrub S3 object keys by default #713

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
27 changes: 18 additions & 9 deletions javascript/sentry-conventions/src/attributes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3075,7 +3075,7 @@ export type AWS_S3_BUCKET_TYPE = string;
*
* Attribute Value Type: `string` {@link AWS_S3_COPY_SOURCE_TYPE}
*
* Apply Scrubbing: manual
* Apply Scrubbing: auto
*
* Attribute defined in OTEL: Yes
* Visibility: public
Expand All @@ -3096,7 +3096,7 @@ export type AWS_S3_COPY_SOURCE_TYPE = string;
*
* Attribute Value Type: `string` {@link AWS_S3_DELETE_TYPE}
*
* Apply Scrubbing: manual
* Apply Scrubbing: auto
*
* Attribute defined in OTEL: Yes
* Visibility: public
Expand All @@ -3117,7 +3117,7 @@ export type AWS_S3_DELETE_TYPE = string;
*
* Attribute Value Type: `string` {@link AWS_S3_KEY_TYPE}
*
* Apply Scrubbing: manual
* Apply Scrubbing: auto
*
* Attribute defined in OTEL: Yes
* Visibility: public
Expand Down Expand Up @@ -24519,13 +24519,16 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['aws.s3.copy_source'],
applyScrubbing: {
key: 'manual',
key: 'auto',
},
isInOtel: true,
visibility: 'public',
example: 'someFile.yml',
examples: ['someFile.yml'],
changelog: [{ version: '0.27.0', prs: [672], description: 'Added aws.s3.copy_source attribute' }],
changelog: [
{ version: 'next', description: 'Changed apply_scrubbing from manual to auto' },
{ version: '0.27.0', prs: [672], description: 'Added aws.s3.copy_source attribute' },
],
additionalContext: [
'Applicable to the copy-object and upload-part-copy operations, corresponding to the CopySource parameter.',
],
Expand All @@ -24535,27 +24538,33 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
type: 'string',
keys: ['aws.s3.delete'],
applyScrubbing: {
key: 'manual',
key: 'auto',
},
isInOtel: true,
visibility: 'public',
example: 'Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean',
examples: ['Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean'],
changelog: [{ version: '0.27.0', prs: [672], description: 'Added aws.s3.delete attribute' }],
changelog: [
{ version: 'next', description: 'Changed apply_scrubbing from manual to auto' },
{ version: '0.27.0', prs: [672], description: 'Added aws.s3.delete attribute' },
],
additionalContext: ['Applicable only to the delete-objects operation, corresponding to its Delete parameter.'],
},
'aws.s3.key': {
brief: 'The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.',
type: 'string',
keys: ['aws.s3.key'],
applyScrubbing: {
key: 'manual',
key: 'auto',
},
isInOtel: true,
visibility: 'public',
example: 'someFile.yml',
examples: ['someFile.yml'],
changelog: [{ version: '0.27.0', prs: [672], description: 'Added aws.s3.key attribute' }],
changelog: [
{ version: 'next', description: 'Changed apply_scrubbing from manual to auto' },
{ version: '0.27.0', prs: [672], description: 'Added aws.s3.key attribute' },
],
},
'aws.s3.part_number': {
brief:
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/aws/aws__s3__copy_source.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@
],
"type": "string",
"apply_scrubbing": {
"key": "manual"
"key": "auto"
},
"is_in_otel": true,
"visibility": "public",
"examples": ["someFile.yml"],
"changelog": [
{
"version": "next",
"description": "Changed apply_scrubbing from manual to auto"
},
{
"version": "0.27.0",
"prs": [672],
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/aws/aws__s3__delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@
"additional_context": ["Applicable only to the delete-objects operation, corresponding to its Delete parameter."],
"type": "string",
"apply_scrubbing": {
"key": "manual"
"key": "auto"
},
"is_in_otel": true,
"visibility": "public",
"examples": ["Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean"],
"changelog": [
{
"version": "next",
"description": "Changed apply_scrubbing from manual to auto"
},
{
"version": "0.27.0",
"prs": [672],
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/aws/aws__s3__key.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
"brief": "The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
"key": "auto"
},
"is_in_otel": true,
"visibility": "public",
"examples": ["someFile.yml"],
"changelog": [
{
"version": "next",
"description": "Changed apply_scrubbing from manual to auto"
},
{
"version": "0.27.0",
"prs": [672],
Expand Down
24 changes: 18 additions & 6 deletions python/src/sentry_conventions/attributes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2174,7 +2174,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
"""The source object (in the form bucket/key) for the copy operation.

Type: str
Apply Scrubbing: manual
Apply Scrubbing: auto
Defined in OTEL: Yes
Visibility: public
Example: "someFile.yml"
Expand All @@ -2185,7 +2185,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
"""The delete request container that specifies the objects to be deleted.

Type: str
Apply Scrubbing: manual
Apply Scrubbing: auto
Defined in OTEL: Yes
Visibility: public
Example: "Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean"
Expand All @@ -2196,7 +2196,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
"""The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.

Type: str
Apply Scrubbing: manual
Apply Scrubbing: auto
Defined in OTEL: Yes
Visibility: public
Example: "someFile.yml"
Expand Down Expand Up @@ -14664,12 +14664,16 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
brief="The source object (in the form bucket/key) for the copy operation.",
type=AttributeType.STRING,
keys=("aws.s3.copy_source",),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.MANUAL),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
is_in_otel=True,
visibility=Visibility.PUBLIC,
example="someFile.yml",
examples=["someFile.yml"],
changelog=[
ChangelogEntry(
version="next",
description="Changed apply_scrubbing from manual to auto",
),
ChangelogEntry(
version="0.27.0",
prs=[672],
Expand All @@ -14684,14 +14688,18 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
brief="The delete request container that specifies the objects to be deleted.",
type=AttributeType.STRING,
keys=("aws.s3.delete",),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.MANUAL),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
is_in_otel=True,
visibility=Visibility.PUBLIC,
example="Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean",
examples=[
"Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean"
],
changelog=[
ChangelogEntry(
version="next",
description="Changed apply_scrubbing from manual to auto",
),
ChangelogEntry(
version="0.27.0", prs=[672], description="Added aws.s3.delete attribute"
),
Expand All @@ -14704,12 +14712,16 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
brief="The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.",
type=AttributeType.STRING,
keys=("aws.s3.key",),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.MANUAL),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
is_in_otel=True,
visibility=Visibility.PUBLIC,
example="someFile.yml",
examples=["someFile.yml"],
changelog=[
ChangelogEntry(
version="next",
description="Changed apply_scrubbing from manual to auto",
),
ChangelogEntry(
version="0.27.0", prs=[672], description="Added aws.s3.key attribute"
),
Expand Down
Loading