AWS SDKクライアントスパンに関するセマンティック規約

ステータス: Development

コンテキストの伝搬

互換性を参照してください。

AWS SDKスパン

Status:

このスパンは、AWS SDKクライアント呼び出しを記述します。

スパン名は、AWS HTTP APIに従い、Service.Operationという形式でなければなりません（MUST）。例: DynamoDB.GetItem、S3.ListBuckets。これは、rpc.serviceとrpc.methodを.で連結したものと等価であり、RPCクライアントスパンの命名ガイドラインと一致します。

AWS SDKスパン属性は、AWS SDK APIコールにおけるリクエストまたはレスポンスのパラメータに基づいています。これらの規約は、トレーシングを利用するAWSユーザーからのフィードバックに基づいて時間をかけて集められたものであり、新たに興味深い規約が見つかれば今後も増え続けます。

スパン種別は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`
`cloud.region`		`Recommended`	string	要求されたサービスへのアクセス先となるAWSリージョン。[1]	`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] 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)

AWSサービス固有の属性

次のセマンティック規約は、特定のAWSサービスに対応して、一般的なAWS SDK属性を拡張します。

AWS DynamoDB: AWS DynamoDBに関するセマンティック規約。
AWS S3: AWS S3に関するセマンティック規約。
AWS Bedrock: AWS Bedrockに関するセマンティック規約は、OpenTelemetry GenAIセマンティック規約リポジトリに移動しました。
AWS SNS: AWS SNSに関するセマンティック規約。
AWS SQS: AWS SQSに関するセマンティック規約。