Skip to content

Commit

Permalink
add semantic conventions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@JamieDanielson
JamieDanielson committed Apr 23, 2024
1 parent c37f9ed commit 8d22664
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,54 @@ The instrumentation's config `preRequestHook`, `responseHook` and `sqsProcessHoo

The `moduleVersionAttributeName` config option is removed. To add the aws-sdk package version to spans, use the `moduleVersion` attribute in hook info for `preRequestHook` and `responseHook` functions.

## Semantic Conventions

This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)

Attributes collected:

| Attribute | Short Description | Service |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------- | -------- |
| `http.status_code` | (aws-sdk) HTTP response status code. | |
| `rpc.method` | The name of the (logical) method being called. | |
| `rpc.service` | The full (logical) name of the service being called. | |
| `rpc.system` | A string identifying the remoting system. | |
| `aws.dynamodb.attribute_definitions` | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | dynamodb |
| `aws.dynamodb.consistent_read` | The value of the `ConsistentRead` request parameter. | dynamodb |
| `aws.dynamodb.consumed_capacity` | The JSON-serialized value of each item in the `ConsumedCapacity` response field. | dynamodb |
| `aws.dynamodb.count` | The value of the `Count` response parameter. | dynamodb |
| `aws.dynamodb.exclusive_start_table` | The value of the `ExclusiveStartTableName` request parameter. | dynamodb |
| `aws.dynamodb.global_secondary_index_updates` | The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field. | dynamodb |
| `aws.dynamodb.global_secondary_indexes` | The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field. | dynamodb |
| `aws.dynamodb.index_name` | The value of the `IndexName` request parameter. | dynamodb |
| `aws.dynamodb.item_collection_metrics` | The JSON-serialized value of the `ItemCollectionMetrics` response field. | dynamodb |
| `aws.dynamodb.limit` | The value of the `Limit` request parameter. | dynamodb |
| `aws.dynamodb.local_secondary_indexes` | The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. | dynamodb |
| `aws.dynamodb.projection` | The value of the `ProjectionExpression` request parameter. | dynamodb |
| `aws.dynamodb.provisioned_read_capacity` | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | dynamodb |
| `aws.dynamodb.provisioned_write_capacity` | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | dynamodb |
| `aws.dynamodb.scan_forward` | The value of the `ScanIndexForward` request parameter. | dynamodb |
| `aws.dynamodb.scanned_count` | The value of the `ScannedCount` response parameter. | dynamodb |
| `aws.dynamodb.segment` | The value of the `Segment` request parameter. | dynamodb |
| `aws.dynamodb.select` | The value of the `Select` request parameter. | dynamodb |
| `aws.dynamodb.table_count` | The number of items in the `TableNames` response parameter. | dynamodb |
| `aws.dynamodb.table_names` | The keys in the `RequestItems` object field. | dynamodb |
| `aws.dynamodb.total_segments` | The value of the `TotalSegments` request parameter. | dynamodb |
| `db.name` | The name of the database being accessed. | dynamodb |
| `db.operation` | The name of the operation being executed. | dynamodb |
| `db.statement` | The database statement being executed. | dynamodb |
| `db.system` | An identifier for the database management system (DBMS) product being used. | dynamodb |
| `faas.execution` | The execution ID of the current function execution. | lambda |
| `faas.invoked_name` | The name of the invoked function. | lambda |
| `faas.invoked_provider` | The cloud provider of the invoked function. | lambda |
| `faas.invoked_region` | The cloud region of the invoked function. | lambda |
| `messaging.destination` | The message destination name. | sns, sqs |
| `messaging.destination_kind` | The kind of message destination. | sns, sqs |
| `messaging.system` | A string identifying the messaging system. | sns, sqs |
| `messaging.operation` | A string identifying the kind of message consumption. | sqs |
| `messaging.message_id` | A value used by the messaging system as an identifier for the message. | sqs |
| `messaging.url` | The connection string. | sqs |

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down

0 comments on commit 8d22664

Please sign in to comment.