Semantic conventions for AWS DynamoDB client operations

Status: Development

The Semantic Conventions for AWS DynamoDB extend and override the general AWS SDK Semantic Conventions and Database Semantic Conventions.

Spans

Spans representing calls to AWS DynamoDB adhere to the general Semantic Conventions for Database Client Spans.

DynamoDB.BatchGetItem

Status: Development

This span represents a DynamoDB.BatchGetItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.table_namesDevelopmentRecommendedstring[]The keys in the RequestItems object field.["Users", "Cats"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.BatchWriteItem

Status: Development

This span represents a DynamoDB.BatchWriteItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.item_collection_metricsDevelopmentRecommendedstringThe JSON-serialized value of the ItemCollectionMetrics response field.{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }
aws.dynamodb.table_namesDevelopmentRecommendedstring[]The keys in the RequestItems object field.["Users", "Cats"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.CreateTable

Status: Development

This span represents a DynamoDB.CreateTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.global_secondary_indexesDevelopmentRecommendedstring[]The JSON-serialized value of each item of the GlobalSecondaryIndexes request field["{ \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"]
aws.dynamodb.item_collection_metricsDevelopmentRecommendedstringThe JSON-serialized value of the ItemCollectionMetrics response field.{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }
aws.dynamodb.local_secondary_indexesDevelopmentRecommendedstring[]The JSON-serialized value of each item of the LocalSecondaryIndexes request field.["{ \"IndexArn\": \"string\", \"IndexName\": \"string\", \"IndexSizeBytes\": number, \"ItemCount\": number, \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" } }"]
aws.dynamodb.provisioned_read_capacityDevelopmentRecommendeddoubleThe value of the ProvisionedThroughput.ReadCapacityUnits request parameter.1.0; 2.0
aws.dynamodb.provisioned_write_capacityDevelopmentRecommendeddoubleThe value of the ProvisionedThroughput.WriteCapacityUnits request parameter.1.0; 2.0
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.DeleteItem

Status: Development

This span represents a DynamoDB.DeleteItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.item_collection_metricsDevelopmentRecommendedstringThe JSON-serialized value of the ItemCollectionMetrics response field.{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.DeleteTable

Status: Development

This span represents a DynamoDB.DeleteTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.DescribeTable

Status: Development

This span represents a DynamoDB.DescribeTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.GetItem

Status: Development

This span represents a DynamoDB.GetItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consistent_readDevelopmentRecommendedbooleanThe value of the ConsistentRead request parameter.
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.projectionDevelopmentRecommendedstringThe value of the ProjectionExpression request parameter.Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.ListTables

Status: Development

This span represents a DynamoDB.ListTables call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.exclusive_start_tableDevelopmentRecommendedstringThe value of the ExclusiveStartTableName request parameter.Users; CatsTable
aws.dynamodb.limitDevelopmentRecommendedintThe value of the Limit request parameter.10
aws.dynamodb.table_countDevelopmentRecommendedintThe number of items in the TableNames response parameter.20
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.PutItem

Status: Development

This span represents a DynamoDB.PutItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.item_collection_metricsDevelopmentRecommendedstringThe JSON-serialized value of the ItemCollectionMetrics response field.{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }
aws.dynamodb.table_namesDevelopmentRecommendedstring[]The keys in the RequestItems object field.["Users", "Cats"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.Query

Status: Development

This span represents a DynamoDB.Query call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.attributes_to_getDevelopmentRecommendedstring[]The value of the AttributesToGet request parameter.["lives", "id"]
aws.dynamodb.consistent_readDevelopmentRecommendedbooleanThe value of the ConsistentRead request parameter.
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.index_nameDevelopmentRecommendedstringThe value of the IndexName request parameter.name_to_group
aws.dynamodb.limitDevelopmentRecommendedintThe value of the Limit request parameter.10
aws.dynamodb.projectionDevelopmentRecommendedstringThe value of the ProjectionExpression request parameter.Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews
aws.dynamodb.scan_forwardDevelopmentRecommendedbooleanThe value of the ScanIndexForward request parameter.
aws.dynamodb.selectDevelopmentRecommendedstringThe value of the Select request parameter.ALL_ATTRIBUTES; COUNT
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.Scan

Status: Development

This span represents a DynamoDB.Scan call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.attributes_to_getDevelopmentRecommendedstring[]The value of the AttributesToGet request parameter.["lives", "id"]
aws.dynamodb.consistent_readDevelopmentRecommendedbooleanThe value of the ConsistentRead request parameter.
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.countDevelopmentRecommendedintThe value of the Count response parameter.10
aws.dynamodb.index_nameDevelopmentRecommendedstringThe value of the IndexName request parameter.name_to_group
aws.dynamodb.limitDevelopmentRecommendedintThe value of the Limit request parameter.10
aws.dynamodb.projectionDevelopmentRecommendedstringThe value of the ProjectionExpression request parameter.Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews
aws.dynamodb.scanned_countDevelopmentRecommendedintThe value of the ScannedCount response parameter.50
aws.dynamodb.segmentDevelopmentRecommendedintThe value of the Segment request parameter.10
aws.dynamodb.selectDevelopmentRecommendedstringThe value of the Select request parameter.ALL_ATTRIBUTES; COUNT
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.dynamodb.total_segmentsDevelopmentRecommendedintThe value of the TotalSegments request parameter.100
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.UpdateItem

Status: Development

This span represents a DynamoDB.UpdateItem call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.item_collection_metricsDevelopmentRecommendedstringThe JSON-serialized value of the ItemCollectionMetrics response field.{ "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

DynamoDB.UpdateTable

Status: Development

This span represents a DynamoDB.UpdateTable call.

db.system.name MUST be set to "aws.dynamodb" and SHOULD be provided at span creation time.

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attributes:

KeyStabilityRequirement LevelValue TypeDescriptionExample Values
rpc.systemDevelopmentRequiredstringThe value aws-api.aws-api
aws.extended_request_idDevelopmentConditionally Required If available.stringThe AWS extended request ID as returned in the response header x-amz-id-2.wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=
aws.dynamodb.attribute_definitionsDevelopmentRecommendedstring[]The JSON-serialized value of each item in the AttributeDefinitions request field.["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]
aws.dynamodb.consumed_capacityDevelopmentRecommendedstring[]The JSON-serialized value of each item in the ConsumedCapacity response field.["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]
aws.dynamodb.global_secondary_index_updatesDevelopmentRecommendedstring[]The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field.["{ \"Create\": { \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"]
aws.dynamodb.provisioned_read_capacityDevelopmentRecommendeddoubleThe value of the ProvisionedThroughput.ReadCapacityUnits request parameter.1.0; 2.0
aws.dynamodb.provisioned_write_capacityDevelopmentRecommendeddoubleThe value of the ProvisionedThroughput.WriteCapacityUnits request parameter.1.0; 2.0
aws.dynamodb.table_namesDevelopmentRecommendedstring[]A single-element array with the value of the TableName request parameter.["Users"]
aws.request_idDevelopmentRecommendedstringThe AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ
cloud.regionDevelopmentRecommendedstringThe AWS Region where the requested service is being accessed. [1]us-east-1; us-west-2
rpc.methodDevelopmentRecommendedstringThe name of the operation corresponding to the request, as returned by the AWS SDKGetItem; PutItem
rpc.serviceDevelopmentRecommendedstringThe name of the service to which a request is made, as returned by the AWS SDK.DynamoDB; S3

[1] cloud.region: Specifies the AWS Region that the SDK client targets for a given AWS service call. The attribute’s value should adhere to the AWS Region codes outlined in the AWS documentation.


rpc.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

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

Metrics

AWS DynamoDB client instrumentations SHOULD collect metrics according to the general Semantic Conventions for Database Client Metrics.

db.system.name MUST be set to "aws.dynamodb".