Merge pull request #649 from hjgraca/(docs)-update-logging-aot

hjgraca · web-flow · commit 434add6d712a · 2024-09-24T11:38:15.000+01:00
chore: update logging aot docs
diff --git a/docs/core/logging.md b/docs/core/logging.md
@@ -670,22 +670,19 @@ You can customize the structure (keys and values) of your log entries by impleme
 
 ## AOT Support
 
-Logging utility supports native AOT serialization by default without any changes needed.
-
 !!! info
     
-    In case you want to use the `LogEvent`, `Custom Log Formatter` features or serialize your own types when Logging events it is required 
-    that you do some changes in your Lambda `Main` method.
+    If you want to use the `LogEvent`, `Custom Log Formatter` features, or serialize your own types when Logging events, you need to make changes in your Lambda `Main` method.
 
 !!! info
 
-    Starting from version 1.6.0 it is required to update `Amazon.Lambda.Serialization.SystemTextJson` to `version 2.4.3` in your `csproj`.
+    Starting from version 1.6.0, it is required to update the Amazon.Lambda.Serialization.SystemTextJson NuGet package to version 2.4.3 in your csproj.
 
 ### Configure
 
-The change needed is to replace `SourceGeneratorLambdaJsonSerializer` with `PowertoolsSourceGeneratorSerializer`. 
+Replace `SourceGeneratorLambdaJsonSerializer` with `PowertoolsSourceGeneratorSerializer`.
 
-This change enables Powertools to construct an instance of JsonSerializerOptions that is used to customize the serialization and deserialization of the Lambda JSON events and your own types.
+This change enables Powertools to construct an instance of `JsonSerializerOptions` used to customize the serialization and deserialization of Lambda JSON events and your own types.
 
 === "Before"
 
@@ -726,13 +723,11 @@ public partial class MyCustomJsonSerializerContext : JsonSerializerContext
 }
 ```
 
-When you change to `PowertoolsSourceGeneratorSerializer<MyCustomJsonSerializerContext>` we are 
-combining your `JsonSerializerContext` types with Powertools `JsonSerializerContext`. This allows Powertools to serialize your types and Lambda events.
+When you update your code to use `PowertoolsSourceGeneratorSerializer<MyCustomJsonSerializerContext>`, we combine your `JsonSerializerContext` with Powertools' `JsonSerializerContext`. This allows Powertools to serialize your types and Lambda events.
 
 ### Custom Log Formatter
 
-To be able to use a custom log formatter with AOT we need to pass an instance of ` ILogFormatter` to `PowertoolsSourceGeneratorSerializer` 
-instead of using the static `Logger.UseFormatter` in the Function contructor.
+To use a custom log formatter with AOT, pass an instance of `ILogFormatter` to `PowertoolsSourceGeneratorSerializer` instead of using the static `Logger.UseFormatter` in the Function constructor as you do in non-AOT Lambdas.
 
 === "Function Main method"
 
@@ -790,8 +785,7 @@ instead of using the static `Logger.UseFormatter` in the Function contructor.
 ### Anonymous types
 
 !!! note
-    
-    Although we support anonymous type serialization by converting to a `Dictionary<string, object>`, 
-    this is not a best practice and is not recommendede when using native AOT. 
 
-    Recommendation is to use concrete classes and add them to your `JsonSerializerContext`.
+    While we support anonymous type serialization by converting to a `Dictionary<string, object>`, this is **not** a best practice and is **not recommended** when using native AOT. 
+    
+    We recommend using concrete classes and adding them to your `JsonSerializerContext`.
diff --git a/examples/BatchProcessing/src/HelloWorld/HelloWorld.csproj b/examples/BatchProcessing/src/HelloWorld/HelloWorld.csproj
@@ -6,7 +6,7 @@
     </PropertyGroup>
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
         <PackageReference Include="AWS.Lambda.Powertools.BatchProcessing" Version="1.1.2" />
         <PackageReference Include="AWS.Lambda.Powertools.Logging" Version="1.5.1" />
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
diff --git a/examples/BatchProcessing/test/HelloWorld.Test/HelloWorld.Tests.csproj b/examples/BatchProcessing/test/HelloWorld.Test/HelloWorld.Tests.csproj
@@ -8,7 +8,7 @@
 		<PackageReference Include="Amazon.Lambda.KinesisEvents" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.SQSEvents" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
 		<PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
 		<PackageReference Include="AWSSDK.SQS" Version="3.7.300.54" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
diff --git a/examples/Idempotency/src/HelloWorld/HelloWorld.csproj b/examples/Idempotency/src/HelloWorld/HelloWorld.csproj
@@ -7,7 +7,7 @@
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
         <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
         <PackageReference Include="AWS.Lambda.Powertools.Idempotency" Version="1.2.2" />
         <PackageReference Include="AWS.Lambda.Powertools.Logging" Version="1.5.1" />
     </ItemGroup>
diff --git a/examples/Idempotency/test/HelloWorld.Test/HelloWorld.Tests.csproj b/examples/Idempotency/test/HelloWorld.Test/HelloWorld.Tests.csproj
@@ -5,7 +5,7 @@
 	<ItemGroup>
 		<PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="xunit" Version="2.7.0" />
 		<PackageReference Include="Testcontainers" Version="3.7.0" />
diff --git a/examples/Logging/src/HelloWorld/HelloWorld.csproj b/examples/Logging/src/HelloWorld/HelloWorld.csproj
@@ -7,7 +7,7 @@
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
         <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
         <PackageReference Include="AWS.Lambda.Powertools.Logging" Version="1.5.1" />
         <PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
     </ItemGroup>
diff --git a/examples/Logging/test/HelloWorld.Test/HelloWorld.Tests.csproj b/examples/Logging/test/HelloWorld.Test/HelloWorld.Tests.csproj
@@ -5,7 +5,7 @@
 	<ItemGroup>
 		<PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
 		<PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NSubstitute" Version="5.1.0" />
diff --git a/examples/Metrics/src/HelloWorld/HelloWorld.csproj b/examples/Metrics/src/HelloWorld/HelloWorld.csproj
@@ -7,7 +7,7 @@
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
         <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
         <PackageReference Include="AWS.Lambda.Powertools.Logging" Version="1.5.1" />
         <PackageReference Include="AWS.Lambda.Powertools.Metrics" Version="1.7.1" />
         <PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
diff --git a/examples/Metrics/test/HelloWorld.Test/HelloWorld.Tests.csproj b/examples/Metrics/test/HelloWorld.Test/HelloWorld.Tests.csproj
@@ -5,7 +5,7 @@
 	<ItemGroup>
 		<PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
 		<PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NSubstitute" Version="5.1.0" />
diff --git a/examples/Parameters/cfn/HelloWorld.Cfn/HelloWorld.Cfn.csproj b/examples/Parameters/cfn/HelloWorld.Cfn/HelloWorld.Cfn.csproj
@@ -7,7 +7,7 @@
     </PropertyGroup>
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
     </ItemGroup>
     <ItemGroup>
       <ProjectReference Include="..\..\src\HelloWorld\HelloWorld.csproj" />
diff --git a/examples/Parameters/src/HelloWorld/HelloWorld.csproj b/examples/Parameters/src/HelloWorld/HelloWorld.csproj
@@ -7,7 +7,7 @@
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
         <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
         <PackageReference Include="AWS.Lambda.Powertools.Parameters" Version="1.2.0" />
     </ItemGroup>
 </Project>
diff --git a/examples/Parameters/test/HelloWorld.Test/HelloWorld.Tests.csproj b/examples/Parameters/test/HelloWorld.Test/HelloWorld.Tests.csproj
@@ -5,7 +5,7 @@
 	<ItemGroup>
 		<PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NSubstitute" Version="5.1.0" />
 		<PackageReference Include="xunit" Version="2.7.0" />
diff --git a/examples/Tracing/src/HelloWorld/HelloWorld.csproj b/examples/Tracing/src/HelloWorld/HelloWorld.csproj
@@ -7,7 +7,7 @@
     <ItemGroup>
         <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
         <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.0" />
-        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+        <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
         <PackageReference Include="AWS.Lambda.Powertools.Logging" Version="1.5.1" />
         <PackageReference Include="AWS.Lambda.Powertools.Tracing" Version="1.5.1" />
         <PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
diff --git a/examples/Tracing/test/HelloWorld.Test/HelloWorld.Tests.csproj b/examples/Tracing/test/HelloWorld.Test/HelloWorld.Tests.csproj
@@ -5,7 +5,7 @@
 	<ItemGroup>
 		<PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
 		<PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
-		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.1" />
+		<PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.3" />
 		<PackageReference Include="AWSSDK.DynamoDBv2" Version="3.7.301.18" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="NSubstitute" Version="5.1.0" />
diff --git a/libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Formatter/LogFormatterTest.cs b/libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Formatter/LogFormatterTest.cs
@@ -203,8 +203,8 @@ public void Should_Log_CustomFormatter_When_Decorated()
 #if NET8_0_OR_GREATER
             consoleOut.Received(1).WriteLine(
                 Arg.Is<string>(i =>
-                    i ==
-                    "{\"message\":\"test\",\"service\":\"my_service\",\"correlation_ids\":{\"aws_request_id\":\"requestId\"},\"lambda_function\":{\"name\":\"funtionName\",\"arn\":\"function::arn\",\"memory_limit_in_mb\":128,\"version\":\"version\",\"cold_start\":true},\"level\":\"Information\",\"timestamp\":\"2024-01-01T00:00:00.0000000\",\"logger\":{\"name\":\"AWS.Lambda.Powertools.Logging.Logger\",\"sample_rate\":0.2}}")
+                    i.Contains(
+                    "\"correlation_ids\":{\"aws_request_id\":\"requestId\"},\"lambda_function\":{\"name\":\"funtionName\",\"arn\":\"function::arn\",\"memory_limit_in_mb\":128,\"version\":\"version\",\"cold_start\":true},\"level\":\"Information\""))
             );
 #else
             consoleOut.Received(1).WriteLine(
