chore: Add Transaction.Guid to Activity finest log entries. (#3469)

Author: jaffinito

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

@@ -29,7 +29,7 @@ public static void ProcessActivityTags(this ISegment segment, object originalAct
         string activityId = activity.Id;
         string displayName = activity.DisplayName;
 
-        string activityLogPrefix = ActivityLogPrefixHelpers.ActivityLogPrefix(activityId, activityKind, displayName);
+        string activityLogPrefix = ActivityLogPrefixHelpers.ActivityLogPrefix(GetTransactionGuidFromSegment(segment), activityId, activityKind, displayName);
 
         Log.Debug($"{activityLogPrefix} has stopped.");
 
@@ -694,15 +694,20 @@ public static void AddExceptionEventInformationToSegment(this ISegment segment,
                 }
             }
         }
+    }
 
+    private static string GetTransactionGuidFromSegment(ISegment segment)
+    {
+        var internalSegment = segment as IInternalSpan;
+        return internalSegment?.GetTransactionGuid();
     }
 }
 
 public static class ActivityLogPrefixHelpers
 {
-    public static string ActivityLogPrefix(string activityId, int activityKindInt, string activityDisplayName)
+    public static string ActivityLogPrefix(string transactionGuid, string activityId, int activityKindInt, string activityDisplayName)
     {
-        return $"Activity {activityId} (Kind: {(ActivityKind)activityKindInt}, DisplayName: {activityDisplayName})";
+        return $"Trx {transactionGuid}: Activity {activityId} (Kind: {(ActivityKind)activityKindInt}, DisplayName: {activityDisplayName})";
     }
 }
 

src/Agent/NewRelic/Agent/Core/Segments/IInternalSpan.cs

@@ -12,4 +12,6 @@ public interface IInternalSpan : ISegment, ISegmentExperimental, ISpan
     ErrorData ErrorData { get; set; }
 
     string TryGetActivityTraceId();
-}
+
+    string GetTransactionGuid();
+}

src/Agent/NewRelic/Agent/Core/Segments/Segment.cs

@@ -307,10 +307,10 @@ private void UpdateCurrentActivity()
         }
         else
         {
-            Log.Finest("Segment.RemoveSegmentFromCallStack: NoOpSegment, setting Activity.Current to null");
+            Log.Finest($"Trx {GetTransactionGuid()}: Segment.RemoveSegmentFromCallStack: NoOpSegment, setting Activity.Current to null");
             ActivityBridgeHelpers.SetCurrentActivity(null);
 
-            if (Log.IsFinestEnabled) Log.Finest($"Segment.RemoveSegmentFromCallStack: Activity.Current is now: {((dynamic)ActivityBridgeHelpers.GetCurrentActivity())?.Id ?? "null"}");
+            if (Log.IsFinestEnabled) Log.Finest($"Trx {GetTransactionGuid()}: Segment.RemoveSegmentFromCallStack: Activity.Current is now: {((dynamic)ActivityBridgeHelpers.GetCurrentActivity())?.Id ?? "null"}");
         }
     }
 
@@ -337,15 +337,20 @@ public ITransaction GetTransactionFromSegment()
         return _transactionSegmentState as ITransaction;
     }
 
+    public string GetTransactionGuid()
+    {
+        return (_transactionSegmentState as IInternalTransaction)?.Guid ?? "empty";
+    }
+
     public bool ActivityStartedTransaction { get; set; } = false;
 
     public void MakeActivityCurrent()
     {
-        if (Log.IsFinestEnabled) Log.Finest($"Segment.MakeActivityCurrent: Setting Activity.Current to this segment's activity: {_activity?.Id ?? "null"}");
+        if (Log.IsFinestEnabled) Log.Finest($"Trx {GetTransactionGuid()}: Segment.MakeActivityCurrent: Setting Activity.Current to this segment's activity: {_activity?.Id ?? "null"}");
 
         _activity?.MakeCurrent();
 
-        if (Log.IsFinestEnabled) Log.Finest($"Segment.MakeActivityCurrent: Activity.Current is now: {((dynamic)ActivityBridgeHelpers.GetCurrentActivity())?.Id ?? "null"}");
+        if (Log.IsFinestEnabled) Log.Finest($"Trx {GetTransactionGuid()}: Segment.MakeActivityCurrent: Activity.Current is now: {((dynamic)ActivityBridgeHelpers.GetCurrentActivity())?.Id ?? "null"}");
     }
 
     // We start and end segments on different threads (sometimes) so we need _relativeEndTicks

tests/Agent/UnitTests/Core.UnitTest/Segments/SegmentTests.cs

@@ -3,10 +3,18 @@
 
 using System;
 using System.Collections.Generic;
+using NewRelic.Agent.Api.Experimental;
+using NewRelic.Agent.Configuration;
+using NewRelic.Agent.Core.Attributes;
+using NewRelic.Agent.Core.CallStack;
+using NewRelic.Agent.Core.DistributedTracing;
+using NewRelic.Agent.Core.DistributedTracing.Samplers;
 using NewRelic.Agent.Core.Errors;
 using NewRelic.Agent.Core.Metrics;
 using NewRelic.Agent.Core.Segments.Tests;
+using NewRelic.Agent.Core.Time;
 using NewRelic.Agent.Core.Transactions;
+using NewRelic.Agent.Core.Wrapper.AgentWrapperApi.Builders;
 using NewRelic.Agent.Core.Wrapper.AgentWrapperApi.Data;
 using NewRelic.Agent.Extensions.Api.Experimental;
 using NUnit.Framework;
@@ -532,4 +540,34 @@ public void SpanEventEvent_Constructor_SetsPropertiesCorrectly()
             Assert.That(spanEvent.Attributes, Is.Not.Null);
         });
     }
+
+    [Test]
+    public void GetTransactionGuid_ReturnsSuccessfully()
+    {
+        var priority = 0.0f;
+        var configuration = Mock.Create<IConfiguration>();
+        Mock.Arrange(() => configuration.TransactionEventsEnabled).Returns(true);
+
+        // Initialize the Transaction with its dependencies
+        var attribDefSvc = new AttributeDefinitionService((f) => new AttributeDefinitions(f));
+        var databaseStatementParser = Mock.Create<IDatabaseStatementParser>();
+        var distributedTracePayloadHandler = Mock.Create<IDistributedTracePayloadHandler>();
+
+        var transaction = new Transaction(configuration, Mock.Create<ITransactionName>(), Mock.Create<ISimpleTimer>(),
+            DateTime.UtcNow, Mock.Create<ICallStackManager>(), Mock.Create<IDatabaseService>(),
+            priority, databaseStatementParser, distributedTracePayloadHandler, Mock.Create<IErrorService>(), attribDefSvc.AttributeDefs, Mock.Create<ISamplerService>());
+        var segment = new Segment(transaction.GetTransactionSegmentState(), new MethodCallData("Type", "Method", 1));
+        var transactionGuid = segment.GetTransactionGuid();
+        Assert.That(transactionGuid, Is.Not.Null);
+        Assert.That(transactionGuid, Is.EqualTo(transaction.Guid));
+    }
+
+    [Test]
+    public void GetTransactionGuid_ReturnsEmptyWhenNoGuid()
+    {
+        var segment = new Segment(TransactionSegmentStateHelpers.GetItransactionSegmentState(), new MethodCallData("Type", "Method", 1));
+        var transactionGuid = segment.GetTransactionGuid();
+        Assert.That(transactionGuid, Is.Not.Null);
+        Assert.That(transactionGuid, Is.EqualTo("empty"));
+    }
 }