TPJ.Logging 2.5.1

• .NETFramework 4.6.1

  • Microsoft.Extensions.Configuration.Abstractions (>= 1.1.2)
  • Microsoft.Extensions.Options (>= 1.1.2)
  • System.ValueTuple (>= 4.3.1)

V2.5.0 is still only supporting full .net 4.5.2, 4.6, and 4.6.1. This version cleans up the code getting it ready for .NETstandard 2.0. Once .NETStandard 2.0 is released this packaged will be updated to run using this. More detailed Examples will follow then.
ASP.Net Core full framework (4.5.2 4.6 4.6.1) Website / WebAPI Set up using both E-mail and Log file.

Within  appsettings.json and add the following

{
 "TPJ": {
   "Logging": {
     "ApplicationName": "",
     "Error":{
       "LogType": "",
       "LogFileDirectory": "",
       "Email":{
         "To": "",
         "From": "",
         "SmtpClient": "",
         "SmtpUser": "",
         "SmtpPassword": "",
         "Port": "",
         "EnableSSL": ""
       }
     }
   }
 }
}

ApplicationName – (Required) Name of the application used on the log file names and e-mails

ErrorLogType – (Required) There are three types of error log types
             1) Email - Errors are sent via e-mail only (as per rest of the config settings)
             2) LogFile - Errors are logged in a txt file (named – ‘[{Environment}] {Application Name} Error Log.txt’)
             3) EmailLogFile - Does both Email and LogFile

LogFileDirectory - (Required for log file logging) The location at which the log / error file will be placed

To - (Required for e-mail logging) Error e-mails sent to; Can be a list split by ';' E.G "Test@test.com;Test2@test.com"

From - (Required for e-mail logging) E-mails are sent from this account

SmtpClient – (Required for e-mail logging) SMTP server which e-mails will be sent from

SmtpUser - (Not required) send e-mail using the given user name and password

SmtpPassword - (Not required) send e-mail using the given user name and password

Port - (Not required) port to send from

EnableSSL - (Not required) enable SSL when sending the e-mail

Example appsettings.json setup using Gmail to send error e-mails –
{
 "TPJ": {
   "Logging": {
     "ApplicationName": "Test Application",
     "Error":{
       "LogType": "EmailLogFile",
       "LogFileDirectory": "C:\Logging",
       "Email":{
         "To": "test@test.com",
         "From": "test@gmail.com ",
         "SmtpClient": "smtp.gmail.com",
         "SmtpUser": "test@gmail.com",
         "SmtpPassword": "testPassword",
         "Port": "587",
         "EnableSSL": "true"
       }
     }
   }
 }
}

Once appsettings.json is done open StartUp.cs file and go to ConfigureServices


var logSettings = new TPJ.Logging.Models.ErrorLogSettings(Configuration);
services.Configure< TPJ.Logging.Models.ErrorLogSettings>(options =>
{
   options.ApplicationName = logSettings.ApplicationName;
   options.LogType = loggSettings. LogType;
   options.LogFileDirectory = loggSettings.LogFileDirectory;
   options.EmailTo = loggSettings.EmailTo;
   options.EmailFrom = loggSettings.EmailFrom;
   options.SmtpClient = loggSettings.SmtpClient;
   options.SmtpUser = loggSettings.SmtpUser;

   options.SmtpPassword = loggSettings.SmtpPassword;
   options.Port = loggSettings.Port;
   options.EnableSSL= loggSettings.EnableSSL;
});
services.AddSingleton< TPJ.Logging.IErrorLogger, TPJ.Logging.ErrorLogger>();


Then using DI within asp.net core you can call IErrorLogger like so

private readonly TPJ.Logging.IErrorLogger _errorLogger;

public HomeController(TPJ.Logging.IErrorLogger logger)
{
 _errorLogger = errorLogger;
}

Then within an IActionResult you might have this

public IActionResult About(Divide divide)
{
 try
 {
    var divideByZero = divide.ValueOne / divide.ValueTwo;
     return View();
 }
 catch (Exception e)
 {
     _logger.Log(System.Reflection.MethodBase.GetCurrentMethod(), e, divide);
     return RedirectToAction(nameof(Error));
 }
}

This will then log the error with the current method information, the exception details and the details of the object ‘divide’ – it will log nested classes within objects.