Skip to content

Commit

Permalink
DynamoDB
Browse files Browse the repository at this point in the history
  • Loading branch information
meiao committed Oct 29, 2024
1 parent ec234dd commit e97a491
Show file tree
Hide file tree
Showing 14 changed files with 638 additions and 96 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import com.amazonaws.AmazonWebServiceClient;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest;
import com.amazonaws.services.dynamodbv2.model.BatchGetItemResult;
import com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest;
Expand Down Expand Up @@ -69,145 +70,145 @@ public AmazonDynamoDBClient_Instrumentation(ClientConfiguration clientConfigurat
final CreateTableResult executeCreateTable(CreateTableRequest createTableRequest) {
linkAndExpire(createTableRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "createTable",
createTableRequest.getTableName(), endpoint);
createTableRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final BatchGetItemResult executeBatchGetItem(BatchGetItemRequest batchGetItemRequest) {
linkAndExpire(batchGetItemRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "batchGetItem", "batch", endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "batchGetItem", "batch", endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final BatchWriteItemResult executeBatchWriteItem(BatchWriteItemRequest batchWriteItemRequest) {
linkAndExpire(batchWriteItemRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "batchWriteItem", "batch", endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "batchWriteItem", "batch", endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final DeleteItemResult executeDeleteItem(DeleteItemRequest deleteItemRequest) {
linkAndExpire(deleteItemRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "deleteItem",
deleteItemRequest.getTableName(), endpoint);
deleteItemRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final DeleteTableResult executeDeleteTable(DeleteTableRequest deleteTableRequest) {
linkAndExpire(deleteTableRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "deleteTable",
deleteTableRequest.getTableName(), endpoint);
deleteTableRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final DescribeLimitsResult executeDescribeLimits(DescribeLimitsRequest describeLimitsRequest) {
linkAndExpire(describeLimitsRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "describeLimits", null, endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "describeLimits", null, endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final DescribeTableResult executeDescribeTable(DescribeTableRequest describeTableRequest) {
linkAndExpire(describeTableRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "describeTable",
describeTableRequest.getTableName(), endpoint);
describeTableRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final DescribeTimeToLiveResult executeDescribeTimeToLive(DescribeTimeToLiveRequest describeTimeToLiveRequest) {
linkAndExpire(describeTimeToLiveRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "describeTimeToLive",
describeTimeToLiveRequest.getTableName(), endpoint);
describeTimeToLiveRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final GetItemResult executeGetItem(GetItemRequest getItemRequest) {
linkAndExpire(getItemRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "getItem", getItemRequest.getTableName(),
endpoint);
endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final ListTablesResult executeListTables(ListTablesRequest listTablesRequest) {
linkAndExpire(listTablesRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "listTables",
listTablesRequest.getExclusiveStartTableName(), endpoint);
listTablesRequest.getExclusiveStartTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final ListTagsOfResourceResult executeListTagsOfResource(ListTagsOfResourceRequest listTagsOfResourceRequest) {
linkAndExpire(listTagsOfResourceRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "listTagsOfResource", null, endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "listTagsOfResource", null, endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final PutItemResult executePutItem(PutItemRequest putItemRequest) {
linkAndExpire(putItemRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "putItem", putItemRequest.getTableName(),
endpoint);
endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final QueryResult executeQuery(QueryRequest queryRequest) {
linkAndExpire(queryRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "query", queryRequest.getTableName(),
endpoint);
endpoint, this);
return Weaver.callOriginal();

}

@Trace(async = true, leaf = true)
final ScanResult executeScan(ScanRequest scanRequest) {
linkAndExpire(scanRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "scan", scanRequest.getTableName(), endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "scan", scanRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) {
linkAndExpire(tagResourceRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "tagResource", null, endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "tagResource", null, endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) {
linkAndExpire(untagResourceRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "untagResource", null, endpoint);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "untagResource", null, endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final UpdateItemResult executeUpdateItem(UpdateItemRequest updateItemRequest) {
linkAndExpire(updateItemRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "updateItem",
updateItemRequest.getTableName(), endpoint);
updateItemRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final UpdateTableResult executeUpdateTable(UpdateTableRequest updateTableRequest) {
linkAndExpire(updateTableRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "updateTable",
updateTableRequest.getTableName(), endpoint);
updateTableRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

@Trace(async = true, leaf = true)
final UpdateTimeToLiveResult executeUpdateTimeToLive(UpdateTimeToLiveRequest updateTimeToLiveRequest) {
linkAndExpire(updateTimeToLiveRequest);
DynamoDBMetricUtil.metrics(NewRelic.getAgent().getTracedMethod(), "updateTimeToLive",
updateTimeToLiveRequest.getTableName(), endpoint);
updateTimeToLiveRequest.getTableName(), endpoint, this);
return Weaver.callOriginal();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@

package com.nr.instrumentation.dynamodb_1_11_106;

import com.newrelic.agent.bridge.AgentBridge;
import com.newrelic.agent.bridge.datastore.DatastoreVendor;
import com.newrelic.api.agent.CloudAccountInfo;
import com.newrelic.api.agent.DatastoreParameters;
import com.newrelic.api.agent.NewRelic;
import com.newrelic.api.agent.TracedMethod;

import java.net.URI;
import java.util.logging.Level;

/**
* This uses {@link DatastoreParameters} to create external metrics for all DynamoDB calls in
Expand All @@ -21,24 +25,84 @@ public abstract class DynamoDBMetricUtil {

private static final String PRODUCT = DatastoreVendor.DynamoDB.name();
private static final String INSTANCE_HOST = "amazon";
private static final String INSTANCE_ID = "dynamodb";

public static void metrics(TracedMethod tracedMethod, String operation, String collection, URI endpoint) {
String host = endpoint == null ? INSTANCE_HOST : endpoint.getHost();
String port = endpoint == null ? INSTANCE_ID : String.valueOf(getPort(endpoint));

public static void metrics(TracedMethod tracedMethod, String operation, String collection, URI endpoint, Object sdkClient) {
String host = INSTANCE_HOST;
String arn = null;
Integer port = null;
if (endpoint != null) {
host = endpoint.getHost();
port = getPort(endpoint);
arn = getArn(collection, sdkClient, host);
}
DatastoreParameters params = DatastoreParameters
.product(PRODUCT)
.collection(collection)
.operation(operation)
.instance(host, port)
.noDatabaseName()
.cloudResourceId(arn)
.build();

tracedMethod.reportAsExternal(params);
}

private static int getPort(URI endpoint) {
// visible for testing
static String getArn(String tableName, Object sdkClient, String host) {
String accountId = AgentBridge.cloud.getAccountInfo(sdkClient, CloudAccountInfo.AWS_ACCOUNT_ID);
if (accountId == null) {
NewRelic.getAgent().getLogger().log(Level.FINEST, "Unable to assemble ARN. No account information provided.");
return null;
}

if (tableName == null) {
NewRelic.getAgent().getLogger().log(Level.FINEST, "Unable to assemble ARN. Unable to determine table.");
return null;
}

String region = getRegion(host);
if (region == null) {
NewRelic.getAgent().getLogger().log(Level.FINEST, "Unable to assemble ARN. Unable to determine region.");
return null;
}

// arn:${Partition}:dynamodb:${Region}:${Account}:table/${TableName}
return "arn:aws:dynamodb:" + region + ":" + accountId + ":table/" + tableName;
}

// visible for testing
static String getRegion(String host) {
if (host == null) {
return null;
}
if (!host.startsWith("dynamodb")) {
return null;
}

final int afterDynamoDb = 8; // "dynamodb".length()
if (host.charAt(afterDynamoDb) == '.') {
// dynamodb.{region}.amazonaws.com
int secondPeriod = host.indexOf('.', afterDynamoDb + 1);
if (secondPeriod > 0 && host.startsWith(".amazonaws.com", secondPeriod)) {
return host.substring(afterDynamoDb + 1, secondPeriod);
} else {
return null;
}
} else if (host.startsWith("-fips.", afterDynamoDb)) {
// dynamodb-fips.{region}.amazonaws.com
final int firstPeriod = 13; // "dynamodb-fips".length()
int secondPeriod = host.indexOf('.', firstPeriod + 1);
if (secondPeriod > 0 && host.startsWith(".amazonaws.com", secondPeriod)) {
return host.substring(firstPeriod + 1, secondPeriod);
} else {
return null;
}
}
return null;
}

private static Integer getPort(URI endpoint) {
if (endpoint.getPort() > 0) {
return endpoint.getPort();
}
Expand All @@ -49,7 +113,7 @@ private static int getPort(URI endpoint) {
} else if ("https".equalsIgnoreCase(scheme)) {
return 443;
}
return -1;
return null;
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
import com.newrelic.api.agent.Trace;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand Down
Loading

0 comments on commit e97a491

Please sign in to comment.