open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/database/dynamodb.md

77 KiB
Raw Blame History

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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.table_names string[] The keys in the RequestItems object field. ["Users", "Cats"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.item_collection_metrics 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 ] } ] } Recommended Development
aws.dynamodb.table_names string[] The keys in the RequestItems object field. ["Users", "Cats"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.global_secondary_indexes 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 } }"] Recommended Development
aws.dynamodb.item_collection_metrics 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 ] } ] } Recommended Development
aws.dynamodb.local_secondary_indexes 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\" } }"] Recommended Development
aws.dynamodb.provisioned_read_capacity double The value of the ProvisionedThroughput.ReadCapacityUnits request parameter. 1.0; 2.0 Recommended Development
aws.dynamodb.provisioned_write_capacity double The value of the ProvisionedThroughput.WriteCapacityUnits request parameter. 1.0; 2.0 Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.item_collection_metrics 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 ] } ] } Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consistent_read boolean The value of the ConsistentRead request parameter. Recommended Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.projection string The value of the ProjectionExpression request parameter. Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.exclusive_start_table string The value of the ExclusiveStartTableName request parameter. Users; CatsTable Recommended Development
aws.dynamodb.limit int The value of the Limit request parameter. 10 Recommended Development
aws.dynamodb.table_count int The number of items in the TableNames response parameter. 20 Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.item_collection_metrics 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 ] } ] } Recommended Development
aws.dynamodb.table_names string[] The keys in the RequestItems object field. ["Users", "Cats"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.attributes_to_get string[] The value of the AttributesToGet request parameter. ["lives", "id"] Recommended Development
aws.dynamodb.consistent_read boolean The value of the ConsistentRead request parameter. Recommended Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.index_name string The value of the IndexName request parameter. name_to_group Recommended Development
aws.dynamodb.limit int The value of the Limit request parameter. 10 Recommended Development
aws.dynamodb.projection string The value of the ProjectionExpression request parameter. Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews Recommended Development
aws.dynamodb.scan_forward boolean The value of the ScanIndexForward request parameter. Recommended Development
aws.dynamodb.select string The value of the Select request parameter. ALL_ATTRIBUTES; COUNT Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.attributes_to_get string[] The value of the AttributesToGet request parameter. ["lives", "id"] Recommended Development
aws.dynamodb.consistent_read boolean The value of the ConsistentRead request parameter. Recommended Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.count int The value of the Count response parameter. 10 Recommended Development
aws.dynamodb.index_name string The value of the IndexName request parameter. name_to_group Recommended Development
aws.dynamodb.limit int The value of the Limit request parameter. 10 Recommended Development
aws.dynamodb.projection string The value of the ProjectionExpression request parameter. Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews Recommended Development
aws.dynamodb.scanned_count int The value of the ScannedCount response parameter. 50 Recommended Development
aws.dynamodb.segment int The value of the Segment request parameter. 10 Recommended Development
aws.dynamodb.select string The value of the Select request parameter. ALL_ATTRIBUTES; COUNT Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.dynamodb.total_segments int The value of the TotalSegments request parameter. 100 Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.item_collection_metrics 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 ] } ] } Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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.

Attribute Type Description Examples Requirement Level Stability
rpc.system string The value aws-api. aws-api Required Development
aws.extended_request_id string The AWS extended request ID as returned in the response header x-amz-id-2. wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= Conditionally Required If available. Development
aws.dynamodb.attribute_definitions string[] The JSON-serialized value of each item in the AttributeDefinitions request field. ["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"] Recommended Development
aws.dynamodb.consumed_capacity 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 }"] Recommended Development
aws.dynamodb.global_secondary_index_updates 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 } }"] Recommended Development
aws.dynamodb.provisioned_read_capacity double The value of the ProvisionedThroughput.ReadCapacityUnits request parameter. 1.0; 2.0 Recommended Development
aws.dynamodb.provisioned_write_capacity double The value of the ProvisionedThroughput.WriteCapacityUnits request parameter. 1.0; 2.0 Recommended Development
aws.dynamodb.table_names string[] A single-element array with the value of the TableName request parameter. ["Users"] Recommended Development
aws.request_id 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 Recommended Development
cloud.region string The AWS Region where the requested service is being accessed. [1] us-east-1; us-west-2 Recommended Development
rpc.method string The name of the operation corresponding to the request, as returned by the AWS SDK [2] GetItem; PutItem Recommended Development
rpc.service string The name of the service to which a request is made, as returned by the AWS SDK. [3] DynamoDB; S3 Recommended Development

[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.

[2] rpc.method: This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function.name attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).

[3] rpc.service: This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).

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 Development
connect_rpc Connect RPC Development
dotnet_wcf .NET WCF Development
grpc gRPC Development
java_rmi Java RMI 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".