From aace70acba61d94ac568e99cf6a43398255211bf Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Wed, 27 Mar 2024 17:33:06 +0100 Subject: [PATCH 1/5] Move Dynamodb attributes to the registry --- docs/attributes-registry/README.md | 1 + docs/attributes-registry/aws-dynamodb.md | 29 +++ docs/database/dynamodb.md | 114 +++++----- model/registry/aws-dynamodb.yaml | 242 ++++++++++++++++++++ model/trace/instrumentation/aws-sdk.yml | 271 ++--------------------- 5 files changed, 351 insertions(+), 306 deletions(-) create mode 100644 docs/attributes-registry/aws-dynamodb.md create mode 100644 model/registry/aws-dynamodb.yaml diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index 8b22577d09..a0aabe8b53 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -28,6 +28,7 @@ All registered attributes are listed by namespace in this registry. Currently, the following namespaces exist: * [Android](android.md) +* [AWS DynamoDB](aws-dynamodb.md) * [Browser](browser.md) * [Client](client.md) * [Cloud](cloud.md) diff --git a/docs/attributes-registry/aws-dynamodb.md b/docs/attributes-registry/aws-dynamodb.md new file mode 100644 index 0000000000..a734255f2e --- /dev/null +++ b/docs/attributes-registry/aws-dynamodb.md @@ -0,0 +1,29 @@ +# AWS DynamoDB + +## AWS DynamoDB Attributes + +| Attribute | Type | Description | Examples | +|---|---|---|---| +| `aws.dynamodb.attribute_definitions` | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `[{ "AttributeName": "string", "AttributeType": "string" }]` | +| `aws.dynamodb.attributes_to_get` | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | +| `aws.dynamodb.consistent_read` | boolean | The value of the `ConsistentRead` request parameter. | | +| `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 }]` | +| `aws.dynamodb.count` | int | The value of the `Count` response parameter. | `10` | +| `aws.dynamodb.exclusive_start_table` | string | The value of the `ExclusiveStartTableName` request parameter. | `Users`; `CatsTable` | +| `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 } }]` | +| `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 } }]` | +| `aws.dynamodb.index_name` | string | The value of the `IndexName` request parameter. | `name_to_group` | +| `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 ] } ] }` | +| `aws.dynamodb.limit` | int | The value of the `Limit` request parameter. | `10` | +| `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" } }]` | +| `aws.dynamodb.projection` | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | +| `aws.dynamodb.provisioned_read_capacity` | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | +| `aws.dynamodb.provisioned_write_capacity` | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | +| `aws.dynamodb.scan_forward` | boolean | The value of the `ScanIndexForward` request parameter. | | +| `aws.dynamodb.scanned_count` | int | The value of the `ScannedCount` response parameter. | `50` | +| `aws.dynamodb.segment` | int | The value of the `Segment` request parameter. | `10` | +| `aws.dynamodb.select` | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | +| `aws.dynamodb.table_count` | int | The number of items in the `TableNames` response parameter. | `20` | +| `aws.dynamodb.table_names` | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | +| `aws.dynamodb.total_segments` | int | The value of the `TotalSegments` request parameter. | `100` | + diff --git a/docs/database/dynamodb.md b/docs/database/dynamodb.md index 932f5e5fc0..10e374b95f 100644 --- a/docs/database/dynamodb.md +++ b/docs/database/dynamodb.md @@ -27,8 +27,8 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `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 | -| `aws.dynamodb.table_names` | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | ## DynamoDB.BatchWriteItem @@ -36,9 +36,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `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 | -| `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 | -| `aws.dynamodb.table_names` | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | ## DynamoDB.CreateTable @@ -46,13 +46,13 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `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 | -| `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 | -| `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 | -| `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 | -| `aws.dynamodb.provisioned_read_capacity` | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| `aws.dynamodb.provisioned_write_capacity` | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.global_secondary_indexes`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.local_secondary_indexes`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.provisioned_read_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.provisioned_write_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.DeleteItem @@ -60,9 +60,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `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 | -| `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 | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.DeleteTable @@ -70,7 +70,7 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.DescribeTable @@ -78,7 +78,7 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.GetItem @@ -86,10 +86,10 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.consistent_read` | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | -| `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 | -| `aws.dynamodb.projection` | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consistent_read`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.projection`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.ListTables @@ -97,9 +97,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.exclusive_start_table` | string | The value of the `ExclusiveStartTableName` request parameter. | `Users`; `CatsTable` | Recommended | -| `aws.dynamodb.limit` | int | The value of the `Limit` request parameter. | `10` | Recommended | -| `aws.dynamodb.table_count` | int | The number of items in the `TableNames` response parameter. | `20` | Recommended | +| [`aws.dynamodb.exclusive_start_table`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ExclusiveStartTableName` request parameter. | `Users`; `CatsTable` | Recommended | +| [`aws.dynamodb.limit`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | +| [`aws.dynamodb.table_count`](../attributes-registry/aws-dynamodb.md) | int | The number of items in the `TableNames` response parameter. | `20` | Recommended | ## DynamoDB.PutItem @@ -107,9 +107,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `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 | -| `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 | -| `aws.dynamodb.table_names` | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | ## DynamoDB.Query @@ -117,15 +117,15 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.attributes_to_get` | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | -| `aws.dynamodb.consistent_read` | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | -| `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 | -| `aws.dynamodb.index_name` | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | -| `aws.dynamodb.limit` | int | The value of the `Limit` request parameter. | `10` | Recommended | -| `aws.dynamodb.projection` | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | -| `aws.dynamodb.scan_forward` | boolean | The value of the `ScanIndexForward` request parameter. | | Recommended | -| `aws.dynamodb.select` | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.attributes_to_get`](../attributes-registry/aws-dynamodb.md) | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | +| [`aws.dynamodb.consistent_read`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.index_name`](../attributes-registry/aws-dynamodb.md) | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | +| [`aws.dynamodb.limit`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | +| [`aws.dynamodb.projection`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | +| [`aws.dynamodb.scan_forward`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ScanIndexForward` request parameter. | | Recommended | +| [`aws.dynamodb.select`](../attributes-registry/aws-dynamodb.md) | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.Scan @@ -133,18 +133,18 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.attributes_to_get` | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | -| `aws.dynamodb.consistent_read` | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | -| `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 | -| `aws.dynamodb.count` | int | The value of the `Count` response parameter. | `10` | Recommended | -| `aws.dynamodb.index_name` | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | -| `aws.dynamodb.limit` | int | The value of the `Limit` request parameter. | `10` | Recommended | -| `aws.dynamodb.projection` | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | -| `aws.dynamodb.scanned_count` | int | The value of the `ScannedCount` response parameter. | `50` | Recommended | -| `aws.dynamodb.segment` | int | The value of the `Segment` request parameter. | `10` | Recommended | -| `aws.dynamodb.select` | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | -| `aws.dynamodb.total_segments` | int | The value of the `TotalSegments` request parameter. | `100` | Recommended | +| [`aws.dynamodb.attributes_to_get`](../attributes-registry/aws-dynamodb.md) | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | +| [`aws.dynamodb.consistent_read`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.count`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Count` response parameter. | `10` | Recommended | +| [`aws.dynamodb.index_name`](../attributes-registry/aws-dynamodb.md) | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | +| [`aws.dynamodb.limit`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | +| [`aws.dynamodb.projection`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | +| [`aws.dynamodb.scanned_count`](../attributes-registry/aws-dynamodb.md) | int | The value of the `ScannedCount` response parameter. | `50` | Recommended | +| [`aws.dynamodb.segment`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Segment` request parameter. | `10` | Recommended | +| [`aws.dynamodb.select`](../attributes-registry/aws-dynamodb.md) | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.total_segments`](../attributes-registry/aws-dynamodb.md) | int | The value of the `TotalSegments` request parameter. | `100` | Recommended | ## DynamoDB.UpdateItem @@ -152,9 +152,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `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 | -| `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 | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.UpdateTable @@ -162,12 +162,12 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `aws.dynamodb.attribute_definitions` | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `[{ "AttributeName": "string", "AttributeType": "string" }]` | Recommended | -| `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 | -| `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 | -| `aws.dynamodb.provisioned_read_capacity` | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| `aws.dynamodb.provisioned_write_capacity` | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| `aws.dynamodb.table_names` | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.attribute_definitions`](../attributes-registry/aws-dynamodb.md) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `[{ "AttributeName": "string", "AttributeType": "string" }]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.global_secondary_index_updates`](../attributes-registry/aws-dynamodb.md) | 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 | +| [`aws.dynamodb.provisioned_read_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.provisioned_write_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md diff --git a/model/registry/aws-dynamodb.yaml b/model/registry/aws-dynamodb.yaml new file mode 100644 index 0000000000..c0c0686089 --- /dev/null +++ b/model/registry/aws-dynamodb.yaml @@ -0,0 +1,242 @@ +groups: + - id: registry.aws.dynamodb + prefix: aws.dynamodb + type: attribute_group + brief: > + This document defines attributes for AWS DynamoDB. + attributes: + - id: table_names + type: string[] + stability: experimental + brief: The keys in the `RequestItems` object field. + examples: + - Users + - Cats + - id: consumed_capacity + type: string[] + stability: experimental + brief: "The JSON-serialized value of each item in the `ConsumedCapacity` response field." + examples: + - '{ + "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 + }' + - id: item_collection_metrics + type: string + stability: experimental + brief: "The JSON-serialized value of the `ItemCollectionMetrics` response field." + examples: + - '{ + "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 ] + } + ] + }' + - id: provisioned_read_capacity + type: double + stability: experimental + brief: "The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter." + examples: + - 1.0 + - 2.0 + - id: provisioned_write_capacity + type: double + stability: experimental + brief: "The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter." + examples: + - 1.0 + - 2.0 + - id: consistent_read + type: boolean + stability: experimental + brief: "The value of the `ConsistentRead` request parameter." + - id: projection + type: string + stability: experimental + brief: "The value of the `ProjectionExpression` request parameter." + examples: + - Title + - Title, Price, Color + - Title, Description, RelatedItems, ProductReviews + - id: limit + type: int + stability: experimental + brief: "The value of the `Limit` request parameter." + examples: + - 10 + - id: attributes_to_get + type: string[] + stability: experimental + brief: "The value of the `AttributesToGet` request parameter." + examples: + - lives + - id + - id: index_name + type: string + stability: experimental + brief: "The value of the `IndexName` request parameter." + examples: + - name_to_group + - id: select + type: string + stability: experimental + brief: "The value of the `Select` request parameter." + examples: + - ALL_ATTRIBUTES + - COUNT + - id: global_secondary_indexes + type: string[] + stability: experimental + brief: "The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field" + examples: + - '{ + "IndexName": "string", + "KeySchema": [ + { + "AttributeName": "string", + "KeyType": "string" + } + ], + "Projection": { + "NonKeyAttributes": [ "string" ], + "ProjectionType": "string" + }, + "ProvisionedThroughput": { + "ReadCapacityUnits": number, + "WriteCapacityUnits": number + } + }' + - id: local_secondary_indexes + type: string[] + stability: experimental + brief: "The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field." + examples: + - '{ + "IndexArn": "string", + "IndexName": "string", + "IndexSizeBytes": number, + "ItemCount": number, + "KeySchema": [ + { + "AttributeName": "string", + "KeyType": "string" + } + ], + "Projection": { + "NonKeyAttributes": [ "string" ], + "ProjectionType": "string" + } + }' + - id: exclusive_start_table + type: string + stability: experimental + brief: "The value of the `ExclusiveStartTableName` request parameter." + examples: + - Users + - CatsTable + - id: table_count + type: int + stability: experimental + brief: "The number of items in the `TableNames` response parameter." + examples: + - 20 + - id: scan_forward + type: boolean + stability: experimental + brief: "The value of the `ScanIndexForward` request parameter." + - id: segment + type: int + stability: experimental + brief: "The value of the `Segment` request parameter." + examples: + - 10 + - id: total_segments + type: int + stability: experimental + brief: "The value of the `TotalSegments` request parameter." + examples: + - 100 + - id: count + type: int + stability: experimental + brief: "The value of the `Count` response parameter." + examples: + - 10 + - id: scanned_count + type: int + stability: experimental + brief: "The value of the `ScannedCount` response parameter." + examples: + - 50 + - id: attribute_definitions + type: string[] + stability: experimental + brief: "The JSON-serialized value of each item in the `AttributeDefinitions` request field." + examples: + - '{ + "AttributeName": "string", + "AttributeType": "string" + }' + - id: global_secondary_index_updates + type: string[] + stability: experimental + brief: "The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field." + examples: + - '{ + "Create": { + "IndexName": "string", + "KeySchema": [ + { + "AttributeName": "string", + "KeyType": "string" + } + ], + "Projection": { + "NonKeyAttributes": [ "string" ], + "ProjectionType": "string" + }, + "ProvisionedThroughput": { + "ReadCapacityUnits": number, + "WriteCapacityUnits": number + } + }' diff --git a/model/trace/instrumentation/aws-sdk.yml b/model/trace/instrumentation/aws-sdk.yml index 1817c66281..07927d1b92 100644 --- a/model/trace/instrumentation/aws-sdk.yml +++ b/model/trace/instrumentation/aws-sdk.yml @@ -46,7 +46,6 @@ groups: - id: dynamodb.shared extends: aws - prefix: aws.dynamodb type: span brief: "Attributes that exist for multiple DynamoDB request types." attributes: @@ -55,130 +54,21 @@ groups: examples: - GetItem - PutItem - - id: table_names - type: string[] - stability: experimental - brief: The keys in the `RequestItems` object field. - examples: - - Users - - Cats - - id: consumed_capacity - type: string[] - stability: experimental - brief: "The JSON-serialized value of each item in the `ConsumedCapacity` response field." - examples: - - '{ - "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 - }' - - id: item_collection_metrics - type: string - stability: experimental - brief: "The JSON-serialized value of the `ItemCollectionMetrics` response field." - examples: - - '{ - "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 ] - } - ] - }' - - id: provisioned_read_capacity - type: double - stability: experimental - brief: "The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter." - examples: - - 1.0 - - 2.0 - - id: provisioned_write_capacity - type: double - stability: experimental - brief: "The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter." - examples: - - 1.0 - - 2.0 - - id: consistent_read - type: boolean - stability: experimental - brief: "The value of the `ConsistentRead` request parameter." - - id: projection - type: string - stability: experimental - brief: "The value of the `ProjectionExpression` request parameter." - examples: - - Title - - Title, Price, Color - - Title, Description, RelatedItems, ProductReviews - - id: limit - type: int - stability: experimental - brief: "The value of the `Limit` request parameter." - examples: - - 10 - - id: attributes_to_get - type: string[] - stability: experimental - brief: "The value of the `AttributesToGet` request parameter." - examples: - - lives - - id - - id: index_name - type: string - stability: experimental - brief: "The value of the `IndexName` request parameter." - examples: - - name_to_group - - id: select - type: string - stability: experimental - brief: "The value of the `Select` request parameter." - examples: - - ALL_ATTRIBUTES - - COUNT + - ref: aws.dynamodb.table_names + - ref: aws.dynamodb.consumed_capacity + - ref: aws.dynamodb.item_collection_metrics + - ref: aws.dynamodb.provisioned_read_capacity + - ref: aws.dynamodb.provisioned_write_capacity + - ref: aws.dynamodb.consistent_read + - ref: aws.dynamodb.projection + - ref: aws.dynamodb.limit + - ref: aws.dynamodb.attributes_to_get + - ref: aws.dynamodb.index_name + - ref: aws.dynamodb.select - id: dynamodb.batchgetitem brief: DynamoDB.BatchGetItem extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -187,7 +77,6 @@ groups: - id: dynamodb.batchwriteitem brief: DynamoDB.BatchWriteItem extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -197,52 +86,10 @@ groups: - id: dynamodb.createtable brief: DynamoDB.CreateTable extends: aws - prefix: aws.dynamodb type: span attributes: - - id: global_secondary_indexes - type: string[] - stability: experimental - brief: "The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field" - examples: - - '{ - "IndexName": "string", - "KeySchema": [ - { - "AttributeName": "string", - "KeyType": "string" - } - ], - "Projection": { - "NonKeyAttributes": [ "string" ], - "ProjectionType": "string" - }, - "ProvisionedThroughput": { - "ReadCapacityUnits": number, - "WriteCapacityUnits": number - } - }' - - id: local_secondary_indexes - type: string[] - stability: experimental - brief: "The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field." - examples: - - '{ - "IndexArn": "string", - "IndexName": "string", - "IndexSizeBytes": number, - "ItemCount": number, - "KeySchema": [ - { - "AttributeName": "string", - "KeyType": "string" - } - ], - "Projection": { - "NonKeyAttributes": [ "string" ], - "ProjectionType": "string" - } - }' + - ref: aws.dynamodb.global_secondary_indexes + - ref: aws.dynamodb.local_secondary_indexes - ref: aws.dynamodb.table_names brief: "A single-element array with the value of the TableName request parameter." examples: @@ -255,7 +102,6 @@ groups: - id: dynamodb.deleteitem brief: DynamoDB.DeleteItem extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -268,7 +114,6 @@ groups: - id: dynamodb.deletetable brief: DynamoDB.DeleteTable extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -279,7 +124,6 @@ groups: - id: dynamodb.describetable brief: DynamoDB.DescribeTable extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -290,7 +134,6 @@ groups: - id: dynamodb.getitem brief: DynamoDB.GetItem extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -304,28 +147,15 @@ groups: - id: dynamodb.listtables brief: DynamoDB.ListTables extends: aws - prefix: aws.dynamodb type: span attributes: - - id: exclusive_start_table - type: string - stability: experimental - brief: "The value of the `ExclusiveStartTableName` request parameter." - examples: - - Users - - CatsTable - - id: table_count - type: int - stability: experimental - brief: "The number of items in the `TableNames` response parameter." - examples: - - 20 + - ref: aws.dynamodb.exclusive_start_table + - ref: aws.dynamodb.table_count - ref: aws.dynamodb.limit - id: dynamodb.putitem brief: DynamoDB.PutItem extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -335,13 +165,9 @@ groups: - id: dynamodb.query brief: DynamoDB.Query extends: aws - prefix: aws.dynamodb type: span attributes: - - id: scan_forward - type: boolean - stability: experimental - brief: "The value of the `ScanIndexForward` request parameter." + - ref: aws.dynamodb.scan_forward - ref: aws.dynamodb.table_names brief: "A single-element array with the value of the TableName request parameter." examples: @@ -357,33 +183,12 @@ groups: - id: dynamodb.scan brief: DynamoDB.Scan extends: aws - prefix: aws.dynamodb type: span attributes: - - id: segment - type: int - stability: experimental - brief: "The value of the `Segment` request parameter." - examples: - - 10 - - id: total_segments - type: int - stability: experimental - brief: "The value of the `TotalSegments` request parameter." - examples: - - 100 - - id: count - type: int - stability: experimental - brief: "The value of the `Count` response parameter." - examples: - - 10 - - id: scanned_count - type: int - stability: experimental - brief: "The value of the `ScannedCount` response parameter." - examples: - - 50 + - ref: aws.dynamodb.segment + - ref: aws.dynamodb.total_segments + - ref: aws.dynamodb.count + - ref: aws.dynamodb.scanned_count - ref: aws.dynamodb.table_names brief: "A single-element array with the value of the TableName request parameter." examples: @@ -399,7 +204,6 @@ groups: - id: dynamodb.updateitem brief: DynamoDB.UpdateItem extends: aws - prefix: aws.dynamodb type: span attributes: - ref: aws.dynamodb.table_names @@ -412,41 +216,10 @@ groups: - id: dynamodb.updatetable brief: DynamoDB.UpdateTable extends: aws - prefix: aws.dynamodb type: span attributes: - - id: attribute_definitions - type: string[] - stability: experimental - brief: "The JSON-serialized value of each item in the `AttributeDefinitions` request field." - examples: - - '{ - "AttributeName": "string", - "AttributeType": "string" - }' - - id: global_secondary_index_updates - type: string[] - stability: experimental - brief: "The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field." - examples: - - '{ - "Create": { - "IndexName": "string", - "KeySchema": [ - { - "AttributeName": "string", - "KeyType": "string" - } - ], - "Projection": { - "NonKeyAttributes": [ "string" ], - "ProjectionType": "string" - }, - "ProvisionedThroughput": { - "ReadCapacityUnits": number, - "WriteCapacityUnits": number - } - }' + - ref: aws.dynamodb.attribute_definitions + - ref: aws.dynamodb.global_secondary_index_updates - ref: aws.dynamodb.table_names brief: "A single-element array with the value of the TableName request parameter." examples: From 69b5436c0b2eda0ca1d43aab112ada24c79b57e8 Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Wed, 27 Mar 2024 17:33:21 +0100 Subject: [PATCH 2/5] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/change_proposal.yaml | 1 + .github/ISSUE_TEMPLATE/new-conventions.yaml | 1 + 3 files changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index c363fa1bfd..4a08c03f7c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -20,6 +20,7 @@ body: # DO NOT manually edit it. # Start semconv area list - area:android + - area:aws-dynamodb - area:browser - area:client - area:cloud diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index a14603adf1..57f74b21c8 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -13,6 +13,7 @@ body: # DO NOT manually edit it. # Start semconv area list - area:android + - area:aws-dynamodb - area:browser - area:client - area:cloud diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index 161b9c7eeb..971b7bc0ba 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -22,6 +22,7 @@ body: # DO NOT manually edit it. # Start semconv area list - area:android + - area:aws-dynamodb - area:browser - area:client - area:cloud From 5cdeacdfba95dbcfcbdba8f6680697fbecd116fe Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:51:29 +0200 Subject: [PATCH 3/5] Move everything to aws --- docs/attributes-registry/README.md | 2 +- .../{aws-dynamodb.md => aws.md} | 10 +- docs/database/dynamodb.md | 114 +++++++++--------- .../registry/{aws-dynamodb.yaml => aws.yaml} | 0 4 files changed, 66 insertions(+), 60 deletions(-) rename docs/attributes-registry/{aws-dynamodb.md => aws.md} (97%) rename model/registry/{aws-dynamodb.yaml => aws.yaml} (100%) diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index a0aabe8b53..7f0c5ea3ce 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -28,7 +28,7 @@ All registered attributes are listed by namespace in this registry. Currently, the following namespaces exist: * [Android](android.md) -* [AWS DynamoDB](aws-dynamodb.md) +* [AWS](aws.md) * [Browser](browser.md) * [Client](client.md) * [Cloud](cloud.md) diff --git a/docs/attributes-registry/aws-dynamodb.md b/docs/attributes-registry/aws.md similarity index 97% rename from docs/attributes-registry/aws-dynamodb.md rename to docs/attributes-registry/aws.md index a734255f2e..841662ed6d 100644 --- a/docs/attributes-registry/aws-dynamodb.md +++ b/docs/attributes-registry/aws.md @@ -1,4 +1,10 @@ -# AWS DynamoDB +# AWS + + + +- [AWS DynamoDB Attributes](#aws-dynamodb-attributes) + + ## AWS DynamoDB Attributes @@ -26,4 +32,4 @@ | `aws.dynamodb.table_count` | int | The number of items in the `TableNames` response parameter. | `20` | | `aws.dynamodb.table_names` | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | | `aws.dynamodb.total_segments` | int | The value of the `TotalSegments` request parameter. | `100` | - + \ No newline at end of file diff --git a/docs/database/dynamodb.md b/docs/database/dynamodb.md index 10e374b95f..5bd41170e2 100644 --- a/docs/database/dynamodb.md +++ b/docs/database/dynamodb.md @@ -27,8 +27,8 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | ## DynamoDB.BatchWriteItem @@ -36,9 +36,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | ## DynamoDB.CreateTable @@ -46,13 +46,13 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.global_secondary_indexes`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.local_secondary_indexes`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.provisioned_read_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| [`aws.dynamodb.provisioned_write_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.global_secondary_indexes`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.local_secondary_indexes`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.provisioned_read_capacity`](../attributes-registry/aws.md) | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.provisioned_write_capacity`](../attributes-registry/aws.md) | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.DeleteItem @@ -60,9 +60,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.DeleteTable @@ -70,7 +70,7 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.DescribeTable @@ -78,7 +78,7 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.GetItem @@ -86,10 +86,10 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consistent_read`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.projection`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consistent_read`](../attributes-registry/aws.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.projection`](../attributes-registry/aws.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.ListTables @@ -97,9 +97,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.exclusive_start_table`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ExclusiveStartTableName` request parameter. | `Users`; `CatsTable` | Recommended | -| [`aws.dynamodb.limit`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | -| [`aws.dynamodb.table_count`](../attributes-registry/aws-dynamodb.md) | int | The number of items in the `TableNames` response parameter. | `20` | Recommended | +| [`aws.dynamodb.exclusive_start_table`](../attributes-registry/aws.md) | string | The value of the `ExclusiveStartTableName` request parameter. | `Users`; `CatsTable` | Recommended | +| [`aws.dynamodb.limit`](../attributes-registry/aws.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | +| [`aws.dynamodb.table_count`](../attributes-registry/aws.md) | int | The number of items in the `TableNames` response parameter. | `20` | Recommended | ## DynamoDB.PutItem @@ -107,9 +107,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | The keys in the `RequestItems` object field. | `[Users, Cats]` | Recommended | ## DynamoDB.Query @@ -117,15 +117,15 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.attributes_to_get`](../attributes-registry/aws-dynamodb.md) | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | -| [`aws.dynamodb.consistent_read`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.index_name`](../attributes-registry/aws-dynamodb.md) | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | -| [`aws.dynamodb.limit`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | -| [`aws.dynamodb.projection`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | -| [`aws.dynamodb.scan_forward`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ScanIndexForward` request parameter. | | Recommended | -| [`aws.dynamodb.select`](../attributes-registry/aws-dynamodb.md) | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.attributes_to_get`](../attributes-registry/aws.md) | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | +| [`aws.dynamodb.consistent_read`](../attributes-registry/aws.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.index_name`](../attributes-registry/aws.md) | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | +| [`aws.dynamodb.limit`](../attributes-registry/aws.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | +| [`aws.dynamodb.projection`](../attributes-registry/aws.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | +| [`aws.dynamodb.scan_forward`](../attributes-registry/aws.md) | boolean | The value of the `ScanIndexForward` request parameter. | | Recommended | +| [`aws.dynamodb.select`](../attributes-registry/aws.md) | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.Scan @@ -133,18 +133,18 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.attributes_to_get`](../attributes-registry/aws-dynamodb.md) | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | -| [`aws.dynamodb.consistent_read`](../attributes-registry/aws-dynamodb.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.count`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Count` response parameter. | `10` | Recommended | -| [`aws.dynamodb.index_name`](../attributes-registry/aws-dynamodb.md) | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | -| [`aws.dynamodb.limit`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | -| [`aws.dynamodb.projection`](../attributes-registry/aws-dynamodb.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | -| [`aws.dynamodb.scanned_count`](../attributes-registry/aws-dynamodb.md) | int | The value of the `ScannedCount` response parameter. | `50` | Recommended | -| [`aws.dynamodb.segment`](../attributes-registry/aws-dynamodb.md) | int | The value of the `Segment` request parameter. | `10` | Recommended | -| [`aws.dynamodb.select`](../attributes-registry/aws-dynamodb.md) | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | -| [`aws.dynamodb.total_segments`](../attributes-registry/aws-dynamodb.md) | int | The value of the `TotalSegments` request parameter. | `100` | Recommended | +| [`aws.dynamodb.attributes_to_get`](../attributes-registry/aws.md) | string[] | The value of the `AttributesToGet` request parameter. | `[lives, id]` | Recommended | +| [`aws.dynamodb.consistent_read`](../attributes-registry/aws.md) | boolean | The value of the `ConsistentRead` request parameter. | | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.count`](../attributes-registry/aws.md) | int | The value of the `Count` response parameter. | `10` | Recommended | +| [`aws.dynamodb.index_name`](../attributes-registry/aws.md) | string | The value of the `IndexName` request parameter. | `name_to_group` | Recommended | +| [`aws.dynamodb.limit`](../attributes-registry/aws.md) | int | The value of the `Limit` request parameter. | `10` | Recommended | +| [`aws.dynamodb.projection`](../attributes-registry/aws.md) | string | The value of the `ProjectionExpression` request parameter. | `Title`; `Title, Price, Color`; `Title, Description, RelatedItems, ProductReviews` | Recommended | +| [`aws.dynamodb.scanned_count`](../attributes-registry/aws.md) | int | The value of the `ScannedCount` response parameter. | `50` | Recommended | +| [`aws.dynamodb.segment`](../attributes-registry/aws.md) | int | The value of the `Segment` request parameter. | `10` | Recommended | +| [`aws.dynamodb.select`](../attributes-registry/aws.md) | string | The value of the `Select` request parameter. | `ALL_ATTRIBUTES`; `COUNT` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.total_segments`](../attributes-registry/aws.md) | int | The value of the `TotalSegments` request parameter. | `100` | Recommended | ## DynamoDB.UpdateItem @@ -152,9 +152,9 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.item_collection_metrics`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | ## DynamoDB.UpdateTable @@ -162,12 +162,12 @@ These attributes are filled in for all DynamoDB request types. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`aws.dynamodb.attribute_definitions`](../attributes-registry/aws-dynamodb.md) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `[{ "AttributeName": "string", "AttributeType": "string" }]` | Recommended | -| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.global_secondary_index_updates`](../attributes-registry/aws-dynamodb.md) | 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 | -| [`aws.dynamodb.provisioned_read_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| [`aws.dynamodb.provisioned_write_capacity`](../attributes-registry/aws-dynamodb.md) | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | -| [`aws.dynamodb.table_names`](../attributes-registry/aws-dynamodb.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | +| [`aws.dynamodb.attribute_definitions`](../attributes-registry/aws.md) | string[] | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | `[{ "AttributeName": "string", "AttributeType": "string" }]` | Recommended | +| [`aws.dynamodb.consumed_capacity`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.global_secondary_index_updates`](../attributes-registry/aws.md) | 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 | +| [`aws.dynamodb.provisioned_read_capacity`](../attributes-registry/aws.md) | double | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.provisioned_write_capacity`](../attributes-registry/aws.md) | double | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | `1.0`; `2.0` | Recommended | +| [`aws.dynamodb.table_names`](../attributes-registry/aws.md) | string[] | A single-element array with the value of the TableName request parameter. | `[Users]` | Recommended | [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md diff --git a/model/registry/aws-dynamodb.yaml b/model/registry/aws.yaml similarity index 100% rename from model/registry/aws-dynamodb.yaml rename to model/registry/aws.yaml From b20683c7148a8a5b4806272155451996749745c1 Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:55:25 +0200 Subject: [PATCH 4/5] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/change_proposal.yaml | 2 +- .github/ISSUE_TEMPLATE/new-conventions.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index e74372a21c..c000e27b9b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -20,7 +20,7 @@ body: # DO NOT manually edit it. # Start semconv area list - area:android - - area:aws-dynamodb + - area:aws - area:browser - area:client - area:cloud diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index 37bb690645..0047654c5b 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -13,7 +13,7 @@ body: # DO NOT manually edit it. # Start semconv area list - area:android - - area:aws-dynamodb + - area:aws - area:browser - area:client - area:cloud diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index 1e0c8d7d32..fa40eee8c9 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -22,7 +22,7 @@ body: # DO NOT manually edit it. # Start semconv area list - area:android - - area:aws-dynamodb + - area:aws - area:browser - area:client - area:cloud From 0485f8858f3831b21e972af15fec20c9d6e81330 Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Wed, 3 Apr 2024 10:00:06 +0200 Subject: [PATCH 5/5] Add requirement level to all dynamodb attributes --- model/trace/instrumentation/aws-sdk.yml | 68 +++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/model/trace/instrumentation/aws-sdk.yml b/model/trace/instrumentation/aws-sdk.yml index 07927d1b92..6b6f541544 100644 --- a/model/trace/instrumentation/aws-sdk.yml +++ b/model/trace/instrumentation/aws-sdk.yml @@ -55,16 +55,27 @@ groups: - GetItem - PutItem - ref: aws.dynamodb.table_names + requirement_level: recommended - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.item_collection_metrics + requirement_level: recommended - ref: aws.dynamodb.provisioned_read_capacity + requirement_level: recommended - ref: aws.dynamodb.provisioned_write_capacity + requirement_level: recommended - ref: aws.dynamodb.consistent_read + requirement_level: recommended - ref: aws.dynamodb.projection + requirement_level: recommended - ref: aws.dynamodb.limit + requirement_level: recommended - ref: aws.dynamodb.attributes_to_get + requirement_level: recommended - ref: aws.dynamodb.index_name + requirement_level: recommended - ref: aws.dynamodb.select + requirement_level: recommended - id: dynamodb.batchgetitem brief: DynamoDB.BatchGetItem @@ -72,7 +83,9 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - id: dynamodb.batchwriteitem brief: DynamoDB.BatchWriteItem @@ -80,8 +93,11 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.item_collection_metrics + requirement_level: recommended - id: dynamodb.createtable brief: DynamoDB.CreateTable @@ -89,15 +105,22 @@ groups: type: span attributes: - ref: aws.dynamodb.global_secondary_indexes + requirement_level: recommended - ref: aws.dynamodb.local_secondary_indexes + requirement_level: recommended - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.item_collection_metrics + requirement_level: recommended - ref: aws.dynamodb.provisioned_read_capacity + requirement_level: recommended - ref: aws.dynamodb.provisioned_write_capacity + requirement_level: recommended - id: dynamodb.deleteitem brief: DynamoDB.DeleteItem @@ -105,11 +128,14 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.item_collection_metrics + requirement_level: recommended - id: dynamodb.deletetable brief: DynamoDB.DeleteTable @@ -117,6 +143,7 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users @@ -127,6 +154,7 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users @@ -137,12 +165,16 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.consistent_read + requirement_level: recommended - ref: aws.dynamodb.projection + requirement_level: recommended - id: dynamodb.listtables brief: DynamoDB.ListTables @@ -150,8 +182,11 @@ groups: type: span attributes: - ref: aws.dynamodb.exclusive_start_table + requirement_level: recommended - ref: aws.dynamodb.table_count + requirement_level: recommended - ref: aws.dynamodb.limit + requirement_level: recommended - id: dynamodb.putitem brief: DynamoDB.PutItem @@ -159,8 +194,11 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.item_collection_metrics + requirement_level: recommended - id: dynamodb.query brief: DynamoDB.Query @@ -168,17 +206,26 @@ groups: type: span attributes: - ref: aws.dynamodb.scan_forward + requirement_level: recommended - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.consistent_read + requirement_level: recommended - ref: aws.dynamodb.limit + requirement_level: recommended - ref: aws.dynamodb.projection + requirement_level: recommended - ref: aws.dynamodb.attributes_to_get + requirement_level: recommended - ref: aws.dynamodb.index_name + requirement_level: recommended - ref: aws.dynamodb.select + requirement_level: recommended - id: dynamodb.scan brief: DynamoDB.Scan @@ -186,20 +233,32 @@ groups: type: span attributes: - ref: aws.dynamodb.segment + requirement_level: recommended - ref: aws.dynamodb.total_segments + requirement_level: recommended - ref: aws.dynamodb.count + requirement_level: recommended - ref: aws.dynamodb.scanned_count + requirement_level: recommended - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.consistent_read + requirement_level: recommended - ref: aws.dynamodb.limit + requirement_level: recommended - ref: aws.dynamodb.projection + requirement_level: recommended - ref: aws.dynamodb.attributes_to_get + requirement_level: recommended - ref: aws.dynamodb.index_name + requirement_level: recommended - ref: aws.dynamodb.select + requirement_level: recommended - id: dynamodb.updateitem brief: DynamoDB.UpdateItem @@ -207,11 +266,14 @@ groups: type: span attributes: - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.item_collection_metrics + requirement_level: recommended - id: dynamodb.updatetable brief: DynamoDB.UpdateTable @@ -219,14 +281,20 @@ groups: type: span attributes: - ref: aws.dynamodb.attribute_definitions + requirement_level: recommended - ref: aws.dynamodb.global_secondary_index_updates + requirement_level: recommended - ref: aws.dynamodb.table_names + requirement_level: recommended brief: "A single-element array with the value of the TableName request parameter." examples: - Users - ref: aws.dynamodb.consumed_capacity + requirement_level: recommended - ref: aws.dynamodb.provisioned_read_capacity + requirement_level: recommended - ref: aws.dynamodb.provisioned_write_capacity + requirement_level: recommended - id: aws.s3 extends: aws