AWS S3 客户端 Span 的语义约定

状态: 开发中

状态: 开发中

AWS S3 客户端 Span 的语义约定扩展了通用的 AWS SDK 语义约定

**Span 类型**应为 CLIENT

**Span 状态**应遵循 记录错误文档。

Attributes

Stability需求级别Value Type描述Example Values
rpc.systemDevelopment必需字符串aws-apiaws-api
aws.extended_request_idDevelopment有条件必需 如果可用。字符串在响应头 x-amz-id-2 中返回的 AWS 扩展请求 ID。wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.request_idDevelopment推荐字符串在响应头 x-amzn-requestidx-amzn-request-idx-amz-request-id 中返回的 AWS 请求 ID。79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
aws.s3.bucketDevelopment推荐字符串请求引用的 S3 存储桶名称。对应于 S3 API 操作的 --bucket 参数。[1]some-bucket-name
aws.s3.copy_sourceDevelopment推荐字符串复制操作的源对象(格式为 bucket/key)。[2]someFile.yml
aws.s3.deleteDevelopment推荐字符串指定要删除对象的 delete 请求容器。[3]Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean
aws.s3.keyDevelopment推荐字符串请求引用的 S3 对象键。对应于 S3 API 操作的 --key 参数。[4]someFile.yml
aws.s3.part_numberDevelopment推荐int在分段上传操作中上传的部分的编号。这是一个介于 1 和 10,000 之间的正整数。[5]3456
aws.s3.upload_idDevelopment推荐字符串标识分段上传的上传 ID。[6]dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ
cloud.regionDevelopment推荐字符串正在访问所请求服务的 AWS 区域。[7]us-east-1; us-west-2
rpc.methodDevelopment推荐字符串由 AWS SDK 返回的对应于请求的操作名称。GetItem; PutItem
rpc.serviceDevelopment推荐字符串由 AWS SDK 返回的请求所目标的服务名称。DynamoDB; S3

[1] aws.s3.bucket: bucket 属性适用于所有引用存储桶的 S3 操作,即需要存储桶名称作为强制参数的操作。这适用于几乎所有 S3 操作,除了 list-buckets

[2] aws.s3.copy_source: copy_source 属性适用于 S3 复制操作,对应于 S3 API 中的 copy-object 操作--copy-source 参数。这尤其适用于以下操作:

[3] aws.s3.delete: delete 属性仅适用于 delete-object 操作。delete 属性对应于 S3 API 中的 delete-objects 操作--delete 参数。

[4] aws.s3.key: key 属性适用于所有与对象相关的 S3 操作,即需要对象键作为强制参数的操作。这尤其适用于以下操作:

[5] aws.s3.part_number: part_number 属性仅适用于 upload-partupload-part-copy 操作。part_number 属性对应于 S3 API 中的 upload-part 操作--part-number 参数。

[6] aws.s3.upload_id: upload_id 属性适用于 S3 分段上传操作,对应于 S3 API 分段操作的 --upload-id 参数。这尤其适用于以下操作:

[7] cloud.region: 指定 SDK 客户端针对给定 AWS 服务调用的 AWS 区域。该属性的值应符合 AWS 文档中概述的 AWS 区域代码。


rpc.system 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以改用自定义值。

描述Stability
apache_dubboApache DubboDevelopment
connect_rpcConnect RPCDevelopment
dotnet_wcf.NET WCFDevelopment
grpcgRPCDevelopment
java_rmiJava RMIDevelopment
jsonrpcJSON-RPCDevelopment
onc_rpcONC RPC (Sun RPC)Development