View Source OpenTelemetry.SemConv.Incubating.AWSAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for AWS attributes.

Summary

Functions

The JSON-serialized value of each item in the AttributeDefinitions request field.

The value of the AttributesToGet request parameter.

The value of the ConsistentRead request parameter.

The JSON-serialized value of each item in the ConsumedCapacity response field.

The value of the Count response parameter.

The value of the ExclusiveStartTableName request parameter.

The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field.

The JSON-serialized value of each item of the GlobalSecondaryIndexes request field

The value of the IndexName request parameter.

The JSON-serialized value of the ItemCollectionMetrics response field.

The value of the Limit request parameter.

The JSON-serialized value of each item of the LocalSecondaryIndexes request field.

The value of the ProjectionExpression request parameter.

The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.

The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.

The value of the ScanIndexForward request parameter.

The value of the ScannedCount response parameter.

The value of the Segment request parameter.

The value of the Select request parameter.

The number of items in the TableNames response parameter.

The keys in the RequestItems object field.

The value of the TotalSegments request parameter.

The Amazon Resource Name (ARN) of an ECS container instance.

The launch type for an ECS task.

The ARN of a running ECS task.

The family name of the ECS task definition used to create the ECS task.

The ID of a running ECS task. The ID MUST be extracted from task.arn.

The revision for the task definition used to create the ECS task.

The ARN of an EKS cluster.

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

The Amazon Resource Name(s) (ARN) of the AWS log group(s).

The name(s) of the AWS log group(s) an application is writing to.

The ARN(s) of the AWS log stream(s).

The name(s) of the AWS log stream(s) an application is writing to.

The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid.

The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations.

The source object (in the form bucket/key) for the copy operation.

The delete request container that specifies the objects to be deleted.

The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.

The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000.

Upload ID that identifies the multipart upload.

Types

Link to this type

aws_ecs_launchtype_values()

View Source
@type aws_ecs_launchtype_values() :: %{ec2: :ec2, fargate: :fargate}

The launch type for an ECS task.

Enum Values

  • :ec2 e
  • :fargate e

Functions

Link to this function

aws_dynamodb_attribute_definitions()

View Source
@spec aws_dynamodb_attribute_definitions() :: :"aws.dynamodb.attribute_definitions"

The JSON-serialized value of each item in the AttributeDefinitions request field.

Value type

Value must be of type [atom() | String.t()].

Examples

["{ "AttributeName": "string", "AttributeType": "string" }"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_attribute_definitions()
:"aws.dynamodb.attribute_definitions"
Link to this function

aws_dynamodb_attributes_to_get()

View Source
@spec aws_dynamodb_attributes_to_get() :: :"aws.dynamodb.attributes_to_get"

The value of the AttributesToGet request parameter.

Value type

Value must be of type [atom() | String.t()].

Examples

["lives", "id"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_attributes_to_get()
:"aws.dynamodb.attributes_to_get"
Link to this function

aws_dynamodb_consistent_read()

View Source
@spec aws_dynamodb_consistent_read() :: :"aws.dynamodb.consistent_read"

The value of the ConsistentRead request parameter.

Value type

Value must be of type boolean().

iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_consistent_read()
:"aws.dynamodb.consistent_read"
Link to this function

aws_dynamodb_consumed_capacity()

View Source
@spec aws_dynamodb_consumed_capacity() :: :"aws.dynamodb.consumed_capacity"

The JSON-serialized value of each item in the ConsumedCapacity response field.

Value type

Value must be of type [atom() | String.t()].

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 }"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_consumed_capacity()
:"aws.dynamodb.consumed_capacity"
@spec aws_dynamodb_count() :: :"aws.dynamodb.count"

The value of the Count response parameter.

Value type

Value must be of type integer().

Examples

[10]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_count()
:"aws.dynamodb.count"
Link to this function

aws_dynamodb_exclusive_start_table()

View Source
@spec aws_dynamodb_exclusive_start_table() :: :"aws.dynamodb.exclusive_start_table"

The value of the ExclusiveStartTableName request parameter.

Value type

Value must be of type atom() | String.t().

Examples

["Users", "CatsTable"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_exclusive_start_table()
:"aws.dynamodb.exclusive_start_table"
Link to this function

aws_dynamodb_global_secondary_index_updates()

View Source
@spec aws_dynamodb_global_secondary_index_updates() ::
  :"aws.dynamodb.global_secondary_index_updates"

The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field.

Value type

Value must be of type [atom() | String.t()].

Examples

["{ "Create": { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } }"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_global_secondary_index_updates()
:"aws.dynamodb.global_secondary_index_updates"
Link to this function

aws_dynamodb_global_secondary_indexes()

View Source
@spec aws_dynamodb_global_secondary_indexes() ::
  :"aws.dynamodb.global_secondary_indexes"

The JSON-serialized value of each item of the GlobalSecondaryIndexes request field

Value type

Value must be of type [atom() | String.t()].

Examples

["{ "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } }"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_global_secondary_indexes()
:"aws.dynamodb.global_secondary_indexes"
Link to this function

aws_dynamodb_index_name()

View Source
@spec aws_dynamodb_index_name() :: :"aws.dynamodb.index_name"

The value of the IndexName request parameter.

Value type

Value must be of type atom() | String.t().

Examples

["name_to_group"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_index_name()
:"aws.dynamodb.index_name"
Link to this function

aws_dynamodb_item_collection_metrics()

View Source
@spec aws_dynamodb_item_collection_metrics() ::
  :"aws.dynamodb.item_collection_metrics"

The JSON-serialized value of the ItemCollectionMetrics response field.

Value type

Value must be of type atom() | String.t().

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 ] } ] }"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_item_collection_metrics()
:"aws.dynamodb.item_collection_metrics"
@spec aws_dynamodb_limit() :: :"aws.dynamodb.limit"

The value of the Limit request parameter.

Value type

Value must be of type integer().

Examples

[10]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_limit()
:"aws.dynamodb.limit"
Link to this function

aws_dynamodb_local_secondary_indexes()

View Source
@spec aws_dynamodb_local_secondary_indexes() ::
  :"aws.dynamodb.local_secondary_indexes"

The JSON-serialized value of each item of the LocalSecondaryIndexes request field.

Value type

Value must be of type [atom() | String.t()].

Examples

["{ "IndexArn": "string", "IndexName": "string", "IndexSizeBytes": number, "ItemCount": number, "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" } }"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_local_secondary_indexes()
:"aws.dynamodb.local_secondary_indexes"
Link to this function

aws_dynamodb_projection()

View Source
@spec aws_dynamodb_projection() :: :"aws.dynamodb.projection"

The value of the ProjectionExpression request parameter.

Value type

Value must be of type atom() | String.t().

Examples

["Title", "Title, Price, Color", "Title, Description, RelatedItems, ProductReviews"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_projection()
:"aws.dynamodb.projection"
Link to this function

aws_dynamodb_provisioned_read_capacity()

View Source
@spec aws_dynamodb_provisioned_read_capacity() ::
  :"aws.dynamodb.provisioned_read_capacity"

The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.

Value type

Value must be of type float().

Examples

[1.0, 2.0]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_provisioned_read_capacity()
:"aws.dynamodb.provisioned_read_capacity"
Link to this function

aws_dynamodb_provisioned_write_capacity()

View Source
@spec aws_dynamodb_provisioned_write_capacity() ::
  :"aws.dynamodb.provisioned_write_capacity"

The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.

Value type

Value must be of type float().

Examples

[1.0, 2.0]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_provisioned_write_capacity()
:"aws.dynamodb.provisioned_write_capacity"
Link to this function

aws_dynamodb_scan_forward()

View Source
@spec aws_dynamodb_scan_forward() :: :"aws.dynamodb.scan_forward"

The value of the ScanIndexForward request parameter.

Value type

Value must be of type boolean().

iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_scan_forward()
:"aws.dynamodb.scan_forward"
Link to this function

aws_dynamodb_scanned_count()

View Source
@spec aws_dynamodb_scanned_count() :: :"aws.dynamodb.scanned_count"

The value of the ScannedCount response parameter.

Value type

Value must be of type integer().

Examples

[50]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_scanned_count()
:"aws.dynamodb.scanned_count"
@spec aws_dynamodb_segment() :: :"aws.dynamodb.segment"

The value of the Segment request parameter.

Value type

Value must be of type integer().

Examples

[10]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_segment()
:"aws.dynamodb.segment"
@spec aws_dynamodb_select() :: :"aws.dynamodb.select"

The value of the Select request parameter.

Value type

Value must be of type atom() | String.t().

Examples

["ALL_ATTRIBUTES", "COUNT"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_select()
:"aws.dynamodb.select"
Link to this function

aws_dynamodb_table_count()

View Source
@spec aws_dynamodb_table_count() :: :"aws.dynamodb.table_count"

The number of items in the TableNames response parameter.

Value type

Value must be of type integer().

Examples

[20]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_table_count()
:"aws.dynamodb.table_count"
Link to this function

aws_dynamodb_table_names()

View Source
@spec aws_dynamodb_table_names() :: :"aws.dynamodb.table_names"

The keys in the RequestItems object field.

Value type

Value must be of type [atom() | String.t()].

Examples

["Users", "Cats"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_table_names()
:"aws.dynamodb.table_names"
Link to this function

aws_dynamodb_total_segments()

View Source
@spec aws_dynamodb_total_segments() :: :"aws.dynamodb.total_segments"

The value of the TotalSegments request parameter.

Value type

Value must be of type integer().

Examples

[100]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_dynamodb_total_segments()
:"aws.dynamodb.total_segments"
@spec aws_ecs_cluster_arn() :: :"aws.ecs.cluster.arn"

The ARN of an ECS cluster.

Value type

Value must be of type atom() | String.t().

Examples

["arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_cluster_arn()
:"aws.ecs.cluster.arn"
@spec aws_ecs_container_arn() :: :"aws.ecs.container.arn"

The Amazon Resource Name (ARN) of an ECS container instance.

Value type

Value must be of type atom() | String.t().

Examples

["arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_container_arn()
:"aws.ecs.container.arn"
@spec aws_ecs_launchtype() :: :"aws.ecs.launchtype"

The launch type for an ECS task.

iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_launchtype()
:"aws.ecs.launchtype"

iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_launchtype_values().ec2
:ec2

iex> %{OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_launchtype() => OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_launchtype_values().ec2}
%{:"aws.ecs.launchtype" => :ec2}
Link to this function

aws_ecs_launchtype_values()

View Source
@spec aws_ecs_launchtype_values() :: aws_ecs_launchtype_values()
@spec aws_ecs_task_arn() :: :"aws.ecs.task.arn"

The ARN of a running ECS task.

Value type

Value must be of type atom() | String.t().

Examples

["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"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_task_arn()
:"aws.ecs.task.arn"
@spec aws_ecs_task_family() :: :"aws.ecs.task.family"

The family name of the ECS task definition used to create the ECS task.

Value type

Value must be of type atom() | String.t().

Examples

["opentelemetry-family"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_task_family()
:"aws.ecs.task.family"
@spec aws_ecs_task_id() :: :"aws.ecs.task.id"

The ID of a running ECS task. The ID MUST be extracted from task.arn.

Value type

Value must be of type atom() | String.t().

Examples

["10838bed-421f-43ef-870a-f43feacbbb5b", "23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_task_id()
:"aws.ecs.task.id"
@spec aws_ecs_task_revision() :: :"aws.ecs.task.revision"

The revision for the task definition used to create the ECS task.

Value type

Value must be of type atom() | String.t().

Examples

["8", "26"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_ecs_task_revision()
:"aws.ecs.task.revision"
@spec aws_eks_cluster_arn() :: :"aws.eks.cluster.arn"

The ARN of an EKS cluster.

Value type

Value must be of type atom() | String.t().

Examples

["arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_eks_cluster_arn()
:"aws.eks.cluster.arn"
Link to this function

aws_lambda_invoked_arn()

View Source
@spec aws_lambda_invoked_arn() :: :"aws.lambda.invoked_arn"

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

Value type

Value must be of type atom() | String.t().

Notes

This may be different from cloud.resource_id if an alias is involved.

Examples

["arn:aws:lambda:us-east-1:123456:function:myfunction:myalias"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_lambda_invoked_arn()
:"aws.lambda.invoked_arn"
@spec aws_log_group_arns() :: :"aws.log.group.arns"

The Amazon Resource Name(s) (ARN) of the AWS log group(s).

Value type

Value must be of type [atom() | String.t()].

Notes

See the log group ARN format documentation.

Examples

["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_log_group_arns()
:"aws.log.group.arns"
@spec aws_log_group_names() :: :"aws.log.group.names"

The name(s) of the AWS log group(s) an application is writing to.

Value type

Value must be of type [atom() | String.t()].

Notes

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.

Examples

["/aws/lambda/my-function", "opentelemetry-service"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_log_group_names()
:"aws.log.group.names"
@spec aws_log_stream_arns() :: :"aws.log.stream.arns"

The ARN(s) of the AWS log stream(s).

Value type

Value must be of type [atom() | String.t()].

Notes

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.

Examples

["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_log_stream_arns()
:"aws.log.stream.arns"
@spec aws_log_stream_names() :: :"aws.log.stream.names"

The name(s) of the AWS log stream(s) an application is writing to.

Value type

Value must be of type [atom() | String.t()].

Examples

["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_log_stream_names()
:"aws.log.stream.names"
@spec aws_request_id() :: :"aws.request_id"

The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid.

Value type

Value must be of type atom() | String.t().

Examples

["79b9da39-b7ae-508a-a6bc-864b2829c622", "C9ER4AJX75574TDJ"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_request_id()
:"aws.request_id"
@spec aws_s3_bucket() :: :"aws.s3.bucket"

The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations.

Value type

Value must be of type atom() | String.t().

Notes

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.

Examples

["some-bucket-name"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_s3_bucket()
:"aws.s3.bucket"
@spec aws_s3_copy_source() :: :"aws.s3.copy_source"

The source object (in the form bucket/key) for the copy operation.

Value type

Value must be of type atom() | String.t().

Notes

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:

Examples

["someFile.yml"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_s3_copy_source()
:"aws.s3.copy_source"
@spec aws_s3_delete() :: :"aws.s3.delete"

The delete request container that specifies the objects to be deleted.

Value type

Value must be of type atom() | String.t().

Notes

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.

Examples

["Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_s3_delete()
:"aws.s3.delete"
@spec aws_s3_key() :: :"aws.s3.key"

The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.

Value type

Value must be of type atom() | String.t().

Notes

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:

Examples

["someFile.yml"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_s3_key()
:"aws.s3.key"
@spec aws_s3_part_number() :: :"aws.s3.part_number"

The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000.

Value type

Value must be of type integer().

Notes

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.

Examples

[3456]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_s3_part_number()
:"aws.s3.part_number"
@spec aws_s3_upload_id() :: :"aws.s3.upload_id"

Upload ID that identifies the multipart upload.

Value type

Value must be of type atom() | String.t().

Notes

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:

Examples

["dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ"]
iex> OpenTelemetry.SemConv.Incubating.AWSAttributes.aws_s3_upload_id()
:"aws.s3.upload_id"