この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/semconv/object-stores/s3/
翻訳元: open-telemetry/semantic-conventions v1.44.0(コミット e10a930)
AWS S3クライアントスパンに関するセマンティック規約
ステータス: Development
Status:
AWS S3クライアントスパンに関するセマンティック規約は、一般的なAWS SDKセマンティック規約を拡張します。
スパン種別はCLIENTであるべきです(SHOULD)。
スパンステータスはエラーの記録文書に従うべきです(SHOULD)。
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | rpc.system.nameに置き換えられました。 | Required | string | aws-apiという値。 | aws-api |
aws.extended_request_id | Conditionally Required If available. | string | レスポンスヘッダーx-amz-id-2で返されるAWS拡張リクエストID。 | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.request_id | Recommended | string | レスポンスヘッダーx-amzn-requestid、x-amzn-request-id、x-amz-request-idのいずれかで返されるAWSリクエストID。 | 79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ | |
aws.s3.bucket | Recommended | string | リクエストが参照するS3バケット名。S3 API操作の--bucketパラメータに対応します。[1] | some-bucket-name | |
aws.s3.copy_source | Recommended | string | コピー操作におけるコピー元オブジェクト(bucket/keyの形式)。[2] | someFile.yml | |
aws.s3.delete | Recommended | string | 削除対象のオブジェクトを指定する削除リクエストコンテナ。[3] | Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean | |
aws.s3.key | Recommended | string | リクエストが参照するS3オブジェクトキー。S3 API操作の--keyパラメータに対応します。[4] | someFile.yml | |
aws.s3.part_number | Recommended | int | マルチパートアップロード操作でアップロードされているパートの番号。1から10,000までの正の整数です。[5] | 3456 | |
aws.s3.upload_id | Recommended | string | マルチパートアップロードを識別するアップロードID。[6] | dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ | |
cloud.region | Recommended | string | 要求されたサービスへのアクセス先となるAWSリージョン。[7] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | AWS SDKによって返される、リクエストに対応する操作の名前。 | GetItem; PutItem | |
rpc.service | 完全修飾名であることが期待される rpc.methodに含めるべき値です。 | Recommended | string | AWS SDKによって返される、リクエスト先のサービス名。 | DynamoDB; S3 |
[1] aws.s3.bucket: bucket属性は、バケットを参照するすべてのS3操作、つまりバケット名を必須パラメータとして要求するすべての操作に適用されます。
これはlist-bucketsを除くほぼすべてのS3操作に当てはまります。
[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操作、つまりオブジェクトキーを必須パラメータとして要求するすべての操作に適用されます。
特に、次の操作に当てはまります。
- copy-object
- delete-object
- get-object
- head-object
- put-object
- restore-object
- select-object-content
- abort-multipart-upload
- complete-multipart-upload
- create-multipart-upload
- list-parts
- upload-part
- upload-part-copy
[5] aws.s3.part_number: part_number属性は、upload-part操作とupload-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: 特定のAWSサービス呼び出しに対してSDKクライアントが対象とするAWSリージョンを指定します。この属性の値は、AWSのドキュメントに記載されているAWSリージョンコードに従うべきです(should)。
rpc.systemには、次のよく知られた値の一覧があります。これらのいずれかが該当する場合は、対応する値を使用しなければなりません(MUST)。そうでない場合は、独自の値を使用してもかまいません(MAY)。
| Value | Description | Stability |
|---|---|---|
apache_dubbo | Apache Dubbo | |
connect_rpc | Connect RPC | |
dotnet_wcf | .NET WCF | |
grpc | gRPC | |
java_rmi | Java RMI | |
jsonrpc | JSON-RPC | |
onc_rpc | ONC RPC (Sun RPC) |