Skip to content

Commit

Permalink
Add support for AWS DynamoDB entity
Browse files Browse the repository at this point in the history
  • Loading branch information
hmstepanek committed Nov 15, 2024
1 parent 4f2e9b4 commit 9346bba
Show file tree
Hide file tree
Showing 3 changed files with 267 additions and 127 deletions.
2 changes: 2 additions & 0 deletions newrelic/core/attribute.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"aws.requestId",
"cloud.account.id",
"cloud.region",
"cloud.resource_id",
"code.filepath",
"code.function",
"code.lineno",
Expand All @@ -57,6 +58,7 @@
"db.instance",
"db.operation",
"db.statement",
"db.system",
"enduser.id",
"error.class",
"error.expected",
Expand Down
135 changes: 126 additions & 9 deletions newrelic/hooks/external_botocore.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

from botocore.response import StreamingBody

from newrelic.api.datastore_trace import datastore_trace
from newrelic.api.datastore_trace import DatastoreTrace
from newrelic.api.external_trace import ExternalTrace
from newrelic.api.function_trace import FunctionTrace
from newrelic.api.message_trace import MessageTrace, message_trace
Expand All @@ -39,6 +39,11 @@

QUEUE_URL_PATTERN = re.compile(r"https://sqs.([\w\d-]+).amazonaws.com/(\d+)/([^/]+)")
BOTOCORE_VERSION = get_package_version("botocore")
DOMAIN_TO_PARTITION_MAPPING = {
"amazon.com": "aws",
"amazonaws.cn": "aws-cn",
"amazonaws-us-gov.com": "aws-us-gov",
}


_logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -841,6 +846,118 @@ def handle_chat_completion_event(transaction, bedrock_attrs):
)


def dynamodb_datastore_trace(
product,
target,
operation,
host=None,
port_path_or_id=None,
database_name=None,
async_wrapper=None,
):
@function_wrapper
def _nr_dynamodb_datastore_trace_wrapper_(wrapped, instance, args, kwargs):
wrapper = async_wrapper if async_wrapper is not None else get_async_wrapper(wrapped)
if not wrapper:
parent = current_trace()
if not parent:
return wrapped(*args, **kwargs)
else:
parent = None

if callable(product):
if instance is not None:
_product = product(instance, *args, **kwargs)
else:
_product = product(*args, **kwargs)
else:
_product = product

if callable(target):
if instance is not None:
_target = target(instance, *args, **kwargs)
else:
_target = target(*args, **kwargs)
else:
_target = target

if callable(operation):
if instance is not None:
_operation = operation(instance, *args, **kwargs)
else:
_operation = operation(*args, **kwargs)
else:
_operation = operation

if callable(host):
if instance is not None:
_host = host(instance, *args, **kwargs)
else:
_host = host(*args, **kwargs)
else:
_host = host

if callable(port_path_or_id):
if instance is not None:
_port_path_or_id = port_path_or_id(instance, *args, **kwargs)
else:
_port_path_or_id = port_path_or_id(*args, **kwargs)
else:
_port_path_or_id = port_path_or_id

if callable(database_name):
if instance is not None:
_database_name = database_name(instance, *args, **kwargs)
else:
_database_name = database_name(*args, **kwargs)
else:
_database_name = database_name

trace = DatastoreTrace(
_product, _target, _operation, _host, _port_path_or_id, _database_name, parent=parent, source=wrapped
)

# Try to capture AWS DynamoDB info as agent attributes. Log any exception to debug.
agent_attrs = {}
try:
region = None
if hasattr(instance, "_client_config") and hasattr(instance._client_config, "region_name"):
region = instance._client_config.region_name

transaction = current_transaction()
settings = transaction.settings if transaction.settings else global_settings()
account_id = settings.cloud.aws.account_id if settings and settings.cloud.aws.account_id else None

# There are 3 different partition options.
# See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html for details.
partition = None
if hasattr(instance, "_endpoint") and hasattr(instance._endpoint, "host"):
_db_host = instance._endpoint.host
partition = "aws"
if "amazonaws.cn" in _db_host:
partition = "aws-cn"
elif "amazonaws-us-gov.com" in _db_host:

Check failure

Code scanning / CodeQL

Incomplete URL substring sanitization High

The string
amazonaws-us-gov.com
may be at an arbitrary position in the sanitized URL.
partition = "aws-us-gov"

if partition and region and account_id and _target:
agent_attrs["cloud.resource_id"] = (
f"arn:{partition}:dynamodb:{region}:{account_id:012d}:table/{_target}"
)
agent_attrs["db.system"] = "DynamoDB"

except Exception as e:
_logger.debug("Failed to capture AWS DynamoDB info.", exc_info=True)
trace.agent_attributes.update(agent_attrs)

if wrapper: # pylint: disable=W0125,W0126
return wrapper(wrapped, trace)(*args, **kwargs)

with trace:
return wrapped(*args, **kwargs)

return _nr_dynamodb_datastore_trace_wrapper_


def sqs_message_trace(
operation,
destination_type,
Expand Down Expand Up @@ -891,14 +1008,14 @@ def _nr_sqs_message_trace_wrapper_(wrapped, instance, args, kwargs):

CUSTOM_TRACE_POINTS = {
("sns", "publish"): message_trace("SNS", "Produce", "Topic", extract(("TopicArn", "TargetArn"), "PhoneNumber")),
("dynamodb", "put_item"): datastore_trace("DynamoDB", extract("TableName"), "put_item"),
("dynamodb", "get_item"): datastore_trace("DynamoDB", extract("TableName"), "get_item"),
("dynamodb", "update_item"): datastore_trace("DynamoDB", extract("TableName"), "update_item"),
("dynamodb", "delete_item"): datastore_trace("DynamoDB", extract("TableName"), "delete_item"),
("dynamodb", "create_table"): datastore_trace("DynamoDB", extract("TableName"), "create_table"),
("dynamodb", "delete_table"): datastore_trace("DynamoDB", extract("TableName"), "delete_table"),
("dynamodb", "query"): datastore_trace("DynamoDB", extract("TableName"), "query"),
("dynamodb", "scan"): datastore_trace("DynamoDB", extract("TableName"), "scan"),
("dynamodb", "put_item"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "put_item"),
("dynamodb", "get_item"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "get_item"),
("dynamodb", "update_item"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "update_item"),
("dynamodb", "delete_item"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "delete_item"),
("dynamodb", "create_table"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "create_table"),
("dynamodb", "delete_table"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "delete_table"),
("dynamodb", "query"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "query"),
("dynamodb", "scan"): dynamodb_datastore_trace("DynamoDB", extract("TableName"), "scan"),
("sqs", "send_message"): sqs_message_trace(
"Produce", "Queue", extract_sqs, extract_agent_attrs=extract_sqs_agent_attrs
),
Expand Down
Loading

0 comments on commit 9346bba

Please sign in to comment.