feat: add TenantId to default logger properties (#1113)

Co-authored-by: Henrique Graca <999396+hjgraca@users.noreply.github.com>

Author: jihed-garaouch

libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggingConstants.cs

@@ -111,4 +111,9 @@ internal static class LoggingConstants
     ///     Constant for key exception
     /// </summary>
     internal const string KeyException = "Exception";
+
+    /// <summary>
+    ///   Constant for key tenant id
+    /// </summary>    
+    public const string KeyFunctionTenantId = "TenantId";
 }

libraries/src/AWS.Lambda.Powertools.Logging/Internal/LoggingLambdaContext.cs

@@ -53,6 +53,11 @@ internal class LoggingLambdaContext
     /// </summary>
     internal int MemoryLimitInMB { get; private set; }
 
+    /// <summary>
+    /// The tenant ID associated with the Lambda invocation.
+    /// </summary>
+    internal string TenantId { get; private set; }
+
     /// <summary>
     ///     The instance
     /// </summary>
@@ -86,7 +91,8 @@ public static bool Extract(AspectEventArgs args)
             InvokedFunctionArn = x.InvokedFunctionArn,
             LogGroupName = x.LogGroupName,
             LogStreamName = x.LogStreamName,
-            MemoryLimitInMB = x.MemoryLimitInMB
+            MemoryLimitInMB = x.MemoryLimitInMB,
+            TenantId = x.TenantId,
         };
         return true;
     }

libraries/src/AWS.Lambda.Powertools.Logging/Internal/PowertoolsLogger.cs

@@ -457,6 +457,9 @@ private void AddLambdaContextKeys(Dictionary<string, object> logEntry)
         logEntry.TryAdd(LoggingConstants.KeyFunctionArn, context.InvokedFunctionArn);
         logEntry.TryAdd(LoggingConstants.KeyFunctionRequestId, context.AwsRequestId);
         logEntry.TryAdd(LoggingConstants.KeyFunctionVersion, context.FunctionVersion);
+        
+        if(!string.IsNullOrEmpty(context.TenantId))
+            logEntry.TryAdd(LoggingConstants.KeyFunctionTenantId, context.TenantId);
     }
 
     /// <summary>
@@ -474,6 +477,7 @@ private LogEntryLambdaContext CreateLambdaContext()
             MemoryLimitInMB = context.MemoryLimitInMB,
             InvokedFunctionArn = context.InvokedFunctionArn,
             AwsRequestId = context.AwsRequestId,
+            TenantId = context.TenantId
         };
     }
 

libraries/src/AWS.Lambda.Powertools.Logging/LogEntryLambdaContext.cs

@@ -53,4 +53,9 @@ public class LogEntryLambdaContext
     /// CloudWatch actions.
     /// </summary>
     public string InvokedFunctionArn { get; internal set; }
+
+    /// <summary>
+    /// Tenancy ID associated with the Lambda invocation.
+    /// </summary>
+    public string TenantId { get; set; }
 }

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Attributes/LoggingAttributeTest.cs

@@ -119,6 +119,72 @@ public void OnEntry_WhenEventArgExist_LogEvent()
             );
         }
 
+        [Fact]
+        public void OnEntry_When_TenantId_Exist_Log()
+        {
+            // Arrange
+            var consoleOut = GetConsoleOutput();
+            var correlationId = Guid.NewGuid().ToString();
+            Logger.Configure(options =>
+            {
+                options.LogOutput = consoleOut;
+            });
+            
+            var context = new TestLambdaContext()
+            {
+                TenantId = "Tenant-12345",
+            };
+    
+            var testObj = new TestObject
+            {
+                Headers = new Header
+                {
+                    MyRequestIdHeader = correlationId
+                }
+            };
+            
+            // Act
+            _testHandlers.LogEvent(testObj, context);
+    
+            consoleOut.Received(1).WriteLine(
+                Arg.Is<string>(i => i.Contains("TenantId\":\"Tenant-12345"))
+            );
+        }
+        
+        [Theory]
+        [InlineData("")]
+        [InlineData(null)]
+        public void OnEntry_When_TenantId_Does_Not_Exist_Dont_Log(string tenantId)
+        {
+            // Arrange
+            var consoleOut = GetConsoleOutput();
+            var correlationId = Guid.NewGuid().ToString();
+            Logger.Configure(options =>
+            {
+                options.LogOutput = consoleOut;
+            });
+            
+            var context = new TestLambdaContext()
+            {
+                TenantId = tenantId,
+            };
+    
+            var testObj = new TestObject
+            {
+                Headers = new Header
+                {
+                    MyRequestIdHeader = correlationId
+                }
+            };
+            
+            // Act
+            _testHandlers.LogEvent(testObj, context);
+    
+            consoleOut.DidNotReceive().WriteLine(
+                Arg.Is<string>(i => i.Contains("\"TenantId\""))
+            );
+        }
+        
         [Fact]
         public void OnEntry_WhenEventArgExist_LogEvent_False_Should_Not_Log()
         {

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Context/LambdaContextTest.cs

@@ -23,7 +23,8 @@ public void Extract_WhenHasLambdaContextArgument_InitializesLambdaContextInfo()
              InvokedFunctionArn = Guid.NewGuid().ToString(),
              LogGroupName = Guid.NewGuid().ToString(),
              LogStreamName = Guid.NewGuid().ToString(),
-             MemoryLimitInMB = new Random().Next()
+             MemoryLimitInMB = new Random().Next(),
+             TenantId = Guid.NewGuid().ToString()
          };
 
          var args = Substitute.For<AspectEventArgs>();
@@ -52,6 +53,7 @@ public void Extract_WhenHasLambdaContextArgument_InitializesLambdaContextInfo()
          Assert.Equal(LoggingLambdaContext.Instance.LogGroupName, lambdaContext.LogGroupName);
          Assert.Equal(LoggingLambdaContext.Instance.LogStreamName, lambdaContext.LogStreamName);
          Assert.Equal(LoggingLambdaContext.Instance.MemoryLimitInMB, lambdaContext.MemoryLimitInMB);
+         Assert.Equal(LoggingLambdaContext.Instance.TenantId, lambdaContext.TenantId);
          LoggingLambdaContext.Clear();
          Assert.Null(LoggingLambdaContext.Instance);
      }
@@ -120,7 +122,8 @@ public void Extract_WhenInstance_Already_Created_Returns_False()
              InvokedFunctionArn = Guid.NewGuid().ToString(),
              LogGroupName = Guid.NewGuid().ToString(),
              LogStreamName = Guid.NewGuid().ToString(),
-             MemoryLimitInMB = new Random().Next()
+             MemoryLimitInMB = new Random().Next(),
+             TenantId = Guid.NewGuid().ToString()
          };
 
          var args = Substitute.For<AspectEventArgs>();

libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Handlers/HandlerTests.cs

@@ -107,7 +107,8 @@ public void TestMethod()
             FunctionName = "test-function",
             FunctionVersion = "1",
             AwsRequestId = "123",
-            InvokedFunctionArn = "arn:aws:lambda:us-east-1:123456789012:function:test-function"
+            InvokedFunctionArn = "arn:aws:lambda:us-east-1:123456789012:function:test-function",
+            TenantId = "tenant-123"
         });
 
         handler.TestMethodCorrelation(new ExampleClass
@@ -131,6 +132,7 @@ public void TestMethod()
         Assert.Contains("\"Custom-key\": \"custom-value\"", logOutput);
         Assert.Contains("\"FunctionName\": \"test-function\"", logOutput);
         Assert.Contains("\"SamplingRate\": 0.002", logOutput);
+        Assert.Contains("\"TenantId\": \"tenant-123\"", logOutput);
     }
 
     [Fact]