From 84f5cce6ae4bcec643702b840817f7a5a545da34 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 10 Dec 2024 17:25:18 +0000 Subject: [PATCH] Update docs --- docs/plugins/logging/index.html | 31 +++++++++++++++++-- docs/plugins/logging/providers/appcenter.html | 4 +-- manifest.json | 4 +-- 3 files changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/plugins/logging/index.html b/docs/plugins/logging/index.html index 4240120..0bf061f 100644 --- a/docs/plugins/logging/index.html +++ b/docs/plugins/logging/index.html @@ -716,9 +716,7 @@

Getting Started

});

Configuration

Some logging providers such as the Null, Debug and Testing providers are intentionally not configurable as it makes sense to log all messages sent to them, or in the case of the Null logger nothing is logged anyway. The rest of the Logging providers provide some degree of configuration. This ensures that you can tailor the logging experience based on the provider. By default all features of the ILogger are enabled, however by optionally configuring the options, you can disable Event Tracking, Error Reporting, or you can disable or tune the generic logging.

-

To disable Event Tracking we can simply set the EnableEventTracking property to false

-
logging.AddConsole(o => o.EnableEventTracking = false);
-

To disable the Error Tracking we can simply set the EnableErrorTracking property to false

+

To disable the Error Tracking we can simply set the EnableErrorTracking property to false

logging.AddConsole(o => o.EnableErrorTracking = false);

To disable generic logging we can simply set the EnableLogging property to false

logging.AddConsole(o => o.EnableLogging = false);
@@ -726,6 +724,33 @@ 
Getting Started

 
logging.AddConsole(o => o.ExcludedLoggingCategories = [LogCategory.Debug]);
 
Similarly we could exclude logs which lack a category property.

 
logging.AddConsole(o => o.ExcludedLoggingCategories = [LogCategory.Uncategorized]);
+
Customizing Event Tracking

+
Event Tracking is handled special in Prism Logging. This allows you to enable some very powerful scenarios that can include multiple providers working in concert with each provider determining what it can and cannot track. This is done through 2 properties which can be used independently. The first is the CanLogEvent delegate which passes the Event Name and the Properties and returns a boolean indicating whether or not the provider can track a given event.

+
logging.AddConsole(o =>
+{
+    // Disable Events for the provider
+    o.CanLogEvent = (name, properties) => false;
+
+    // Optionally we can also do the following
+    o.DisableEvents();
+});
+
+logging.AddDebug(o =>
+{
+    // Conditionally Enable Event for the provider
+    o.CanLogEvent = (name, properties) => properties.TryGetValue("Debug", out var value) && value == bool.TrueString;
+});
+
The next delegate we have is the FormatEventName delegate. This again passes the provided event name and allows you to make any required modifications. If we put it all together you might have a situation where the Marketing team wants certain events and they want to use a platform like Kochava, while the development team might want some additional event tracking with App Center. In this case Prism Logging shines as it provides you the flexibility to customize the logger to your needs while only needing a single ILogger in your codebase.

+
logging.AddAppCenter("appSecret", o =>
+    {
+        o.CanLogEvent = (name, _) => name.StartsWith("Dev_");
+        o.FormatEventName = (name, _) = name[4..];
+    })
+    .AddKochava("{app secret}", o =>{
+        o.EnableErrorTracking = false;
+        o.EnableLogging = false;
+        o.CanLogEvent = (name, _) => !name.StartsWith("Dev_");
+    });
 
Logging Scopes

 
Scopes allow you to provide additional properties automatically on any logs, events or errors that you send to the ILogger. This means that you can define a property one time and it will automatically be added for you without the need to specify it again within the scope. An implicit Service Scope can be created by providing a generic type argument when resolving the ILogger.

 
public class MyViewModel(ILogger<MyViewModel> logger) : BindableBase
diff --git a/docs/plugins/logging/providers/appcenter.html b/docs/plugins/logging/providers/appcenter.html
index 156a194..c945f2a 100644
--- a/docs/plugins/logging/providers/appcenter.html
+++ b/docs/plugins/logging/providers/appcenter.html
@@ -699,10 +699,10 @@ 
AppCenter

 2) Since AppCenter is nearing EOL, it will be critical for businesses to continue using App Center while they evaluate other options. Prism.Plugin.Logging will help you to do just that by combining the AppCenter provider with the AggregateLogger as you evaluate other providers.

 
containerRegistry.UsePrismLogging(logging => {
     // By Default this registers Analytics and Crashes
-    logging.UseAppCenter("appSecret");
+    logging.AddAppCenter("appSecret");
 
     // If you need to customize the list with other providers
-    logging.UseAppCenter("appSecret", typeof(Analytics), typeof(Crashes), typeof(Distribution));
+    logging.AddAppCenter("appSecret", typeof(Analytics), typeof(Crashes), typeof(Distribution));
 });
 

           
diff --git a/manifest.json b/manifest.json
index bec5f79..6ec1419 100644
--- a/manifest.json
+++ b/manifest.json
@@ -2177,7 +2177,7 @@
       "output": {
         ".html": {
           "relative_path": "docs/plugins/logging/index.html",
-          "hash": "nxPcsNwfkDekf6uzDxsITA=="
+          "hash": "EDuUBz90SgB7TqypBQvTEw=="
         }
       },
       "is_incremental": false,
@@ -2213,7 +2213,7 @@
       "output": {
         ".html": {
           "relative_path": "docs/plugins/logging/providers/appcenter.html",
-          "hash": "DRkzm2HP59W0ISF7pepBSQ=="
+          "hash": "o1hiiD/Hlj3UxmCizQHfqw=="
         }
       },
       "is_incremental": false,