Update and documentation of PostSharp.Samples.Logging.ElasticStack.

Author: gfraiteur

Diagnostics/PostSharp.Samples.Logging.ElasticStack/ClientExample/ClientExample.csproj

@@ -20,8 +20,8 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(Configuration)'!='Development'">
-    <PackageReference Include="PostSharp.Patterns.Diagnostics" Version="6.1.6-preview" />
-    <PackageReference Include="PostSharp.Patterns.Diagnostics.Serilog" Version="6.1.6-preview" />
+    <PackageReference Include="PostSharp.Patterns.Diagnostics" Version="6.1.18" />
+    <PackageReference Include="PostSharp.Patterns.Diagnostics.Serilog" Version="6.1.18" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(Configuration)'=='Development'">

Diagnostics/PostSharp.Samples.Logging.ElasticStack/ClientExample/README.md

@@ -0,0 +1,9 @@
+# PostSharp.Samples.Logging.ElasticStack: ClientExample
+
+This is the client side of the PostSharp.Samples.Logging.ElasticStack example.
+
+The *InstrumentOutgoingRequestsAspect* aspect is the most interesting part of this project. It instruments the HttpClient class. It basically does three things:
+
+* Open a client-side activity (aka context), which emits log client-side records into Elastic Search.
+* Set the `Request-Id` header of the outgoing HTTP request to the `SyntheticId` of the newly created activity.
+* Set the `Correlation-Context` header ot the outgoing HTTP request to the baggage (i.e. cross-process properties). In this example, we've set a cross-process property named `User` in `Program.Main`.

Diagnostics/PostSharp.Samples.Logging.ElasticStack/MicroserviceExample/MicroserviceExample.csproj

@@ -16,7 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.App" Version="2.1" />
+    <PackageReference Include="Microsoft.AspNetCore.App" />
     <PackageReference Include="Serilog.AspNetCore" Version="2.1.1" />
     <PackageReference Include="Serilog.Sinks.Async" Version="1.3.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
@@ -25,8 +25,8 @@
 
 
   <ItemGroup Condition="'$(Configuration)'!='Development'">
-    <PackageReference Include="PostSharp.Patterns.Diagnostics" Version="6.1.6-preview" />
-    <PackageReference Include="PostSharp.Patterns.Diagnostics.Serilog" Version="6.1.6-preview" />
+    <PackageReference Include="PostSharp.Patterns.Diagnostics" Version="6.1.18" />
+    <PackageReference Include="PostSharp.Patterns.Diagnostics.Serilog" Version="6.1.18" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(Configuration)'=='Development'">

Diagnostics/PostSharp.Samples.Logging.ElasticStack/MicroserviceExample/Program.cs

@@ -41,8 +41,9 @@ public static void Main( string[] args )
                 LoggingServices.Formatters.Register(new ActionResultFormatter());
                 LoggingServices.Formatters.Register(new ObjectResultFormatter());
 
-                // SampledLoggingFilter.Initialize(backend);
-                // LoggingServices.DefaultBackend.DefaultVerbosity.SetMinimalLevel(LogLevel.Warning);
+                // Log only warnings by default, except for 10% randomly chosen requests.
+                SampledLoggingActionFilter.Initialize(backend);
+                LoggingServices.DefaultBackend.DefaultVerbosity.SetMinimalLevel(LogLevel.Warning);
 
 
 

Diagnostics/PostSharp.Samples.Logging.ElasticStack/MicroserviceExample/README.md

@@ -0,0 +1,12 @@
+# PostSharp.Samples.Logging.ElasticStack: MicroserviceExample
+
+This is the server side of the PostSharp.Samples.Logging.ElasticStack example.
+
+There are two interesting artifacts in this project:
+
+* *LoggingActionFilter* is an ASP.NET Action Filter, i.e. it runs before the control flow is given to your code in the controller classes. This action filter does the "opposite" of the *InstrumentOutgoingRequestsAspect* server-side aspect, i.e. it creates a new server-side logging activity (aka context) and assigns:
+
+    * the `SyntheticParentId` property to the value of the `Request-Id` HTTP header sent by the client, and
+    * custom properties based on the parsing of the `Correlation-Context` HTTP header. 
+
+* *SampledLoggingActionFilter* is another ASP.NET Action Filter which enables logging for a random 10% subset of incoming requests. The default level, for the remaining 90% of requests, is set to Warning in `Program.Main`.

Diagnostics/PostSharp.Samples.Logging.ElasticStack/MicroserviceExample/SampledLoggingActionFilter.cs

@@ -14,6 +14,7 @@ public class SampledLoggingActionFilter : IAsyncActionFilter
         public static void Initialize( LoggingBackend backend )
         {
             verbosityManager = backend.CreateVerbosityConfiguration();
+            // Verbosity is High (Debug level) by default.
         }
 
         public static bool IsInitialized => verbosityManager != null;

PostSharp.Samples.sln

@@ -37,6 +37,9 @@ or you can download them on [GitHub](https://www.github.com/postsharp/PostSharp.
 | [PostSharp.Samples.Logging.CustomBackend.ServiceStack](Diagnostics/PostSharp.Samples.Logging.CustomBackend.ServiceStack/)  | Demonstrates how to implement a PostSharp Logging adapter for your custom logging framework.   | 
 | [PostSharp.Samples.Logging.Audit](Diagnostics/PostSharp.Samples.Audit/)  | Shows how to append an audit record to a database when a method is invoked.   |
 | [PostSharp.Samples.Logging.Audit.Extended](Diagnostics/PostSharp.Samples.Audit.Extended/)  | Shows how to add custom pieces of information to the audit record.   | 
+| **Distributed Diagnostics with Elastic Search**                 
+| [PostSharp.Samples.Logging.ElasticStack/MicroserviceExample](Diagnostics/PostSharp.Samples.Logging.ElasticStack/MicroserviceExample/)                 |  The server-side service demonstrating correlation of logs of a distributed application with Elastic Search. | 
+| [PostSharp.Samples.Logging.ElasticStack/ClientExample](Diagnostics/PostSharp.Samples.Logging.ElasticStack/ClientExample/)                 |  The server-side service demonstrating correlation of logs of a distributed application with Elastic Search.  | 
 | **XAML**                 
 | [PostSharp.Samples.Xaml](Xaml/PostSharp.Samples.Xaml/)                                              | Demonstrates a few ready-made aspects that are useful for XAML                               | 
 | **Caching**