Skip to content
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.

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

Add S3 attributes to the semantic conventions for AWS SDK #3193

Closed
AlexanderWert opened this issue Feb 9, 2023 · 4 comments · Fixed by #3251
Closed

Add S3 attributes to the semantic conventions for AWS SDK #3193

AlexanderWert opened this issue Feb 9, 2023 · 4 comments · Fixed by #3251
Assignees
Labels
spec:trace Related to the specification/trace directory triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal

Comments

@AlexanderWert
Copy link
Member

What are you trying to achieve?

There is a great set of attributes for DynamoDB-related spans in the semantic conventions for the AWS SDK.
Something similar would be also valuable for S3 operations. For example when a span is created for an S3 getObject operation it would be interesting and valuable for analysis to know which S3 bucket and which object is being accessed.

I'm proposing to add relevant S3 specific attributes for the main S3 operations:

Bucket Operations

Operation Proposed attributes
create-bucket aws.s3.bucket
delete-bucket aws.s3.bucket
head-bucket aws.s3.bucket
list-buckets ---

Object operations

Operation Proposed attributes
copy-object aws.s3.bucket, aws.s3.key, aws.s3.copy_source
delete-object aws.s3.bucket, aws.s3.key
delete-objects aws.s3.bucket, aws.s3.delete
get-object aws.s3.bucket, aws.s3.key
head-object aws.s3.bucket, aws.s3.key
list-objects aws.s3.bucket
list-objects-v2 aws.s3.bucket
list-object-versions aws.s3.bucket
put-object aws.s3.bucket, aws.s3.key
restore-object aws.s3.bucket, aws.s3.key
select-object-content aws.s3.bucket, aws.s3.key, aws.s3.input_serialization, aws.s3.output_serialization

Multipart operations

Operation Proposed attributes
abort-multipart-upload aws.s3.bucket, aws.s3.key, aws.s3.upload_id
complete-multipart-upload aws.s3.bucket, aws.s3.key, aws.s3.upload_id
create-multipart-upload aws.s3.bucket, aws.s3.key
list-multipart-uploads aws.s3.bucket
list-parts aws.s3.bucket, aws.s3.key, aws.s3.upload_id
upload-part aws.s3.bucket, aws.s3.key, aws.s3.upload_id, aws.s3.part_number
upload-part-copy aws.s3.bucket, aws.s3.key, aws.s3.upload_id, aws.s3.part_number, aws.s3.copy_source
@AlexanderWert AlexanderWert added the spec:trace Related to the specification/trace directory label Feb 9, 2023
@AlexanderWert
Copy link
Member Author

@willarmiros @iNikem @arminru As you were involved in the aws.dynamodb.* semantic conventions, what do you think about this proposal?

@willarmiros
Copy link
Contributor

Hi @AlexanderWert - I love it, consider me in support. We also plan to add SQS attributes eventually as well!

@AlexanderWert
Copy link
Member Author

Hi @jmacd,
how can we proceed with that? Does it make sense for me to create a PR for the above, already, or are there any objections with that proposal?

Thanks!

@carlosalberto carlosalberto added the triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal label Feb 20, 2023
@carlosalberto
Copy link
Contributor

Feel free to create a Pr @AlexanderWert - and let's discuss the details on the PR itself, once people take a look, etc. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:trace Related to the specification/trace directory triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants