GH-152 - Use ILogger instead of IEventLogService in the main branch (#154)

* GH-149 :: Update main branch to 30.11.1

* GH-152 :: Replace IEventLogService with ILogger

* GH-152 :: Adjust logging levels

* GH-152 :: Add event IDs for logging

* GH-152 :: adjust capitalization in readme file when referring to repo vs guides

Author: kentico-matthews

README.md

@@ -1,13 +1,13 @@
-# Xperience by Kentico Training Guides starter repository
+# Xperience by Kentico *Training guides* starter repository
 
-This repository is the starting point for the [Xperience by Kentico technical Training Guides](https://docs.kentico.com/guides/development). Use this branch to follow along with the Training guides.
+This repository is the starting point for the [Xperience by Kentico technical training guides](https://docs.kentico.com/guides/development). Use this branch to follow along with the training guides.
 
 > [!NOTE]  
 > This repository uses Xperience by Kentico version **30.11.1**.
 
-The [finished branch](https://github.com/Kentico/xperience-by-kentico-training-guides/tree/finished) contains the cumulative results of the Training guides, as well as some sample widgets, and can be used for reference. As it contains several independent examples, it is not built comprehensively, and we recommend against using it as a boilerplate. We continuously add new features to this repository as we create new Training guide materials. 
+The [finished branch](https://github.com/Kentico/xperience-by-kentico-training-guides/tree/finished) contains the cumulative results of the training guides, as well as some sample widgets, and can be used for reference. As it contains several independent examples, it is not built comprehensively, and we recommend against using it as a boilerplate. We continuously add new features to this repository as we create new training guide materials. 
 
-The goal of the [Training Guides](https://docs.kentico.com/guides/development) is to teach recommended development practices with Xperience by Kentico.
+The goal of the [training guides](https://docs.kentico.com/guides/development) is to teach recommended development practices with Xperience by Kentico.
 However, keep in mind that the code in this repository is intended to be examined in the context of individual guides -- some aspects are simplified to keep attention on the main topic of the corresponding lesson.
 
 ## Installation requirements
@@ -42,7 +42,7 @@ However, keep in mind that the code in this repository is intended to be examine
 
 ## Contributing
 
-This repository is related to Training Guides for developers and has an educational purpose. For this reason, please do not submit ideas for new functionality. However, please do let us know if you encounter a bug that needs to be fixed, either by submitting an issue or contributing a fix directly.
+This repository is related to Training guides for developers and has an educational purpose. For this reason, please do not submit ideas for new functionality. However, please do let us know if you encounter a bug that needs to be fixed, either by submitting an issue or contributing a fix directly.
 
 To see the guidelines for Contributing to Kentico open source software, please see [Kentico's `CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [Kentico's `CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md).
 

src/TrainingGuides.Web/Features/Shared/Logging/EventIds.cs

@@ -0,0 +1,11 @@
+namespace TrainingGuides.Web.Features.Shared.Logging;
+
+/// <summary>
+/// Contains event IDs for logging.
+/// </summary>
+internal static class EventIds
+{
+    public static readonly EventId RetrieveUrl = new(1001, nameof(RetrieveUrl));
+    public static readonly EventId MemberRegistration = new(1002, nameof(MemberRegistration));
+    public static readonly EventId MemberSignIn = new(1003, nameof(MemberSignIn));
+}

src/TrainingGuides.Web/Features/Shared/Services/TrainingGuidesWebPageUrlRetriever.cs

@@ -1,18 +1,19 @@
 using CMS;
 using CMS.Core;
+using TrainingGuides.Web.Features.Shared.Logging;
 
 [assembly: RegisterImplementation(typeof(IWebPageUrlRetriever), typeof(TrainingGuidesWebPageUrlRetriever))]
 public class TrainingGuidesWebPageUrlRetriever : IWebPageUrlRetriever
 {
     private WebPageUrl EmptyUrl => new(string.Empty, string.Empty);
     private readonly IWebPageUrlRetriever webPageUrlRetriever;
-    private readonly IEventLogService eventLogService;
+    private readonly ILogger<TrainingGuidesWebPageUrlRetriever> logger;
 
     public TrainingGuidesWebPageUrlRetriever(IWebPageUrlRetriever webPageUrlRetriever,
-        IEventLogService eventLogService)
+        ILogger<TrainingGuidesWebPageUrlRetriever> logger)
     {
         this.webPageUrlRetriever = webPageUrlRetriever;
-        this.eventLogService = eventLogService;
+        this.logger = logger;
     }
 
     /// <summary>
@@ -42,8 +43,7 @@ public async Task<WebPageUrl> Retrieve(IWebPageFieldsSource webPageFieldsSource,
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\nweb page guid: {webPageFieldsSource?.SystemFields.WebPageItemGUID},\r\nweb page id: {webPageFieldsSource?.SystemFields.WebPageItemID},\r\ntree path: {webPageFieldsSource?.SystemFields.WebPageItemTreePath}";
-            eventLogService.LogError(ex.Source, "Retrieve URL", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred while retrieving URL for web page with GUID {WebPageItemGuid} and ID {WebPageItemId} at path {TreePath}.", webPageFieldsSource?.SystemFields.WebPageItemGUID, webPageFieldsSource?.SystemFields.WebPageItemID, webPageFieldsSource?.SystemFields.WebPageItemTreePath);
             return EmptyUrl;
         }
     }
@@ -78,8 +78,7 @@ public async Task<WebPageUrl> Retrieve(IWebPageFieldsSource webPageFieldsSource,
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\nweb page guid: {webPageFieldsSource?.SystemFields.WebPageItemGUID},\r\nweb page id: {webPageFieldsSource?.SystemFields.WebPageItemID},\r\ntree path: {webPageFieldsSource?.SystemFields.WebPageItemTreePath}\r\nlanguage: {languageName}";
-            eventLogService.LogError(ex.Source, "Retrieve URL", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred while retrieving URL for web page with GUID {WebPageItemGuid} and ID {WebPageItemId} at path {TreePath} in language {LanguageName}.", webPageFieldsSource?.SystemFields.WebPageItemGUID, webPageFieldsSource?.SystemFields.WebPageItemID, webPageFieldsSource?.SystemFields.WebPageItemTreePath, languageName);
             return EmptyUrl;
         }
     }
@@ -113,8 +112,7 @@ public async Task<WebPageUrl> Retrieve(string webPageUrlPath, string webPageTree
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\ntree path: {webPageTreePath},\r\nweb page URL path: {webPageUrlPath},\r\nwebsite channel id: {websiteChannelId}\r\nlanguage: {languageName}";
-            eventLogService.LogError(ex.Source, "Retrieve URL", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred retrieving URL for web page with URL path {WebPageUrlPath} and tree path {WebPageTreePath} in website channel with ID {WebsiteChannelId} in language {languageName}.", webPageUrlPath, webPageTreePath, websiteChannelId, languageName);
             return EmptyUrl;
         }
     }
@@ -139,8 +137,7 @@ public async Task<WebPageUrl> Retrieve(int webPageItemId, string languageName, b
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\nweb page id: {webPageItemId},\r\nlanguage: {languageName}\r\nfor preview: {forPreview}";
-            eventLogService.LogError(ex.Source, "Retrieve URL", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred retrieving URL for web page with ID {WebPageItemId} in language {LanguageName} (for preview: {ForPreview}).", webPageItemId, languageName, forPreview);
             return EmptyUrl;
         }
     }
@@ -165,8 +162,7 @@ public async Task<WebPageUrl> Retrieve(Guid webPageItemGuid, string languageName
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\nweb page guid: {webPageItemGuid},\r\nlanguage: {languageName}\r\nfor preview: {forPreview}";
-            eventLogService.LogError(ex.Source, "Retrieve URL", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred retrieving URL for web page with GUID {WebPageItemGuid} in language {LanguageName} (for preview: {ForPreview}).", webPageItemGuid, languageName, forPreview);
             return EmptyUrl;
         }
     }
@@ -192,8 +188,7 @@ public async Task<IDictionary<Guid, WebPageUrl>> Retrieve(IReadOnlyCollection<Gu
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\nweb page guids: {string.Join(", ", webPageItemGuids)},\r\nwebsite channel name: {websiteChannelName},\r\nlanguage: {languageName}\r\nfor preview: {forPreview}";
-            eventLogService.LogError(ex.Source, "Retrieve URLs", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred retrieving URLs for web pages with GUIDs {WebPageItemGuids} in website channel {WebsiteChannelName} in language {LanguageName} (for preview: {ForPreview}).", string.Join(", ", webPageItemGuids), websiteChannelName, languageName, forPreview);
             return webPageItemGuids.ToDictionary(guid => guid, _ => EmptyUrl);
         }
     }
@@ -220,8 +215,7 @@ public async Task<WebPageUrl> Retrieve(string webPageTreePath, string websiteCha
         }
         catch (InvalidOperationException ex)
         {
-            string message = $"{ex.Message}\r\ntree path: {webPageTreePath},\r\nwebsite channel name: {websiteChannelName},\r\nlanguage: {languageName}\r\nfor preview: {forPreview}";
-            eventLogService.LogError(ex.Source, "Retrieve URL", message);
+            logger.LogError(EventIds.RetrieveUrl, ex, "An error occurred retrieving URL for web page with tree path {WebPageTreePath} in website channel {WebsiteChannelName} in language {LanguageName} (for preview: {ForPreview}).", webPageTreePath, websiteChannelName, languageName, forPreview);
             return EmptyUrl;
         }
     }

src/TrainingGuides.Web/appsettings.json

@@ -5,9 +5,12 @@
       "Microsoft": "Warning",
       "Microsoft.Hosting.Lifetime": "Information"
     },
-    "KenticoEventLog": {
+    "XperienceEventLog": {
       "LogLevel": {
-        "Default": "Error",
+        "Default": "Warning",
+        "Kentico": "Information",
+        "CMS": "Information",
+        "TrainingGuides": "Debug",
         "Microsoft.AspNetCore.Server.Kestrel": "None"
       }
     }