Error Control System

---

Check the official project site. There you will find information on how to contribute, our task board, definition of done, definition of ready, etc.

---

What Is This?

This is a C#.Net project's for manage Exceptions of your .Net applications by handling and logging that. This is a .dll modules to provide error handling worker on your app background's. The modules strive to be simple, well documented and modification friendly, in order to help developers quickly learn their inner workings.

NOTE:

This program is only for exception handling of 
Windows-based applications (WinForms, WPF, Console)
that are written by .NET languages such as C#, VB.NET, Visual F#

---

How To Use The Examples

To interact with this project, at first find main class of your project to add this module. Then, at the beginning of the instructions before any other user codes, enter the following command to invoke and run the module.

This is initialize codes of the module in C# language windows applications:

using System;
using System.Windows.Forms;
using ErrorControlSystem;
using ErrorControlSystem.Shared;

namespace TestApplication
{
    static class Program
    {
        [STAThread]
        private static void Main()
        {
			//
            // ------------------ Initial Error Control System --------------------------------
            //
            ExceptionHandler.Engine.Start("localhost", "UsersManagements",
                ErrorHandlingOptions.Default &
                   ~ErrorHandlingOptions.ResizeSnapshots);
            
            // Or Set Option this way:
            ErrorHandlingOption.ResizeSnapshots = false;
            ErrorHandlingOption.ReportHandledExceptions = false;
            ErrorHandlingOption.LogOnTheFly = true; // Log errors without caching

            //
            // Some of the optional configuration items.
            //
            // Except 'NotImplementedException' from raise log
            ExceptionHandler.Filter.ExemptedExceptionTypes.Add(typeof(NotImplementedException));

            // Filter 'Exception' type from Snapshot capturing 
            ExceptionHandler.Filter.NonSnapshotExceptionTypes.Add(typeof(FormatException));

            // Add extra data for labeling exceptions
            ExceptionHandler.Filter.AttachExtraData.Add("WinForms", "beta version");

            // Filter a method of a specific class in my assembly 
			// from raise unhanded exceptions log
            ExceptionHandler.Filter.ExemptedCodeScopes.Add(
                new CodeScope("Assembly", "Namespace", "Class", "Method"));

            // Do not raise any exception in other code places.
            ExceptionHandler.Filter.JustRaiseErrorCodeScopes.Add(
                new CodeScope("Assembly", "Namespace", "Class", "Method"));
			//
            // Show unhandled exception message customized mode. 
            ExceptionHandler.OnShowUnhandledError += AlertUnhandledErrors;
            //
            // ----------------------------------------------------------------------------
            //

			Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new FormTest());
        }

		/// <summary>
        /// Show unhandled exception message customized mode.
        /// </summary>
        /// <param name="sender">Raw exception object</param>
        /// <param name="e">Compiled error object</param>
        public static void AlertUnhandledErrors(object sender, UnhandledErrorEventArgs e)
        {
            MessageBox.Show(e.ErrorObject.Message);
        }
    }
}

In VB.NET applications, open the solution window and select My Project then click on Show All Files and go on this path:

• My Project
  • Application.myapp
    • Application.Designer.vb --> (open this file)

Add Startup events at this file, same below codes:

Partial Friend Class MyApplication
        
        <Global.System.Diagnostics.DebuggerStepThroughAttribute()>  _
        Public Sub New()
            MyBase.New(Global.Microsoft.VisualBasic.ApplicationServices.AuthenticationMode.Windows)
            Me.IsSingleInstance = True
            Me.EnableVisualStyles = True
            Me.SaveMySettingsOnExit = True
            Me.ShutDownStyle = Global.Microsoft.VisualBasic.ApplicationServices.ShutdownMode.AfterMainFormCloses
        End Sub

        <Global.System.Diagnostics.DebuggerStepThroughAttribute()> _
        Protected Overrides Sub OnCreateMainForm()
            Me.MainForm = Global.ErrorControlSystem.Examples.VisualBasicWinForms.Form1
        End Sub


        Private Sub MyApplication_Startup(sender As Object, e As ApplicationServices.StartupEventArgs) Handles Me.Startup
            ' ------------------ Initial Error Control System --------------------------------
            ExceptionHandler.Engine.Start("localhost", "UsersManagements")
            ' ---------------------------------------------------------------------------------
        End Sub
    End Class

Or create a Sub Main method like MainModule.vb, for this change must be to go on the Project Designer (go to Project Properties or double-click the My Project node in Solution Explorer) and then after shown properties form, uncheck the Enable Application Framework option on the Application tab, and at last change the Startup object to Sub Main.

---

Settings

In the initialize code snippet you've seen that, for the ExceptionHandler.Engine method should be an option. This option is used to specify the error data, which includes the following values:

• None
• DisplayUnhandledExceptions
• ReportHandledExceptions
• Snapshot
• FetchServerDateTime
• ResizeSnapshots
• EnableNetworkSending
• FilterExceptions
• ExitApplicationImmediately
• HandleProcessCorruptedStateExceptions
• DisplayDeveloperUI
• LogOnTheFly
• All
• Default = All - (ExitApplicationImmediately, HandleProcessCorruptedStateExceptions)

For example in above codes, this code means is:

ExceptionHandler.Engine.Start("localhost", "UsersManagements",
                ErrorHandlingOptions.Default & ~ErrorHandlingOptions.ResizeSnapshots);

Select all options by excepted ResizeSnapshots

By adding the our module starter code to the beginning of your program code, you can raise all exceptions history, including Handled or UnHandled exceptions on the your database.

Note:

In the new version 2.1.1.0 and later, the option set in from database at runtime, 
and not necessary to set that from initial  Start  method

---

How To Install The Modules

1. Install examples for developers (unpacking it to your disk, and go to \ErrorControlSystem\out\ErrorControlSystem... directory if you're installing by hand, for example).

Note:

 If there is not any file in the out folders, 
 run the buildx86.bat (or buildx64 on 64bit Operation System) file 
 to compile project and create executable files.
 Or 
 please open project .sln file on Visual Studio 2013 
 and debug/release that to compile native files.

2. In your project reference add this module dll file:
   References > Add Reference... > Browse to above path > Select ErrorControlSystem.dll

3. Rebuild access permissions if you are prompted to.

Now you can read the code and its comments and see the result, experiment with it, and hopefully quickly grasp how things work.

If you find a problem, incorrect comment, obsolete or improper code or such, please search for an issue about it at ECS Issue If there isn't already an issue for it, please create a new one.

---

Creating SQL Server Database Manually

The ErrorControlSystem project used from __UsersManagements __ database. So that is necessary for run this application. For Creating UsersManagements database on your server or pc do below steps:

Note:

In the new version database and tables automatically created by ErrorControlSystem

First open SQL Server Management Studio then connect to your Server instance. Next step's, Create New Database by name UsersManagements or any name of your choice.

Only be carefully, in order to launch the program, enter the database name. For example:

ExceptionHandler.Engine.Start(new Connection("Server", "Database", "User", "Pass"));

// or simpler mode:
ExceptionHandler.Engine.Start("Server", "Database", "User", "Pass");

Now, we need to create two table by names ErrorLog and Snapshots to save exceptions by screen captures.

ErrorLog Table:

| Column Name | Data Type | Description | Example | |:---------------- |:------------------- |:--------------------------------------------