Merge pull request #832 from hjgraca/feature/logger-ilogger-instance

chore: Powertools Logger v2

Author: hjgraca

docs/core/logging-v2.md

@@ -19,7 +19,7 @@ Powertools for AWS Lambda (.NET) are available as NuGet packages. You can instal
 
 * [AWS.Lambda.Powertools.Logging](https://www.nuget.org/packages?q=AWS.Lambda.Powertools.Logging):
 
-    `dotnet add package AWS.Lambda.Powertools.Logging`
+    `dotnet add package AWS.Lambda.Powertools.Logging --version 1.6.5`
 
 ## Getting started
 

docs/core/logging.md

@@ -103,6 +103,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AWS.Lambda.Powertools.Metri
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Metrics", "Metrics", "{A566F2D7-F8FE-466A-8306-85F266B7E656}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AOT-Function-ILogger", "tests\e2e\functions\core\logging\AOT-Function-ILogger\src\AOT-Function-ILogger\AOT-Function-ILogger.csproj", "{7FC6DD65-0352-4139-8D08-B25C0A0403E3}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -548,6 +550,18 @@ Global
 		{F8F80477-1EAD-4C5C-A329-CBC0A60C7CAB}.Release|x64.Build.0 = Release|Any CPU
 		{F8F80477-1EAD-4C5C-A329-CBC0A60C7CAB}.Release|x86.ActiveCfg = Release|Any CPU
 		{F8F80477-1EAD-4C5C-A329-CBC0A60C7CAB}.Release|x86.Build.0 = Release|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Debug|x64.Build.0 = Debug|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Debug|x86.Build.0 = Debug|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Release|x64.ActiveCfg = Release|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Release|x64.Build.0 = Release|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Release|x86.ActiveCfg = Release|Any CPU
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 
 	GlobalSection(NestedProjects) = preSolution
@@ -596,5 +610,6 @@ Global
 		{A566F2D7-F8FE-466A-8306-85F266B7E656} = {1CFF5568-8486-475F-81F6-06105C437528}
 		{F8F80477-1EAD-4C5C-A329-CBC0A60C7CAB} = {A566F2D7-F8FE-466A-8306-85F266B7E656}
 		{A422C742-2CF9-409D-BDAE-15825AB62113} = {A566F2D7-F8FE-466A-8306-85F266B7E656}
+		{7FC6DD65-0352-4139-8D08-B25C0A0403E3} = {4EAB66F9-C9CB-4E8A-BEE6-A14CD7FDE02F}
 	EndGlobalSection
 EndGlobal

libraries/AWS.Lambda.Powertools.sln

@@ -13,6 +13,6 @@
         <PackageReference Include="Amazon.Lambda.DynamoDBEvents" />
         <PackageReference Include="Amazon.Lambda.KinesisEvents" />
         <PackageReference Include="Amazon.Lambda.SQSEvents" />
-        <ProjectReference Include="..\AWS.Lambda.Powertools.Common\AWS.Lambda.Powertools.Common.csproj" Condition="'$(Configuration)'=='Debug'"/>
+        <ProjectReference Include="..\AWS.Lambda.Powertools.Common\AWS.Lambda.Powertools.Common.csproj"/>
     </ItemGroup>
 </Project>

libraries/src/AWS.Lambda.Powertools.BatchProcessing/AWS.Lambda.Powertools.BatchProcessing.csproj

@@ -14,18 +14,67 @@
  */
 
 using System;
+using System.IO;
 
 namespace AWS.Lambda.Powertools.Common;
 
 /// <inheritdoc />
 public class ConsoleWrapper : IConsoleWrapper
 {
+    private static bool _override;
+
     /// <inheritdoc />
-    public void WriteLine(string message) => Console.WriteLine(message);
-    /// <inheritdoc />
-    public void Debug(string message) => System.Diagnostics.Debug.WriteLine(message);
+    public void WriteLine(string message)
+    {
+        OverrideLambdaLogger();
+        Console.WriteLine(message);
+    }
+
     /// <inheritdoc />
-    public void Error(string message) => Console.Error.WriteLine(message);
+    public void Debug(string message)
+    {
+        OverrideLambdaLogger();
+        System.Diagnostics.Debug.WriteLine(message);
+    }
+
     /// <inheritdoc />
-    public string ReadLine() => Console.ReadLine();
+    public void Error(string message)
+    {
+        if (!_override)
+        {
+            var errordOutput = new StreamWriter(Console.OpenStandardError());
+            errordOutput.AutoFlush = true;
+            Console.SetError(errordOutput);
+        }
+
+        Console.Error.WriteLine(message);
+    }
+
+    internal static void SetOut(StringWriter consoleOut)
+    {
+        _override = true;
+        Console.SetOut(consoleOut);
+    }
+    
+    private void OverrideLambdaLogger()
+    {
+        if (_override)
+        {
+            return;
+        }
+        // Force override of LambdaLogger
+        var standardOutput = new StreamWriter(Console.OpenStandardOutput());
+        standardOutput.AutoFlush = true;
+        Console.SetOut(standardOutput);
+    }
+    
+    internal static void WriteLine(string logLevel, string message)
+    {
+        Console.WriteLine($"{DateTime.UtcNow:yyyy-MM-ddTHH:mm:ss.fffZ}\t{logLevel}\t{message}");
+    }
+
+    public static void ResetForTest()
+    {
+        _override = false;
+    }
 }

libraries/src/AWS.Lambda.Powertools.Common/Core/ConsoleWrapper.cs

@@ -37,10 +37,4 @@ public interface IConsoleWrapper
     /// </summary>
     /// <param name="message">The error message to write.</param>
     void Error(string message);
-
-    /// <summary>
-    /// Reads the next line of characters from the standard input stream.
-    /// </summary>
-    /// <returns>The next line of characters from the input stream, or null if no more lines are available.</returns>
-    string ReadLine();
 }

libraries/src/AWS.Lambda.Powertools.Common/Core/IConsoleWrapper.cs

@@ -34,4 +34,10 @@ public interface IPowertoolsEnvironment
     /// <typeparam name="T"></typeparam>
     /// <returns>Assembly Version in the Major.Minor.Build format</returns>
     string GetAssemblyVersion<T>(T type);
+    
+    /// <summary>
+    /// Sets the execution Environment Variable (AWS_EXECUTION_ENV)
+    /// </summary>
+    /// <param name="type"></param>
+    void SetExecutionEnvironment<T>(T type);
 }

libraries/src/AWS.Lambda.Powertools.Common/Core/IPowertoolsEnvironment.cs

@@ -1,12 +1,12 @@
 /*
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License").
  * You may not use this file except in compliance with the License.
  * A copy of the License is located at
- * 
+ *
  *  http://aws.amazon.com/apache2.0
- * 
+ *
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
@@ -25,6 +25,8 @@ namespace AWS.Lambda.Powertools.Common;
 /// <seealso cref="IPowertoolsConfigurations" />
 public class PowertoolsConfigurations : IPowertoolsConfigurations
 {
+    private readonly IPowertoolsEnvironment _powertoolsEnvironment;
+
     /// <summary>
     ///     The maximum dimensions
     /// </summary>
@@ -40,26 +42,21 @@ public class PowertoolsConfigurations : IPowertoolsConfigurations
     /// </summary>
     private static IPowertoolsConfigurations _instance;
 
-    /// <summary>
-    ///     The system wrapper
-    /// </summary>
-    private readonly ISystemWrapper _systemWrapper;
-
     /// <summary>
     ///     Initializes a new instance of the <see cref="PowertoolsConfigurations" /> class.
     /// </summary>
-    /// <param name="systemWrapper">The system wrapper.</param>
-    internal PowertoolsConfigurations(ISystemWrapper systemWrapper)
+    /// <param name="powertoolsEnvironment"></param>
+    internal PowertoolsConfigurations(IPowertoolsEnvironment powertoolsEnvironment)
     {
-        _systemWrapper = systemWrapper;
+        _powertoolsEnvironment = powertoolsEnvironment;
     }
 
     /// <summary>
     ///     Gets the instance.
     /// </summary>
     /// <value>The instance.</value>
     public static IPowertoolsConfigurations Instance =>
-        _instance ??= new PowertoolsConfigurations(SystemWrapper.Instance);
+        _instance ??= new PowertoolsConfigurations(PowertoolsEnvironment.Instance);
 
     /// <summary>
     ///     Gets the environment variable.
@@ -68,7 +65,7 @@ internal PowertoolsConfigurations(ISystemWrapper systemWrapper)
     /// <returns>System.String.</returns>
     public string GetEnvironmentVariable(string variable)
     {
-        return _systemWrapper.GetEnvironmentVariable(variable);
+        return _powertoolsEnvironment.GetEnvironmentVariable(variable);
     }
 
     /// <summary>
@@ -79,7 +76,7 @@ public string GetEnvironmentVariable(string variable)
     /// <returns>System.String.</returns>
     public string GetEnvironmentVariableOrDefault(string variable, string defaultValue)
     {
-        var result = _systemWrapper.GetEnvironmentVariable(variable);
+        var result = _powertoolsEnvironment.GetEnvironmentVariable(variable);
         return string.IsNullOrWhiteSpace(result) ? defaultValue : result;
     }
 
@@ -91,7 +88,7 @@ public string GetEnvironmentVariableOrDefault(string variable, string defaultVal
     /// <returns>System.Int32.</returns>
     public int GetEnvironmentVariableOrDefault(string variable, int defaultValue)
     {
-        var result = _systemWrapper.GetEnvironmentVariable(variable);
+        var result = _powertoolsEnvironment.GetEnvironmentVariable(variable);
         return int.TryParse(result, out var parsedValue) ? parsedValue : defaultValue;
     }
 
@@ -103,7 +100,7 @@ public int GetEnvironmentVariableOrDefault(string variable, int defaultValue)
     /// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
     public bool GetEnvironmentVariableOrDefault(string variable, bool defaultValue)
     {
-        return bool.TryParse(_systemWrapper.GetEnvironmentVariable(variable), out var result)
+        return bool.TryParse(_powertoolsEnvironment.GetEnvironmentVariable(variable), out var result)
             ? result
             : defaultValue;
     }
@@ -161,7 +158,8 @@ public bool GetEnvironmentVariableOrDefault(string variable, bool defaultValue)
     /// </summary>
     /// <value>The logger sample rate.</value>
     public double LoggerSampleRate =>
-        double.TryParse(_systemWrapper.GetEnvironmentVariable(Constants.LoggerSampleRateNameEnv), NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture,  out var result)
+        double.TryParse(_powertoolsEnvironment.GetEnvironmentVariable(Constants.LoggerSampleRateNameEnv),
+            NumberStyles.AllowDecimalPoint, CultureInfo.InvariantCulture, out var result)
             ? result
             : 0;
 
@@ -191,7 +189,7 @@ public bool GetEnvironmentVariableOrDefault(string variable, bool defaultValue)
     /// </summary>
     /// <value><c>true</c> if this instance is Lambda; otherwise, <c>false</c>.</value>
     public bool IsLambdaEnvironment => GetEnvironmentVariable(Constants.LambdaTaskRoot) is not null;
-    
+
     /// <summary>
     ///     Gets a value indicating whether [tracing is disabled].
     /// </summary>
@@ -202,28 +200,32 @@ public bool GetEnvironmentVariableOrDefault(string variable, bool defaultValue)
     /// <inheritdoc />
     public void SetExecutionEnvironment<T>(T type)
     {
-        _systemWrapper.SetExecutionEnvironment(type);
+        _powertoolsEnvironment.SetExecutionEnvironment(type);
     }
 
     /// <inheritdoc />
     public bool IdempotencyDisabled =>
         GetEnvironmentVariableOrDefault(Constants.IdempotencyDisabledEnv, false);
 
     /// <inheritdoc />
-    public string BatchProcessingErrorHandlingPolicy => GetEnvironmentVariableOrDefault(Constants.BatchErrorHandlingPolicyEnv, "DeriveFromEvent");
+    public string BatchProcessingErrorHandlingPolicy =>
+        GetEnvironmentVariableOrDefault(Constants.BatchErrorHandlingPolicyEnv, "DeriveFromEvent");
 
     /// <inheritdoc />
-    public bool BatchParallelProcessingEnabled => GetEnvironmentVariableOrDefault(Constants.BatchParallelProcessingEnabled, false);
+    public bool BatchParallelProcessingEnabled =>
+        GetEnvironmentVariableOrDefault(Constants.BatchParallelProcessingEnabled, false);
 
     /// <inheritdoc />
-    public int BatchProcessingMaxDegreeOfParallelism => GetEnvironmentVariableOrDefault(Constants.BatchMaxDegreeOfParallelismEnv, 1);
+    public int BatchProcessingMaxDegreeOfParallelism =>
+        GetEnvironmentVariableOrDefault(Constants.BatchMaxDegreeOfParallelismEnv, 1);
 
     /// <inheritdoc />
-    public bool BatchThrowOnFullBatchFailureEnabled => GetEnvironmentVariableOrDefault(Constants.BatchThrowOnFullBatchFailureEnv, true);
+    public bool BatchThrowOnFullBatchFailureEnabled =>
+        GetEnvironmentVariableOrDefault(Constants.BatchThrowOnFullBatchFailureEnv, true);
 
     /// <inheritdoc />
     public bool MetricsDisabled => GetEnvironmentVariableOrDefault(Constants.PowertoolsMetricsDisabledEnv, false);
-    
+
     /// <inheritdoc />
     public bool IsColdStart => LambdaLifecycleTracker.IsColdStart;
 

libraries/src/AWS.Lambda.Powertools.Common/Core/PowertoolsConfigurations.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Text;
 
 namespace AWS.Lambda.Powertools.Common;
 
@@ -40,4 +41,52 @@ public string GetAssemblyVersion<T>(T type)
         var version = type.GetType().Assembly.GetName().Version;
         return version != null ? $"{version.Major}.{version.Minor}.{version.Build}" : string.Empty;
     }
+    
+    /// <inheritdoc />
+    public void SetExecutionEnvironment<T>(T type)
+    {
+        const string envName = Constants.AwsExecutionEnvironmentVariableName;
+        var envValue = new StringBuilder();
+        var currentEnvValue = GetEnvironmentVariable(envName);
+        var assemblyName = ParseAssemblyName(GetAssemblyName(type));
+
+        // If there is an existing execution environment variable add the annotations package as a suffix.
+        if (!string.IsNullOrEmpty(currentEnvValue))
+        {
+            // Avoid duplication - should not happen since the calling Instances are Singletons - defensive purposes
+            if (currentEnvValue.Contains(assemblyName))
+            {
+                return;
+            }
+
+            envValue.Append($"{currentEnvValue} ");
+        }
+
+        var assemblyVersion = GetAssemblyVersion(type);
+
+        envValue.Append($"{assemblyName}/{assemblyVersion}");
+
+        SetEnvironmentVariable(envName, envValue.ToString());
+    }
+    
+    /// <summary>
+    /// Parsing the name to conform with the required naming convention for the UserAgent header (PTFeature/Name/Version)
+    /// Fallback to Assembly Name on exception
+    /// </summary>
+    /// <param name="assemblyName"></param>
+    /// <returns></returns>
+    private string ParseAssemblyName(string assemblyName)
+    {
+        try
+        {
+            var parsedName = assemblyName.Substring(assemblyName.LastIndexOf(".", StringComparison.Ordinal) + 1);
+            return $"{Constants.FeatureContextIdentifier}/{parsedName}";
+        }
+        catch
+        {
+            //NOOP
+        }
+
+        return $"{Constants.FeatureContextIdentifier}/{assemblyName}";
+    }
 }