Add additional message definitions

and refactor class hierarchy

Author: jbarden

src/AStar.Dev.Logging.Extensions/AStar.Dev.Logging.Extensions.csproj

@@ -19,14 +19,14 @@
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
         <PackageProjectUrl>https://github.com/astar-development/astar-dev-logging-extensions</PackageProjectUrl>
         <PackageReadmeFile>README.md</PackageReadmeFile>
-        <PackageReleaseNotes>Add LoggerMessage.Define methods</PackageReleaseNotes>
+        <PackageReleaseNotes>Add more LoggerMessage.Define methods</PackageReleaseNotes>
         <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
         <RepositoryType>git</RepositoryType>
         <RepositoryUrl>https://github.com/astar-development/astar-dev-logging-extensions.git</RepositoryUrl>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <TargetFramework>net9.0</TargetFramework>
         <Title>AStar.Dev.Logging.Extensions</Title>
-        <Version>0.5.0</Version>
+        <Version>0.5.2</Version>
     </PropertyGroup>
 
 

src/AStar.Dev.Logging.Extensions/AStar.Dev.Logging.Extensions.xml

@@ -12,5 +12,9 @@ internal static class AStarEventIdList
     public static readonly EventId HealthCheckStart   = new (2_000, "HealthCheck - Start");
     public static readonly EventId HealthCheckSuccess = new (2_001, "HealthCheck - Success");
     public static readonly EventId HealthCheckWarning = new (2_002, "HealthCheck - Warning");
-    public static readonly EventId HealthCheckFailure = new (2_002, "HealthCheck - Failure");
+    public static readonly EventId HealthCheckFailure = new (2_003, "HealthCheck - Failure");
+    public static readonly EventId ApiCallStart       = new (2_004, "ApiCall - Start");
+    public static readonly EventId ApiCallSuccess     = new (2_005, "ApiCall - Success");
+    public static readonly EventId ApiCallWarning     = new (2_006, "ApiCall - Warning");
+    public static readonly EventId ApiCallFailure     = new (2_007, "ApiCall - Failure");
 }

src/AStar.Dev.Logging.Extensions/AStarEventIdList.cs

@@ -4,35 +4,8 @@ namespace AStar.Dev.Logging.Extensions;
 ///     The <see cref="AStarEventIds" /> class contains the defined <see cref="Microsoft.Extensions.Logging.EventId" /> events available for logging
 ///     Stand-alone <see cref="Microsoft.Extensions.Logging.EventId" /> events can be defined but care should be taken to avoid reusing the values used here
 /// </summary>
-public static class AStarEventIds
+public static partial class AStarEventIds
 {
-    /// <summary>
-    ///     The <see cref="Ui" /> class defines, yep, the EventIds for logging UI-related errors
-    /// </summary>
-    public static class Ui
-    {
-        /// <summary>
-        ///     Gets the <see cref="EventId" /> preconfigured for logging a page view
-        /// </summary>
-        public static EventId PageView => AStarEventIdList.PageView;
-    }
-
-    /// <summary>
-    ///     The <see cref="Common" /> class defines, yep, the EventIds for logging Common (shared) errors
-    /// </summary>
-    public static class Common
-    {
-        /// <summary>
-        ///     Gets the <see cref="EventId" /> preconfigured for logging an error
-        /// </summary>
-        public static EventId ExceptionId => AStarEventIdList.Error;
-
-        /// <summary>
-        ///     Gets the <see cref="EventId" /> preconfigured for logging a critical error
-        /// </summary>
-        public static EventId CriticalEventId => AStarEventIdList.CriticalError;
-    }
-
     /// <summary>
     ///     The <see cref="Api" /> class defines, yep, the EventIds for logging API-related errors
     /// </summary>
@@ -57,5 +30,25 @@ public static class Api
         ///     Gets the <see cref="EventId" /> preconfigured for logging a HealthCheck failure
         /// </summary>
         public static EventId HealthCheckFailure =>  AStarEventIdList.HealthCheckFailure;
+
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging an API Call success
+        /// </summary>
+        public static EventId ApiCallStart =>  AStarEventIdList.ApiCallStart;
+
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging an API Call success
+        /// </summary>
+        public static EventId ApiCallSuccess =>  AStarEventIdList.ApiCallSuccess;
+
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging an API Call warning
+        /// </summary>
+        public static EventId ApiCallWarning =>  AStarEventIdList.ApiCallWarning;
+
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging an API Call failure
+        /// </summary>
+        public static EventId ApiCallFailure =>  AStarEventIdList.ApiCallFailure;
     }
 }

src/AStar.Dev.Logging.Extensions/AStarEventIds.cs

@@ -0,0 +1,24 @@
+namespace AStar.Dev.Logging.Extensions;
+
+/// <summary>
+///     The <see cref="AStarEventIds" /> class contains the defined <see cref="Microsoft.Extensions.Logging.EventId" /> events available for logging
+///     Stand-alone <see cref="Microsoft.Extensions.Logging.EventId" /> events can be defined but care should be taken to avoid reusing the values used here
+/// </summary>
+public static partial class AStarEventIds
+{
+    /// <summary>
+    ///     The <see cref="Common" /> class defines, yep, the EventIds for logging Common (shared) errors
+    /// </summary>
+    public static class Common
+    {
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging an error
+        /// </summary>
+        public static EventId ExceptionId => AStarEventIdList.Error;
+
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging a critical error
+        /// </summary>
+        public static EventId CriticalEventId => AStarEventIdList.CriticalError;
+    }
+}

src/AStar.Dev.Logging.Extensions/AStarEventIdsCommon.cs

@@ -0,0 +1,19 @@
+namespace AStar.Dev.Logging.Extensions;
+
+/// <summary>
+///     The <see cref="AStarEventIds" /> class contains the defined <see cref="Microsoft.Extensions.Logging.EventId" /> events available for logging
+///     Stand-alone <see cref="Microsoft.Extensions.Logging.EventId" /> events can be defined but care should be taken to avoid reusing the values used here
+/// </summary>
+public static partial class AStarEventIds
+{
+    /// <summary>
+    ///     The <see cref="Ui" /> class defines, yep, the EventIds for logging UI-related errors
+    /// </summary>
+    public static class Ui
+    {
+        /// <summary>
+        ///     Gets the <see cref="EventId" /> preconfigured for logging a page view
+        /// </summary>
+        public static EventId PageView => AStarEventIdList.PageView;
+    }
+}

src/AStar.Dev.Logging.Extensions/AStarEventIdsUi.cs

@@ -1,44 +1,61 @@
 namespace AStar.Dev.Logging.Extensions;
 
 /// <summary>
+/// The <see cref="AStarLogger{TCategoryName}"/> class supplies the currently supported, predefined, Log Messages.
+/// There is an additional <seealso cref="Log{TState}"/> method for any currently not implemented log message
 /// </summary>
-/// <param name="loggerMessageDefinitions"></param>
-/// <param name="logger"></param>
-/// <param name="telemetryClient"></param>
-/// <typeparam name="TCategoryName"></typeparam>
-public class AStarLogger<TCategoryName>(LoggerMessageDefinitions loggerMessageDefinitions, ILogger<TCategoryName> logger, IAStarTelemetryClient telemetryClient) : ILoggerAstar<TCategoryName>
+/// <param name="logger">The underlying instance of <see cref="ILogger{TCategoryName}"/> that will perform the actual logging</param>
+/// <param name="telemetryClient">An instance of the <see cref="IAStarTelemetryClient"/> to perform the Application Insights-specific logging (e.g.: Page View)</param>
+/// <typeparam name="TCategoryName">The Logging type</typeparam>
+public class AStarLogger<TCategoryName>(ILogger<TCategoryName> logger, IAStarTelemetryClient telemetryClient) : ILoggerAstar<TCategoryName>
 {
     /// <inheritdoc />
     public void LogPageView(string pageName)
     {
-        loggerMessageDefinitions.PageViewLogMessage(logger, pageName, null);
+        LoggerMessageDefinitionsUi.PageViewLogMessage(logger, pageName, null);
 
         telemetryClient.TrackPageView(pageName);
     }
 
     /// <inheritdoc />
     public void LogHealthCheckStart(string apiName)
-        => loggerMessageDefinitions.HealthCheckStart(logger, apiName, null);
+        => LoggerMessageDefinitionsApi.HealthCheckStart(logger, apiName, null);
 
     /// <inheritdoc />
     public void LogHealthCheckSuccess(string apiName)
-        => loggerMessageDefinitions.HealthCheckSuccess(logger, apiName, null);
+        => LoggerMessageDefinitionsApi.HealthCheckSuccess(logger, apiName, null);
 
     /// <inheritdoc />
     public void LogHealthCheckWarning(string apiName, string warningMessage)
-        => loggerMessageDefinitions.HealthCheckWarning(logger, apiName, warningMessage, null);
+        => LoggerMessageDefinitionsApi.HealthCheckWarning(logger, apiName, warningMessage, null);
 
     /// <inheritdoc />
     public void LogHealthCheckFailure(string apiName, string failureMessage)
-        => loggerMessageDefinitions.HealthCheckFailure(logger, apiName, failureMessage, null);
+        => LoggerMessageDefinitionsApi.HealthCheckFailure(logger, apiName, failureMessage, null);
 
     /// <inheritdoc />
     public void LogException(Exception exception)
-        => loggerMessageDefinitions.ExceptionLogMessage(logger, exception.GetBaseException().Message, exception);
+        => LoggerMessageDefinitionsCommon.ExceptionLogMessage(logger, exception.GetBaseException().Message, exception);
 
     /// <inheritdoc />
     public void LogCriticalFailure(Exception exception)
-        => loggerMessageDefinitions.CriticalFailure(logger, exception.GetBaseException().Message, exception);
+        => LoggerMessageDefinitionsCommon.CriticalFailure(logger, exception.GetBaseException().Message, exception);
+
+    /// <inheritdoc />
+    public void LogApiCallStart(string apiName, string uri)
+        => LoggerMessageDefinitionsApi.ApiCallStart(logger, apiName, uri, null);
+
+    /// <inheritdoc />
+    public void LogApiCallSuccess(string apiName, string uri)
+        => LoggerMessageDefinitionsApi.ApiCallSuccess(logger, apiName, uri, null);
+
+    /// <inheritdoc />
+    public void LogApiCallWarning(string apiName, string uri, string warningMessage)
+        => LoggerMessageDefinitionsApi.ApiCallWarning(logger, apiName, uri, warningMessage, null);
+
+    /// <inheritdoc />
+    public void LogApiCallFailed(string apiName, string uri, string failureMessage)
+        => LoggerMessageDefinitionsApi.ApiCallFailure(logger, apiName, uri, failureMessage, null);
 
     /// <inheritdoc />
     public IDisposable? BeginScope<TState>(TState state)

src/AStar.Dev.Logging.Extensions/AStarLogger.cs

@@ -49,4 +49,34 @@ public interface ILoggerAstar<out T> : ILogger<T>
     /// </summary>
     /// <param name="exception">An instance of the Exception (or derived type) that occurred</param>
     void LogCriticalFailure(Exception exception);
+
+    /// <summary>
+    ///     The LogApiCallStart method logs the call (using the Debug level) for the specified API
+    /// </summary>
+    /// <param name="apiName">The name of the API being called</param>
+    /// <param name="uri">The URI being called</param>
+    void LogApiCallStart(string apiName, string uri);
+
+    /// <summary>
+    ///     The LogApiCallSuccess method logs the call (using the Debug level) to the specified API
+    /// </summary>
+    /// <param name="apiName">The name of the API being called</param>
+    /// <param name="uri">The URI being called</param>
+    void LogApiCallSuccess(string apiName, string uri);
+
+    /// <summary>
+    ///     The LogApiCallWarning method logs the call (using the Warning level) for the specified API
+    /// </summary>
+    /// <param name="apiName">The name of the API being called</param>
+    /// <param name="uri">The URI being called</param>
+    /// <param name="warningMessage">The warning message to log</param>
+    void LogApiCallWarning(string apiName, string uri, string warningMessage);
+
+    /// <summary>
+    ///     The LogApiCallFailed method logs the call (using the Error level) for the specified API
+    /// </summary>
+    /// <param name="apiName">The name of the API being called</param>
+    /// <param name="uri">The URI being called</param>
+    /// <param name="failureMessage">The failure message to log</param>
+    void LogApiCallFailed(string apiName, string uri, string failureMessage);
 }