chore(hybrid-agent): DynamoDB datastore segment data support (#3332)

Author: tippmar-nr

src/Agent/NewRelic/Agent/Core/OpenTelemetryBridge/ActivityBridgeSegmentHelpers.cs

@@ -17,6 +17,7 @@
 using NewRelic.Agent.Extensions.Parsing;
 using NewRelic.Agent.Extensions.Providers.Wrapper;
 using NewRelic.Agent.Extensions.SystemExtensions;
+using static Grpc.Core.ServerServiceDefinition;
 
 namespace NewRelic.Agent.Core.OpenTelemetryBridge;
 
@@ -474,7 +475,8 @@ private static void ProcessClientDatabaseTags(ISegment segment, IAgent agent, dy
             "redis" => DatastoreVendor.Redis,
             "azure.cosmosdb" => DatastoreVendor.CosmosDB,
             "elasticsearch" => DatastoreVendor.Elasticsearch,
-            "aws.dynamodb" => DatastoreVendor.DynamoDB,
+            "dynamodb" => DatastoreVendor.DynamoDB, // OpenTelemetry.Instrumentation.AWS produces "dynamodb" for db.system
+            "aws.dynamodb" => DatastoreVendor.DynamoDB, // the otel spec says "aws.dynamodb" is the correct value for DynamoDB
             _ => DatastoreVendor.Other
         };
 
@@ -484,6 +486,7 @@ private static void ProcessClientDatabaseTags(ISegment segment, IAgent agent, dy
         ISegmentData segmentData = vendor switch
         {
             DatastoreVendor.Elasticsearch => GetElasticSearchDatastoreSegmentData(agent, tags, vendor, activityLogPrefix),
+            DatastoreVendor.DynamoDB => GetDynamoDbDatastoreSegmentData(agent, activity, activityLogPrefix, tags, segment),
             _ => GetDefaultDatastoreSegmentData(agent, activity, activityLogPrefix, tags, vendor)
         };
 
@@ -568,6 +571,40 @@ private static ISegmentData GetElasticSearchDatastoreSegmentData(IAgent agent, D
         return new DatastoreSegmentData(agent.GetExperimentalApi().DatabaseService, parsedSqlStatement, string.Empty, connectionInfo);
     }
 
+    private static ISegmentData GetDynamoDbDatastoreSegmentData(IAgent agent, dynamic activity, string activityLogPrefix, Dictionary<string, object> tags, ISegment segment)
+    {
+        tags.TryGetAndRemoveTag<string>(["aws.dynamodb.table_names"], out var tableNames);
+        if (string.IsNullOrEmpty(tableNames))
+        {
+            Log.Finest($"DynamoDB {activityLogPrefix} is missing required tag for table names. Not creating a DatastoreSegmentData.");
+            return null;
+        }
+
+        // DynamoDB operation is in rpc.method
+        tags.TryGetAndRemoveTag<string>(["rpc.method"], out var dbOperation);
+        if (string.IsNullOrEmpty(dbOperation))
+        {
+            Log.Finest($"DynamoDB {activityLogPrefix} is missing required tag for operation. Not creating a DatastoreSegmentData.");
+            return null;
+        }
+
+        // Add DynamoDB specific attributes to the segment
+        segment.AddCloudSdkAttribute("aws.operation", dbOperation);
+
+        // spec says region is in cloud.region but it's not there currently
+        if (tags.TryGetAndRemoveTag<string>(["cloud.region"], out var awsRegion))
+            segment.AddCloudSdkAttribute("aws.region", awsRegion);
+
+        // requestId is in aws.request_id
+        if (tags.TryGetAndRemoveTag<string>(["aws.request_id"], out var requestId))
+            segment.AddCloudSdkAttribute("aws.requestId", requestId);
+
+        var parsedSqlStatement = new ParsedSqlStatement(DatastoreVendor.DynamoDB, tableNames, dbOperation);
+
+        Log.Finest($"Created DatastoreSegmentData for DynamoDB {activityLogPrefix}");
+        return new DatastoreSegmentData(agent.GetExperimentalApi().DatabaseService, parsedSqlStatement, string.Empty, null);
+    }
+
     public static void AddExceptionEventInformationToSegment(this ISegment segment, object originalActivity, IErrorService errorService)
     {
         // Exceptions recorded during an activity may be added as events on the activity. Not every way of recording

tests/Agent/UnitTests/CompositeTests/HybridAgent/TestCaseDefinitions/HybridAgentTests.json

@@ -2516,5 +2516,98 @@
                 }
             ]
         }
+    },
+    {
+        "testDescription": "Client Database - AWS DynamoDB PutItem",
+        "operations": [
+            {
+                "command": "DoWorkInTransaction",
+                "parameters": {
+                    "transactionName": "Foo"
+                },
+                "childOperations": [
+                    {
+                        "command": "DoWorkInSpan",
+                        "parameters": {
+                            "spanName": "DynamoDB.PutItem",
+                            "spanKind": "Client"
+                        },
+                        "childOperations": [
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "rpc.method",
+                                    "value": "PutItem"
+                                }
+                            },
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "rpc.system",
+                                    "value": "aws-api"
+                                }
+                            },
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "rpc.service",
+                                    "value": "DynamoDB"
+                                }
+                            },
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "db.system",
+                                    "value": "dynamodb"
+                                }
+                            },
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "aws.dynamodb.table_names",
+                                    "value": "Movies"
+                                }
+                            },
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "aws.request_id",
+                                    "value": "f9926109-56fc-412f-a3b2-d27742d5f5c1"
+                                }
+                            },
+                            {
+                                "command": "AddOTelAttribute",
+                                "parameters": {
+                                    "name": "cloud.region",
+                                    "value": "us-east-1"
+                                }
+                            }
+                        ]
+                    }
+                ]
+            }
+        ],
+        "agentOutput": {
+            "transactions": [
+                {
+                    "name": "Foo"
+                }
+            ],
+            "spans": [
+                {
+                    "name": "Datastore/statement/DynamoDB/Movies/PutItem",
+                    "parentName": "Foo",
+                    "category": "datastore",
+                    "attributes": {
+                        "db.collection": "Movies",
+                        "db.operation": "PutItem",
+                        "db.system": "dynamodb",
+                        "aws.operation": "PutItem",
+                        "aws.requestId": "f9926109-56fc-412f-a3b2-d27742d5f5c1",
+                        "aws.region": "us-east-1"
+                    }
+                }
+            ]
+        }
     }
 ]