semantic-conventions/docs/registry/entities/aws.md

6.5 KiB

AWS

AWS ECS

Status: Development

type: aws.ecs

Description: Entities used by AWS Elastic Container Service (ECS).

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
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 Conditionally Required If and only if task.arn is populated. Development
aws.ecs.cluster.arn string The ARN of an ECS cluster. arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster Recommended Development
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 Recommended Development
aws.ecs.launchtype string The launch type for an ECS task. ec2; fargate Recommended Development
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 Recommended Development
aws.ecs.task.family string The family name of the ECS task definition used to create the ECS task. opentelemetry-family Recommended Development
aws.ecs.task.revision string The revision for the task definition used to create the ECS task. 8; 26 Recommended Development

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 Development
fargate fargate Development

AWS EKS

Status: Development

type: aws.eks

Description: Entities used by AWS Elastic Kubernetes Service (EKS).

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

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

AWS Log

Status: Development

type: aws.log

Description: Entities specific to Amazon Web Services.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

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

[1] aws.log.group.arns: See the log group ARN format documentation.

[2] aws.log.group.names: 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.

[3] aws.log.stream.arns: 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.