Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support AWS SDK v1 request object subclasses. #5231

Merged
merged 1 commit into from
Jan 26, 2022
Merged

Support AWS SDK v1 request object subclasses. #5231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...rc/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkInstrumenterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ final class AwsSdkInstrumenterFactory {
rpcAttributesExtractor,
netAttributesExtractor,
experimentalAttributesExtractor);
private static final AwsSdkSpanNameExtractor spanName = new AwsSdkSpanNameExtractor();
private static final AwsSdkSpanNameExtractor spanName =
new AwsSdkSpanNameExtractor(rpcAttributesExtractor);

static Instrumenter<Request<?>, Response<?>> requestInstrumenter(
OpenTelemetry openTelemetry, boolean captureExperimentalSpanAttributes) {
Expand Down
8 changes: 7 additions & 1 deletion ...main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkRpcAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,13 @@ final class AwsSdkRpcAttributesExtractor extends RpcAttributesExtractor<Request<
@Override
protected String computeValue(Class<?> type) {
String ret = type.getSimpleName();
ret = ret.substring(0, ret.length() - 7); // remove 'Request'
if (!ret.endsWith("Request")) {
// Best effort check one parent to support implicit subclasses
ret = type.getSuperclass().getSimpleName();
}
if (ret.endsWith("Request")) {
ret = ret.substring(0, ret.length() - 7); // remove 'Request'
}
return ret;
}
};
Expand Down
24 changes: 13 additions & 11 deletions .../src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkSpanNameExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,25 @@
import java.util.concurrent.ConcurrentHashMap;

class AwsSdkSpanNameExtractor implements SpanNameExtractor<Request<?>> {

private final AwsSdkRpcAttributesExtractor rpcAttributes;
private final NamesCache namesCache = new NamesCache();

AwsSdkSpanNameExtractor(AwsSdkRpcAttributesExtractor rpcAttributes) {
this.rpcAttributes = rpcAttributes;
}

@Override
public String extract(Request<?> request) {
String awsServiceName = request.getServiceName();
Class<?> awsOperation = request.getOriginalRequest().getClass();
return qualifiedOperation(awsServiceName, awsOperation);
return qualifiedOperation(
rpcAttributes.service(request),
rpcAttributes.method(request),
request.getOriginalRequest().getClass());
}

private String qualifiedOperation(String service, Class<?> operation) {
ConcurrentHashMap<String, String> cache = namesCache.get(operation);
return cache.computeIfAbsent(
service,
s ->
s.replace("Amazon", "").trim()
+ '.'
+ operation.getSimpleName().replace("Request", ""));
private String qualifiedOperation(String service, String operation, Class<?> requestClass) {
ConcurrentHashMap<String, String> cache = namesCache.get(requestClass);
return cache.computeIfAbsent(service, s -> s.replace("Amazon", "").trim() + '.' + operation);
}

static final class NamesCache extends ClassValue<ConcurrentHashMap<String, String>> {
Expand Down
7 changes: 6 additions & 1 deletion ...c/main/groovy/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractAws1ClientTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ abstract class AbstractAws1ClientTest extends InstrumentationSpecification {
response != null

client.requestHandler2s != null
client.requestHandler2s.find{it.getClass().getSimpleName() == "TracingRequestHandler"} != null
client.requestHandler2s.find { it.getClass().getSimpleName() == "TracingRequestHandler" } != null

assertTraces(1) {
trace(0, 1) {
Expand Down Expand Up @@ -133,6 +133,11 @@ abstract class AbstractAws1ClientTest extends InstrumentationSpecification {
"S3" | "GetObject" | "GET" | "/someBucket/someKey" | AmazonS3ClientBuilder.standard().withPathStyleAccessEnabled(true) | { c -> c.getObject("someBucket", "someKey") } | ["aws.bucket.name": "someBucket"] | ""
"DynamoDBv2" | "CreateTable" | "POST" | "/" | AmazonDynamoDBClientBuilder.standard() | { c -> c.createTable(new CreateTableRequest("sometable", null)) } | ["aws.table.name": "sometable"] | ""
"Kinesis" | "DeleteStream" | "POST" | "/" | AmazonKinesisClientBuilder.standard() | { c -> c.deleteStream(new DeleteStreamRequest().withStreamName("somestream")) } | ["aws.stream.name": "somestream"] | ""
// Some users may implicitly subclass the request object to mimic a fluent style
"Kinesis" | "DeleteStream" | "POST" | "/" | AmazonKinesisClientBuilder.standard() | { c ->
c.deleteStream(new DeleteStreamRequest() {
{ withStreamName("somestream") }
}) } | ["aws.stream.name": "somestream"] | ""
"EC2" | "AllocateAddress" | "POST" | "/" | AmazonEC2ClientBuilder.standard() | { c -> c.allocateAddress() } | [:] | """
<AllocateAddressResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
Expand Down