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:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_names | Recommended | string[] | The keys in the RequestItems object field. | ["Users", "Cats"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.BatchWriteItem
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_metrics | Recommended | string | The 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_names | Recommended | string[] | The keys in the RequestItems object field. | ["Users", "Cats"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.CreateTable
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_indexes | Recommended | string[] | 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_metrics | Recommended | string | The 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_indexes | Recommended | string[] | 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_capacity | Recommended | double | The value of the ProvisionedThroughput.ReadCapacityUnits request parameter. | 1.0; 2.0 | |
aws.dynamodb.provisioned_write_capacity | Recommended | double | The value of the ProvisionedThroughput.WriteCapacityUnits request parameter. | 1.0; 2.0 | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.DeleteItem
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_metrics | Recommended | string | The 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_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.DeleteTable
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.DescribeTable
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.GetItem
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consistent_read | Recommended | boolean | The value of the ConsistentRead request parameter. | ||
aws.dynamodb.consumed_capacity | Recommended | string[] | 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.projection | Recommended | string | The value of the ProjectionExpression request parameter. | Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.ListTables
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.exclusive_start_table | Recommended | string | The value of the ExclusiveStartTableName request parameter. | Users; CatsTable | |
aws.dynamodb.limit | Recommended | int | The value of the Limit request parameter. | 10 | |
aws.dynamodb.table_count | Recommended | int | The number of items in the TableNames response parameter. | 20 | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.PutItem
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_metrics | Recommended | string | The 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_names | Recommended | string[] | The keys in the RequestItems object field. | ["Users", "Cats"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.Query
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.attributes_to_get | Recommended | string[] | The value of the AttributesToGet request parameter. | ["lives", "id"] | |
aws.dynamodb.consistent_read | Recommended | boolean | The value of the ConsistentRead request parameter. | ||
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_name | Recommended | string | The value of the IndexName request parameter. | name_to_group | |
aws.dynamodb.limit | Recommended | int | The value of the Limit request parameter. | 10 | |
aws.dynamodb.projection | Recommended | string | The value of the ProjectionExpression request parameter. | Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews | |
aws.dynamodb.scan_forward | Recommended | boolean | The value of the ScanIndexForward request parameter. | ||
aws.dynamodb.select | Recommended | string | The value of the Select request parameter. | ALL_ATTRIBUTES; COUNT | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.Scan
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.attributes_to_get | Recommended | string[] | The value of the AttributesToGet request parameter. | ["lives", "id"] | |
aws.dynamodb.consistent_read | Recommended | boolean | The value of the ConsistentRead request parameter. | ||
aws.dynamodb.consumed_capacity | Recommended | string[] | 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.count | Recommended | int | The value of the Count response parameter. | 10 | |
aws.dynamodb.index_name | Recommended | string | The value of the IndexName request parameter. | name_to_group | |
aws.dynamodb.limit | Recommended | int | The value of the Limit request parameter. | 10 | |
aws.dynamodb.projection | Recommended | string | The value of the ProjectionExpression request parameter. | Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews | |
aws.dynamodb.scanned_count | Recommended | int | The value of the ScannedCount response parameter. | 50 | |
aws.dynamodb.segment | Recommended | int | The value of the Segment request parameter. | 10 | |
aws.dynamodb.select | Recommended | string | The value of the Select request parameter. | ALL_ATTRIBUTES; COUNT | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.dynamodb.total_segments | Recommended | int | The value of the TotalSegments request parameter. | 100 | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.UpdateItem
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_metrics | Recommended | string | The 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_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
DynamoDB.UpdateTable
Status:
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:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
rpc.system | Required | string | The value aws-api. | aws-api | |
aws.extended_request_id | Conditionally Required If available. | string | The AWS extended request ID as returned in the response header x-amz-id-2. | wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= | |
aws.dynamodb.attribute_definitions | Recommended | string[] | The JSON-serialized value of each item in the AttributeDefinitions request field. | ["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"] | |
aws.dynamodb.consumed_capacity | Recommended | string[] | 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_updates | Recommended | string[] | 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_capacity | Recommended | double | The value of the ProvisionedThroughput.ReadCapacityUnits request parameter. | 1.0; 2.0 | |
aws.dynamodb.provisioned_write_capacity | Recommended | double | The value of the ProvisionedThroughput.WriteCapacityUnits request parameter. | 1.0; 2.0 | |
aws.dynamodb.table_names | Recommended | string[] | A single-element array with the value of the TableName request parameter. | ["Users"] | |
aws.request_id | Recommended | string | The 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.region | Recommended | string | The AWS Region where the requested service is being accessed. [1] | us-east-1; us-west-2 | |
rpc.method | Recommended | string | The name of the operation corresponding to the request, as returned by the AWS SDK | GetItem; PutItem | |
rpc.service | Recommended | string | The 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.
| 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) |
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".
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!