Solution.Framework.Logger 7.0.0

Logger

Log framework.

Log Types

• Application
• Audit

The Audit log type will always be written to the database

Available Methods

• Verbose
• Debug
• Information
• Warning
• Error
• Fatal

Create table

	CREATE TABLE [Logs] (

	   [Id] bigint IDENTITY(1,1) NOT NULL,
	   [Message] nvarchar(max) NULL,
	   [MessageTemplate] nvarchar(max) NULL,
	   [Level] nvarchar(128) NULL,
	   [TimeStamp] datetime NOT NULL,
	   [Exception] nvarchar(max) NULL,
	   [Properties] nvarchar(max) NULL,
	   [Source] nvarchar(500) NULL,
	   [LogType] nvarchar(20) NULL,
	   [MachineName] nvarchar(500) NULL,
	   [EnvironmentUserName] nvarchar(500) NULL,
	   [UserNameLog] nvarchar(100) NULL,
	   [ContextName] nvarchar(max) NULL,
	   [EventName] nvarchar(500) NULL,
	   CONSTRAINT [PK_Logs] PRIMARY KEY CLUSTERED ([Id] ASC) 
	);

	CREATE INDEX IX1_Logs ON dbo.Logs ([Source],[TimeStamp]);

Settings for using Logger

Add the JSON below to appsettings.json

  "Logger": {
    "FiltersFields": "Senha,senha,Password,password",
    "Source": "LoggerTest",
    "Path": "C:\\Temp\\Log",
    "DBName": "Server=serverName; Database=dbName;Trusted_Connection=True;Application Name=Logger.Test;",
    "DBTableName": "tableName",
    "OutputTemplate": "[{Timestamp:dd/MM/yyyy HH:mm:ss} | {Level:u3}] [{LogType} | {MachineName} | {EnvironmentUserName} - {UserNameLog}] [{ContextName} | {EventName}]{NewLine}Message: {Message:lj}{NewLine}Error: {Exception}{NewLine}",
    "MinimumLevel": "Verbose",
    "WriteToConsole": true,
    "WriteToDB": true,
    "WriteToText": true
  }

Property|Required|Description FiltersFields|No|Words to remove the value in a Json Source|No|Start name of .log files Path|No|Path where the .log files will be saved DBName|No|ConnectionString where is the table that will store the logs DBTableName|No|Table name that will store the logs OutputTemplate|No|Template configuration that goes at the beginning of logs to .log files MinimumLevel|True|Indicates the minimum level that will be logged (Verbose, Debug, Information, Warning, Error, Fatal) WriteToConsole|True|Indicates that you will be logged into the application console WriteToDB|True|Indicates that it will be logged into a SQL Server database WriteToText|True|Indicates that it will be logged into a .log file

When Log Type is "Audit", MinimumLevel will always be considered as Verbose and WriteToDB will always be true.

Syntax Logger

All methods have the same syntax, we'll show you with the Verbose method

LoggerClass.Verbose("<message>", "<userName>");

Parameter|Required|Description message|True|Message that will be logged userName|No|Inform the user name that is generating the log

LoggerClass.Verbose("<message>", "<userName>", <logType>, <exception>, "<event>", "<context>");

Parameter|Required|Default Value|Description message|True||Message that will be logged logType|No|Application|Log type enumerator described above userName|No||Inform the user name that is generating the log exception|No|null|exception object event|No|null|string that will be logged in the Event field context|No|null|string that will be logged in the Context field

Code Examples

using Solution.Framework.Logger.Classes;
using Solution.Framework.Logger.Enums;
using Microsoft.Extensions.Configuration;

class Program
{
  static void Main(string[] args)
  {
    IConfiguration configuration = new ConfigurationBuilder()
      .AddJsonFile(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "..\\..\\..\\") + "\\appsettings.json")
      .Build();

    LoggerClass.Configuration = configuration;
    LoggerClass.Source = null;

    LoggerClass.Verbose("Logger Test", Environment.UserName);
    LoggerClass.Verbose("Logger Test", Environment.UserName, LogTypeEnum.Application, null, "Event", "Context");
  }
}

Where configuration is an IConfiguration object from appsettings.config described above. The Source property is optional, if it is null, the framework will get the value of appsettings.config.

Syntax MessageDefault

Method to assemble the system-wide default message

MessageDefault.Error("<exception>", "<includeTargetSite>");

Parameter|Required|Default Value|Description exception|True||parameter with two data types, Exception or ModelError includeTargetSite|No|false|insert or not the Target Site information in the standard message

Code Examples

using Solution.Framework.Logger.Classes;
using Solution.Framework.Logger.Enums;
using Microsoft.Extensions.Configuration;

class Program
{
  static void Main(string[] args)
  {
    try
    {

    }
    catch(Exception ex)
    {
        LoggerClass.Error("System error", LogTypeEnum.Application, Environment.UserName, MessageDefault.Error(ex), "Event", "Context");
    }
  }
}

Syntax EventLog

Method to write in Event Viewer (Application)

EventLogClass.Write("<message>", <eventLogEntryType>, <eventId>, <category>);

Parameter|Required|Default Value|Description message|True||message to write to event viewer eventLogEntryType|No|Information|message type eventId|No|0|Event Id category|No|0|Category

Code Examples

using Solution.Framework.Logger.Classes;

class Program
{
  static void Main(string[] args)
  {
    EventLogClass.Write("Message", EventLogEntryType.Information);
  }
}