Separate the LoggerMessageDefinitionsApi.cs

Author: jbarden

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

@@ -19,17 +19,16 @@
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
         <PackageProjectUrl>https://github.com/astar-development/astar-dev-logging-extensions</PackageProjectUrl>
         <PackageReadmeFile>README.md</PackageReadmeFile>
-        <PackageReleaseNotes>Add more LoggerMessage.Define methods</PackageReleaseNotes>
+        <PackageReleaseNotes>Add overloads to the API 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.3</Version>
+        <Version>0.5.4</Version>
     </PropertyGroup>
 
-
     <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
         <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
     </PropertyGroup>
@@ -69,5 +68,3 @@
     </ItemGroup>
 
 </Project>
-
-

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

@@ -1,6 +1,3 @@
-using AStar.Dev.Api.HealthChecks;
-using AStar.Dev.Functional.Extensions;
-
 namespace AStar.Dev.Logging.Extensions;
 
 public partial class AStarLogger<TCategoryName>

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

@@ -4,11 +4,11 @@
 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
+///     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="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>
+/// <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 partial class AStarLogger<TCategoryName>(ILogger<TCategoryName> logger, IAStarTelemetryClient telemetryClient) : ILoggerAstar<TCategoryName>
 {

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

@@ -1,23 +1,20 @@
-using AStar.Dev.Api.HealthChecks;
-using AStar.Dev.Functional.Extensions;
-
 namespace AStar.Dev.Logging.Extensions;
 
 public partial class AStarLogger<TCategoryName>
 {
     /// <inheritdoc />
     public void LogHealthCheckStart(string apiName)
-        => LoggerMessageDefinitionsApi.HealthCheckStart(logger, apiName, null);
+        => LoggerMessageDefinitionsHealthChecks.HealthCheckStart(logger, apiName, null);
 
     /// <inheritdoc />
     public void LogHealthCheckSuccess(string apiName)
-        => LoggerMessageDefinitionsApi.HealthCheckSuccess(logger, apiName, null);
+        => LoggerMessageDefinitionsHealthChecks.HealthCheckSuccess(logger, apiName, null);
 
     /// <inheritdoc />
     public void LogHealthCheckWarning(string apiName, string warningMessage)
-        => LoggerMessageDefinitionsApi.HealthCheckWarning(logger, apiName, warningMessage, null);
+        => LoggerMessageDefinitionsHealthChecks.HealthCheckWarning(logger, apiName, warningMessage, null);
 
     /// <inheritdoc />
     public void LogHealthCheckFailure(string apiName, string failureMessage)
-        => LoggerMessageDefinitionsApi.HealthCheckFailure(logger, apiName, failureMessage, null);
+        => LoggerMessageDefinitionsHealthChecks.HealthCheckFailure(logger, apiName, failureMessage, null);
 }

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

@@ -1,6 +1,3 @@
-using AStar.Dev.Api.HealthChecks;
-using AStar.Dev.Functional.Extensions;
-
 namespace AStar.Dev.Logging.Extensions;
 
 public partial class AStarLogger<TCategoryName>

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

@@ -84,15 +84,15 @@ public interface ILoggerAstar<out T> : ILogger<T>
     void LogApiCallFailed(string apiName, string uri, string failureMessage);
 
     /// <summary>
-    /// The ReturnLoggedFailure will log the Health Check failure and return the <see cref="HealthStatusResponse"/> object
+    ///     The ReturnLoggedFailure will log the Health Check failure and return the <see cref="HealthStatusResponse" /> object
     /// </summary>
-    /// <param name="response">The instance of <see cref="HttpResponseMessage"/> from the original call</param>
+    /// <param name="response">The instance of <see cref="HttpResponseMessage" /> from the original call</param>
     /// <param name="apiName">The name of the API being called</param>
-    /// <returns>An instance of <see cref="HealthStatusResponse"/> appropriately configured</returns>
+    /// <returns>An instance of <see cref="HealthStatusResponse" /> appropriately configured</returns>
     HealthStatusResponse ReturnLoggedFailure(HttpResponseMessage response, string apiName);
 
     /// <summary>
-    /// The ReturnLoggedSuccess method will log the successful call and return the TResult response object
+    ///     The ReturnLoggedSuccess method will log the successful call and return the TResult response object
     /// </summary>
     /// <param name="result"></param>
     /// <param name="apiName">The name of the API being called</param>
@@ -102,7 +102,7 @@ public interface ILoggerAstar<out T> : ILogger<T>
     TResult ReturnLoggedSuccess<TResult>(TResult result, string apiName, string endpointName);
 
     /// <summary>
-    /// The ReturnLoggedFailure method will log the failed call and return the TResult response object
+    ///     The ReturnLoggedFailure method will log the failed call and return the TResult response object
     /// </summary>
     /// <param name="apiName">The name of the API being called</param>
     /// <param name="endpointName">The endpoint name of the call</param>

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

@@ -4,38 +4,6 @@ namespace AStar.Dev.Logging.Extensions;
 /// </summary>
 public static class LoggerMessageDefinitionsApi
 {
-    /// <summary>
-    ///     Defines the HealthCheckFailure message definition
-    /// </summary>
-    public static Action<ILogger, string,  string, Exception?> HealthCheckFailure => LoggerMessage.Define< string, string>(
-                                                                                                                           LogLevel.Warning,
-                                                                                                                           AStarEventIds.Api.HealthCheckFailure,
-                                                                                                                           "HealthCheck Failure: {ApiName} - {FailureMessage}");
-
-    /// <summary>
-    ///     Defines the HealthCheckStart message definition
-    /// </summary>
-    public static Action<ILogger, string, Exception?> HealthCheckStart => LoggerMessage.Define<string>(
-                                                                                                       LogLevel.Debug,
-                                                                                                       AStarEventIds.Api.HealthCheckStart,
-                                                                                                       "HealthCheck Start: {ApiName}");
-
-    /// <summary>
-    ///     Defines the HealthCheckSuccess message definition
-    /// </summary>
-    public static Action<ILogger, string, Exception?> HealthCheckSuccess => LoggerMessage.Define<string>(
-                                                                                                         LogLevel.Debug,
-                                                                                                         AStarEventIds.Api.HealthCheckStart,
-                                                                                                         "HealthCheck Success: {ApiName}");
-
-    /// <summary>
-    ///     Defines the HealthCheckWarning message definition
-    /// </summary>
-    public static Action<ILogger, string, string, Exception?> HealthCheckWarning => LoggerMessage.Define<string, string>(
-                                                                                                                         LogLevel.Warning,
-                                                                                                                         AStarEventIds.Api.HealthCheckWarning,
-                                                                                                                         "HealthCheck Warning: {ApiName} - {WarningMessage}");
-
     /// <summary>
     ///     Defines the ApiCallFailure message definition
     /// </summary>