Log for context and save and clear log options implemented

umairsyed613 · May 1, 2021 · f46bbe3 · f46bbe3
1 parent 96ab78f
commit f46bbe3
Show file tree

Hide file tree

Showing 14 changed files with 287 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -60,6 +60,21 @@ Log.Logger = new LoggerConfiguration()
                         .CreateLogger();
 ```
 
+#### Log For Context
+
+SimpleLogTextBox, RichTextBoxLogControl or JsonLogTextBox can be configured to display log for specific ***Context***.
+All of the controls have property **For Context** which can be configured with ***namespace.classname*** for example ***TestApplication.Form2*** you can file the sample here >> [Sample](https://github.com/umairsyed613/Serilog.Sinks.WinForms/blob/master/src/Sample/TestApplication/Form2.cs)
+
+**Note:** Remember to configure Logger instance with ***Enrich.FromLogContext()***
+
+
+#### Save and Clear Logs
+SimpleLogTextBox, RichTextBoxLogControl or JsonLogTextBox have two method available for saving log to file or clear the log from the log control.
+***ClearLogs()*** AND ***SaveLogToFile()***
+
+Check the usage in sample application here [Sample](https://github.com/umairsyed613/Serilog.Sinks.WinForms/blob/master/src/Sample/TestApplication/Form2.cs)
+
+
 ### Sample Code
 
 Find the sample running application [here](https://github.com/umairsyed613/Serilog.Sinks.WinForms/tree/master/Sample/TestApplication/)

diff --git a/src/JsonLogTextBox.cs b/src/JsonLogTextBox.cs
@@ -13,6 +13,10 @@ public partial class JsonLogTextBox : UserControl
 
         public BorderStyle LogBorderStyle { get; set; } = BorderStyle.Fixed3D;
 
+        public string ForContext { get; set; } = string.Empty;
+
+        private bool _isContextConfigured = false;
+
         public JsonLogTextBox()
         {
             InitializeComponent();
@@ -30,24 +34,55 @@ private void LogTextBox_Load(object sender, EventArgs e)
             WindFormsSink.JsonTextBoxSink.OnLogReceived += JsonTextBoxSinkOnLogReceived;
         }
 
-        private void JsonTextBoxSinkOnLogReceived(string str)
+        private void JsonTextBoxSinkOnLogReceived(string context, string str)
+        {
+            if (_isContextConfigured)
+            {
+                if (!string.IsNullOrEmpty(this.ForContext)
+                 && !string.IsNullOrEmpty(context)
+                 && this.ForContext.Equals(context, StringComparison.InvariantCultureIgnoreCase)) { PrintText(str); }
+            }
+            else
+            {
+                PrintText(str);
+            }
+
+            Application.DoEvents();
+        }
+
+        private void PrintText(string str)
         {
             if (this.InvokeRequired)
             {
                 this.Invoke(
                     (MethodInvoker)delegate
-                        {
-                            TxtLogControl.AppendText(str);
-                            TxtLogControl.ScrollToCaret();
-                        });
+                    {
+                        TxtLogControl.AppendText(str);
+                        TxtLogControl.ScrollToCaret();
+                    });
             }
             else
             {
                 TxtLogControl.AppendText(str);
                 TxtLogControl.ScrollToCaret();
             }
+        }
 
-            Application.DoEvents();
+        public void ClearLogs()
+        {
+            if (this.InvokeRequired)
+            {
+                this.Invoke((MethodInvoker)(() => TxtLogControl.Clear()));
+            }
+            else
+            {
+                TxtLogControl.Clear();
+            }
+        }
+
+        public void SaveLogToFile()
+        {
+            SaveFileHelper.SaveLogsToFile(TxtLogControl.Text);
         }
     }
 }
diff --git a/src/Properties/AssemblyInfo.cs b/src/Properties/AssemblyInfo.cs
@@ -33,6 +33,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.2.6.0")]
-[assembly: AssemblyFileVersion("2.2.6.0")]
+[assembly: AssemblyVersion("2.3.0.0")]
+[assembly: AssemblyFileVersion("2.3.0.0")]
 [assembly: NeutralResourcesLanguage("en")]
diff --git a/src/RichTextBoxLogControl.cs b/src/RichTextBoxLogControl.cs
@@ -5,17 +5,36 @@ namespace Serilog.Sinks.WinForms
 {
     public partial class RichTextBoxLogControl : RichTextBox
     {
+        public string ForContext { get; set; } = string.Empty;
+        private bool _isContextConfigured = false;
+
         public RichTextBoxLogControl()
         {
             InitializeComponent();
             WindFormsSink.SimpleTextBoxSink.OnLogReceived += SimpleTextBoxSinkOnLogReceived;
         }
 
-        private void SimpleTextBoxSinkOnLogReceived(string str)
+        private void SimpleTextBoxSinkOnLogReceived(string context, string str)
+        {
+            if (_isContextConfigured)
+            {
+                if (!string.IsNullOrEmpty(this.ForContext)
+                 && !string.IsNullOrEmpty(context)
+                 && this.ForContext.Equals(context, StringComparison.InvariantCultureIgnoreCase)) { PrintText(str); }
+            }
+            else
+            {
+                PrintText(str);
+            }
+
+            Application.DoEvents();
+        }
+
+        private void PrintText(string str)
         {
             if (this.InvokeRequired)
             {
-                this.Invoke((MethodInvoker)delegate
+                this.Invoke((MethodInvoker) delegate
                 {
                     this.AppendText(str);
                     this.ScrollToCaret();
@@ -26,8 +45,23 @@ private void SimpleTextBoxSinkOnLogReceived(string str)
                 this.AppendText(str);
                 this.ScrollToCaret();
             }
+        }
 
-            Application.DoEvents();
+        public void ClearLogs()
+        {
+            if (this.InvokeRequired)
+            {
+                this.Invoke((MethodInvoker)(() => this.Clear()));
+            }
+            else
+            {
+                this.Clear();
+            }
+        }
+
+        public void SaveLogToFile()
+        {
+            SaveFileHelper.SaveLogsToFile(this.Text);
         }
     }
 }
diff --git a/src/Sample/CustomSimpleTextLog/Form1.cs b/src/Sample/CustomSimpleTextLog/Form1.cs
@@ -24,7 +24,7 @@ private void Form1_Load(object sender, EventArgs e)
             WindFormsSink.SimpleTextBoxSink.OnLogReceived += SimpleTextBoxSinkOnOnLogReceived;
         }
 
-        private void SimpleTextBoxSinkOnOnLogReceived(string str)
+        private void SimpleTextBoxSinkOnOnLogReceived(string context, string str)
         {
             this.textBox1.AppendText(str);
             this.richTextBox1.AppendText(str);

diff --git a/src/Sample/TestApplication/Form2.Designer.cs b/src/Sample/TestApplication/Form2.Designer.cs
diff --git a/src/Sample/TestApplication/Form2.cs b/src/Sample/TestApplication/Form2.cs
@@ -14,6 +14,8 @@ namespace TestApplication
 {
     public partial class Form2 : Form
     {
+        private static readonly ILogger _logger = Log.ForContext<Form2>();
+
         public Form2()
         {
             InitializeComponent();
@@ -22,7 +24,7 @@ public Form2()
 
         private void button1_Click(object sender, EventArgs e)
         {
-            Log.Information(textBox1.Text);
+            _logger.Information(textBox1.Text);
         }
 
         private void button2_Click(object sender, EventArgs e)
@@ -33,8 +35,18 @@ private void button2_Click(object sender, EventArgs e)
             }
             catch (Exception exception)
             {
-                Log.Error(exception, "Error Happened in Form2");
+                _logger.Error(exception, "Error Happened in Form2");
             }
         }
+
+        private void button3_Click(object sender, EventArgs e)
+        {
+            simpleLogTextBox1.ClearLogs();
+        }
+
+        private void button4_Click(object sender, EventArgs e)
+        {
+            simpleLogTextBox1.SaveLogToFile();
+        }
     }
 }
diff --git a/src/Sample/TestApplication/LogVieweer.Designer.cs b/src/Sample/TestApplication/LogVieweer.Designer.cs
diff --git a/src/Sample/TestApplication/Program.cs b/src/Sample/TestApplication/Program.cs
@@ -23,6 +23,7 @@ static void Main()
         private static void ConfigureSerilog()
         {
             Log.Logger = new LoggerConfiguration()
+                        .Enrich.FromLogContext()
                         .WriteToGridView()
                         .WriteToJsonTextBox()
                         .WriteToSimpleAndRichTextBox()

diff --git a/src/SaveFileHelper.cs b/src/SaveFileHelper.cs
@@ -0,0 +1,26 @@
+using System;
+using System.IO;
+using System.Windows.Forms;
+
+namespace Serilog.Sinks.WinForms
+{
+    public static class SaveFileHelper
+    {
+        internal static void SaveLogsToFile(string fileContent)
+        {
+            try
+            {
+                var saveFileDialog = new SaveFileDialog { Filter = @"Text Files | *.txt| Log Files |*.log" };
+
+                if (saveFileDialog.ShowDialog() == DialogResult.OK)
+                {
+                    File.AppendAllText(saveFileDialog.FileName, fileContent);
+                }
+            }
+            catch (Exception e)
+            {
+                MessageBox.Show(e.Message, @"Error Saving Log File", MessageBoxButtons.OK, MessageBoxIcon.Error);
+            }
+        }
+    }
+}
diff --git a/src/Serilog.Sinks.WinForms.csproj b/src/Serilog.Sinks.WinForms.csproj
@@ -66,6 +66,7 @@
     <Compile Include="JsonLogTextBox.Designer.cs">
       <DependentUpon>JsonLogTextBox.cs</DependentUpon>
     </Compile>
+    <Compile Include="SaveFileHelper.cs" />
     <Compile Include="SimpleLogTextBox.cs">
       <SubType>UserControl</SubType>
     </Compile>