TPJ.Logging 2.2.3

TPJ Logging library does both Error logging to e-mail and log file and audit logging to log file or database

Install-Package TPJ.Logging -Version 2.2.3

dotnet add package TPJ.Logging --version 2.2.3

<PackageReference Include="TPJ.Logging" Version="2.2.3" />

paket add TPJ.Logging --version 2.2.3

Release Notes

ASP.Net Core full framework (4.5.2 4.6 4.6.1) Website Set up

Create appsettings.json file and add the following

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

ApplicationName - Name of the application used on the log file names and e-mails

ErrorLogType - 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 - {Application Name} Error Log.txt)
             3) EmailLogFile - Does both Email and LogFile

LogEnvironment - There are three environment types. logging will be done on all logs marked at or below the log environment type E.G logs marked at "Staging" will log when the config is set to development and staging but NOT production
             1) Development
             2) Staging
             3) Production

LogFileDirectory - the location at which the log / error file will be placed

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

From - E-mails are sent from this account

SmtpClient - 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


For Websites -

Open StartUp.cs file and go to ConfigureServices

Add the following (I do not need port or enable SSL so have not include them)

var logSettings = new TPJ.Logging.Models.ErrorLogSettings(Configuration);
           
services.Configure<TPJ.Logging.Models.ErrorLogSettings>(options =>
{
  options.ApplicationName = logSettings.ApplicationName;
  options.EmailFrom = logSettings.EmailFrom;
  options.EmailTo = logSettings.EmailTo;
  options.LogEnvironment = logSettings.LogEnvironment;
  options.SmtpClient = logSettings.SmtpClient;
});

Top Tip - If you dont put in a log environment it will default to use the Configuration["ASPNETCORE_ENVIRONMENT"]


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()
{
  try
  {
     return View();
  }
  catch (Exception e)
  {
     _logger.log(System.Reflection.MethodBase.GetCurrentMethod(), e, TPJ.Logging.Enums.LogEnvironment.Production);

     return RedirectToAction(nameof(Error));
  }
}

Dependencies

• .NETFramework 4.5.2

  • Microsoft.Extensions.Configuration.Abstractions (>= 1.0.0)
  • Microsoft.Extensions.Options (>= 1.0.0)
  • System.Data.SqlClient (>= 4.1.0)

• .NETFramework 4.6

  • Microsoft.Extensions.Configuration.Abstractions (>= 1.0.0)
  • Microsoft.Extensions.Options (>= 1.0.0)
  • System.Data.SqlClient (>= 4.1.0)

• .NETFramework 4.6.1

  • Microsoft.Extensions.Configuration.Abstractions (>= 1.0.0)
  • Microsoft.Extensions.Options (>= 1.0.0)
  • System.Data.SqlClient (>= 4.1.0)

Used By

Version History