introduce ModuleLoggerAspectAttribute & ServiceLoggerAspectAttribute

Sholtee · Jul 12, 2021 · 014a36c · 014a36c
1 parent 6f40c1b
commit 014a36c
Show file tree

Hide file tree

Showing 10 changed files with 82 additions and 15 deletions.
diff --git a/SRC/RPC.Interfaces/Attributes/Aspects/Logging/LoggerAspectAttribute.cs b/SRC/RPC.Interfaces/Attributes/Aspects/Logging/LoggerAspectAttribute.cs
@@ -16,7 +16,8 @@ namespace Solti.Utils.Rpc.Interfaces
     /// Marks a module or service to be logged.
     /// </summary>
     [AttributeUsage(AttributeTargets.Interface, AllowMultiple = false)]
-    public sealed class LoggerAspectAttribute: AspectAttribute
+    [SuppressMessage("Performance", "CA1813:Avoid unsealed attributes")]
+    public class LoggerAspectAttribute: AspectAttribute
     {
         /// <summary>
         /// Creates a new <see cref="LoggerAspectAttribute"/> instance.
@@ -30,13 +31,7 @@ public sealed class LoggerAspectAttribute: AspectAttribute
         /// <summary>
         /// Creates a new <see cref="LoggerAspectAttribute"/> instance.
         /// </summary>
-        public LoggerAspectAttribute() => DefaultLoggers = new LoggerBase[]
-        {
-            new ModuleMethodScopeLogger(),         
-            new ExceptionLogger(),
-            new ParameterLogger(),
-            new StopWatchLogger()
-        };
+        public LoggerAspectAttribute(): this(Array.Empty<Type>()) { }
 
         /// <summary>
         /// The default loggers. This value can be overridden per methods by the <see cref="LoggersAttribute"/>. 

diff --git a/SRC/RPC.Interfaces/Attributes/Aspects/Logging/ModuleLoggerAspectAttribute.cs b/SRC/RPC.Interfaces/Attributes/Aspects/Logging/ModuleLoggerAspectAttribute.cs
@@ -0,0 +1,21 @@
+/********************************************************************************
+* ModuleLoggerAspectAttribute.cs                                                *
+*                                                                               *
+* Author: Denes Solti                                                           *
+********************************************************************************/
+using System;
+
+namespace Solti.Utils.Rpc.Interfaces
+{
+    /// <summary>
+    /// Marks a module to be logged.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Interface, AllowMultiple = false)]
+    public sealed class ModuleLoggerAspectAttribute: LoggerAspectAttribute
+    {
+        /// <summary>
+        /// Creates a new <see cref="ModuleLoggerAspectAttribute"/> instance.
+        /// </summary>
+        public ModuleLoggerAspectAttribute() : base(typeof(ModuleMethodScopeLogger), typeof(ExceptionLogger), typeof(ParameterLogger), typeof(StopWatchLogger)) { }
+    }
+}
diff --git a/SRC/RPC.Interfaces/Attributes/Aspects/Logging/ServiceLoggerAspectAttribute.cs b/SRC/RPC.Interfaces/Attributes/Aspects/Logging/ServiceLoggerAspectAttribute.cs
@@ -0,0 +1,21 @@
+/********************************************************************************
+* ServiceLoggerAspectAttribute.cs                                               *
+*                                                                               *
+* Author: Denes Solti                                                           *
+********************************************************************************/
+using System;
+
+namespace Solti.Utils.Rpc.Interfaces
+{
+    /// <summary>
+    /// Marks a service to be logged.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Interface, AllowMultiple = false)]
+    public sealed class ServiceLoggerAspectAttribute: LoggerAspectAttribute
+    {
+        /// <summary>
+        /// Creates a new <see cref="ServiceLoggerAspectAttribute"/> instance.
+        /// </summary>
+        public ServiceLoggerAspectAttribute() : base(typeof(ServiceMethodScopeLogger), typeof(ExceptionLogger), typeof(ParameterLogger)) { }
+    }
+}
diff --git a/SRC/RPC.Interfaces/Loggers/ExceptionLogger.cs b/SRC/RPC.Interfaces/Loggers/ExceptionLogger.cs
@@ -1,5 +1,5 @@
 /********************************************************************************
-* LoggerBase.cs                                                                 *
+* ExceptionLogger.cs                                                            *
 *                                                                               *
 * Author: Denes Solti                                                           *
 ********************************************************************************/

diff --git a/SRC/RPC.Interfaces/Loggers/ModuleMethodScopeLogger.cs b/SRC/RPC.Interfaces/Loggers/ModuleMethodScopeLogger.cs
@@ -1,5 +1,5 @@
 /********************************************************************************
-* LoggerBase.cs                                                                 *
+* ModuleMethodScopeLogger.cs                                                    *
 *                                                                               *
 * Author: Denes Solti                                                           *
 ********************************************************************************/
@@ -14,7 +14,7 @@ namespace Solti.Utils.Rpc.Interfaces
     /// Creates a new log scope containing the module and method name and the session id.
     /// </summary>
     /// <remarks>This logger is intended to be used on modules only.</remarks>
-    public sealed class ModuleMethodScopeLogger : LoggerBase
+    public sealed class ModuleMethodScopeLogger: LoggerBase
     {
         /// <inheritdoc/>
         public override object? Invoke(LogContext context, Func<object?> callNext)
@@ -26,6 +26,7 @@ public sealed class ModuleMethodScopeLogger : LoggerBase
                 [nameof(cntx.Module)]    = cntx.Module,
                 [nameof(cntx.Method)]    = cntx.Method,
                 [nameof(cntx.SessionId)] = cntx.SessionId ?? "NULL"
+                // TODO: modul nev
             });
 
             return callNext();

diff --git a/SRC/RPC.Interfaces/Loggers/ParameterLogger.cs b/SRC/RPC.Interfaces/Loggers/ParameterLogger.cs
@@ -1,5 +1,5 @@
 /********************************************************************************
-* LoggerBase.cs                                                                 *
+* ParameterLogger.cs                                                            *
 *                                                                               *
 * Author: Denes Solti                                                           *
 ********************************************************************************/

diff --git a/SRC/RPC.Interfaces/Loggers/ServiceMethodScopeLogger.cs b/SRC/RPC.Interfaces/Loggers/ServiceMethodScopeLogger.cs
@@ -0,0 +1,29 @@
+/********************************************************************************
+* ServiceMethodScopeLogger.cs                                                   *
+*                                                                               *
+* Author: Denes Solti                                                           *
+********************************************************************************/
+using System;
+using System.Collections.Generic;
+
+namespace Solti.Utils.Rpc.Interfaces
+{
+    /// <summary>
+    /// Creates a new log scope containing the service and method name.
+    /// </summary>
+    public sealed class ServiceMethodScopeLogger: LoggerBase
+    {
+        /// <inheritdoc/>
+        public override object? Invoke(LogContext context, Func<object?> callNext)
+        {
+            using IDisposable? logScope = context.Logger.BeginScope(new Dictionary<string, object>
+            {
+                ["Service"] = context.Method.ReflectedType,
+                ["Method"] = context.Method
+                // TODO: szerviz nev
+            });
+
+            return callNext();
+        }
+    }
+}
diff --git a/SRC/RPC.Interfaces/Loggers/StopWatchLogger.cs b/SRC/RPC.Interfaces/Loggers/StopWatchLogger.cs
@@ -1,5 +1,5 @@
 /********************************************************************************
-* LoggerBase.cs                                                                 *
+* StopWatchLogger.cs                                                            *
 *                                                                               *
 * Author: Denes Solti                                                           *
 ********************************************************************************/

diff --git a/TEST/RPC.Server.Sample.Interfaces/ICalculator.cs b/TEST/RPC.Server.Sample.Interfaces/ICalculator.cs
@@ -9,7 +9,7 @@ namespace Solti.Utils.Rpc.Server.Sample.Interfaces
 {
     using Rpc.Interfaces;
 
-    [LoggerAspect]
+    [ModuleLoggerAspect]
     [ParameterValidatorAspect]
     public interface ICalculator
     {

diff --git a/TEST/RPC.Tests/Aspects/LoggerTests.cs b/TEST/RPC.Tests/Aspects/LoggerTests.cs
@@ -21,7 +21,7 @@ namespace Solti.Utils.Rpc.Aspects.Tests
     [TestFixture]
     public class LoggerTests
     {
-        [LoggerAspect]
+        [ModuleLoggerAspect]
         public interface IModule
         {
             void DoSomething(string arg1, object arg2);