Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.35 KB

README.md

File metadata and controls

62 lines (47 loc) · 2.35 KB

AWS Java SDK v2 Instrumentation

Instrumentation for AWS Java SDK v2.

Usage

To instrument all AWS SDK clients include the opentelemetry-aws-sdk-2.2-autoconfigure submodule in your classpath.

To register instrumentation only on a specific SDK client, register the interceptor when creating it.

AwsSdkTelemetry telemetry = AwsSdkTelemetry.create(openTelemetry).build();
DynamoDbClient client = DynamoDbClient.builder()
  .overrideConfiguration(ClientOverrideConfiguration.builder()
    .addExecutionInterceptor(telemetry.newExecutionInterceptor()))
    .build())
  .build();

For SQS an additional step is needed

SqsClientBuilder sqsClientBuilder = SqsClient.builder();
...
SqsClient sqsClient = telemetry.wrap(sqsClientBuilder.build());
SqsAsyncClientBuilder sqsAsyncClientBuilder = SqsAsyncClient.builder();
...
SqsAsyncClient sqsAsyncClient = telemetry.wrap(sqsAsyncClientBuilder.build());

Trace propagation

The AWS SDK instrumentation always injects the trace header into the request using the AWS Trace Header format. This format is the only format recognized by AWS managed services, and populating will allow propagating the trace through them.

Additionally, you can enable an experimental option to use the configured propagator to inject into message attributes (see parent README). This currently supports the following AWS APIs:

  • SQS.SendMessage
  • SQS.SendMessageBatch
  • SNS.Publish (SNS.PublishBatch is not supported at the moment because it is not available in the minimum SDK version targeted by the instrumentation)

Note that injection will only happen if, after injection, a maximum of 10 attributes is used to not run over API limitations set by AWS.

If this does not fulfill your use case, perhaps because you are using the same SDK with a different non-AWS managed service, let us know so we can provide configuration for this behavior.

Development

Testing

Some tests use recorded API responses to run through instrumentation. By default, recordings are used, but if needing to add new tests/recordings or update existing ones, run the tests with the RECORD_WITH_REAL_API environment variable set. AWS credentials will need to be correctly configured to work.