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

34 KiB
Raw Blame History

AWS

AWS Attributes

This document defines generic attributes for AWS services.

Attribute Type Description Examples Stability
aws.request_id string The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid. 79b9da39-b7ae-508a-a6bc-864b2829c622; C9ER4AJX75574TDJ Experimental

AWS DynamoDB Attributes

This document defines attributes for AWS DynamoDB.

Attribute Type Description Examples Stability
aws.dynamodb.attribute_definitions string[] The JSON-serialized value of each item in the AttributeDefinitions request field. ["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"] Experimental
aws.dynamodb.attributes_to_get string[] The value of the AttributesToGet request parameter. ["lives", "id"] Experimental
aws.dynamodb.consistent_read boolean The value of the ConsistentRead request parameter. Experimental
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 }"] Experimental
aws.dynamodb.count int The value of the Count response parameter. 10 Experimental
aws.dynamodb.exclusive_start_table string The value of the ExclusiveStartTableName request parameter. Users; CatsTable Experimental
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 } }"] Experimental
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 } }"] Experimental
aws.dynamodb.index_name string The value of the IndexName request parameter. name_to_group Experimental
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 ] } ] } Experimental
aws.dynamodb.limit int The value of the Limit request parameter. 10 Experimental
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\" } }"] Experimental
aws.dynamodb.projection string The value of the ProjectionExpression request parameter. Title; Title, Price, Color; Title, Description, RelatedItems, ProductReviews Experimental
aws.dynamodb.provisioned_read_capacity double The value of the ProvisionedThroughput.ReadCapacityUnits request parameter. 1.0; 2.0 Experimental
aws.dynamodb.provisioned_write_capacity double The value of the ProvisionedThroughput.WriteCapacityUnits request parameter. 1.0; 2.0 Experimental
aws.dynamodb.scan_forward boolean The value of the ScanIndexForward request parameter. Experimental
aws.dynamodb.scanned_count int The value of the ScannedCount response parameter. 50 Experimental
aws.dynamodb.segment int The value of the Segment request parameter. 10 Experimental
aws.dynamodb.select string The value of the Select request parameter. ALL_ATTRIBUTES; COUNT Experimental
aws.dynamodb.table_count int The number of items in the TableNames response parameter. 20 Experimental
aws.dynamodb.table_names string[] The keys in the RequestItems object field. ["Users", "Cats"] Experimental
aws.dynamodb.total_segments int The value of the TotalSegments request parameter. 100 Experimental

AWS ECS Attributes

This document defines attributes for AWS Elastic Container Service (ECS).

Attribute Type Description Examples Stability
aws.ecs.cluster.arn string The ARN of an ECS cluster. arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster Experimental
aws.ecs.container.arn string The Amazon Resource Name (ARN) of an ECS container instance. arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9 Experimental
aws.ecs.launchtype string The launch type for an ECS task. ec2; fargate Experimental
aws.ecs.task.arn string The ARN of a running ECS task. arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b; arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd Experimental
aws.ecs.task.family string The family name of the ECS task definition used to create the ECS task. opentelemetry-family Experimental
aws.ecs.task.id string The ID of a running ECS task. The ID MUST be extracted from task.arn. 10838bed-421f-43ef-870a-f43feacbbb5b; 23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd Experimental
aws.ecs.task.revision string The revision for the task definition used to create the ECS task. 8; 26 Experimental

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

Value Description Stability
ec2 ec2 Experimental
fargate fargate Experimental

AWS EKS Attributes

This document defines attributes for AWS Elastic Kubernetes Service (EKS).

Attribute Type Description Examples Stability
aws.eks.cluster.arn string The ARN of an EKS cluster. arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster Experimental

AWS Lambda Attributes

This document defines attributes for AWS Lambda.

Attribute Type Description Examples Stability
aws.lambda.invoked_arn string The full invoked ARN as provided on the Context passed to the function (Lambda-Runtime-Invoked-Function-Arn header on the /runtime/invocation/next applicable). [1] arn:aws:lambda:us-east-1:123456:function:myfunction:myalias Experimental

[1]: This may be different from cloud.resource_id if an alias is involved.

AWS Log Attributes

This document defines attributes for AWS Logs.

Attribute Type Description Examples Stability
aws.log.group.arns string[] The Amazon Resource Name(s) (ARN) of the AWS log group(s). [2] ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"] Experimental
aws.log.group.names string[] The name(s) of the AWS log group(s) an application is writing to. [3] ["/aws/lambda/my-function", "opentelemetry-service"] Experimental
aws.log.stream.arns string[] The ARN(s) of the AWS log stream(s). [4] ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"] Experimental
aws.log.stream.names string[] The name(s) of the AWS log stream(s) an application is writing to. ["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"] Experimental

[2]: See the log group ARN format documentation.

[3]: Multiple log groups must be supported for cases like multi-container applications, where a single application has sidecar containers, and each write to their own log group.

[4]: See the log stream ARN format documentation. One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.

AWS S3 Attributes

This document defines attributes for AWS S3.

Attribute Type Description Examples Stability
aws.s3.bucket string The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations. [5] some-bucket-name Experimental
aws.s3.copy_source string The source object (in the form bucket/key) for the copy operation. [6] someFile.yml Experimental
aws.s3.delete string The delete request container that specifies the objects to be deleted. [7] Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean Experimental
aws.s3.key string The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations. [8] someFile.yml Experimental
aws.s3.part_number int The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. [9] 3456 Experimental
aws.s3.upload_id string Upload ID that identifies the multipart upload. [10] dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ Experimental

[5]: The bucket attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. This applies to almost all S3 operations except list-buckets.

[6]: The copy_source attribute applies to S3 copy operations and corresponds to the --copy-source parameter of the copy-object operation within the S3 API. This applies in particular to the following operations:

[7]: The delete attribute is only applicable to the delete-object operation. The delete attribute corresponds to the --delete parameter of the delete-objects operation within the S3 API.

[8]: The key attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. This applies in particular to the following operations:

[9]: The part_number attribute is only applicable to the upload-part and upload-part-copy operations. The part_number attribute corresponds to the --part-number parameter of the upload-part operation within the S3 API.

[10]: The upload_id attribute applies to S3 multipart-upload operations and corresponds to the --upload-id parameter of the S3 API multipart operations. This applies in particular to the following operations: