Solution.Framework.Logger 7.0.2

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
• Email (only e-mail)
• EventLog (only Windows Event Log)

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,password,accesstoken,token",
    "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",
    "Source": "LoggerTest",
    "WriteToConsole": true,
    "ElasticLog": {
      "Url": "",
      "MinimumLevel": "Verbose"
    },
    "EmailLog": {
      "SmtpServer": "",
      "SmtpPort": 0,
      "EnableSsl": false,
      "From": "",
      "To": "",
      "Subject": ""
    },
    "MongoDBLog": {
      "DBName": "",
      "DBTableName": "",
      "DBAuditTableName": "",
      "MinimumLevel": "Verbose"
    },
    "MSTeamsLog": {
      "Webhook": "",
      "MinimumLevel": "Verbose"
    },
    "SqlServerLog": {
      "DBName": "",
      "DBTableName": "",
      "DBAuditTableName": "",
      "MinimumLevel": "Verbose"
    },
    "TextLog": {
      "Path": "",
      "MinimumLevel": "Verbose"
    }
  }
}

ElascticLog (Object to log into Elasticsearch - no required)

EmailLog (Object to log into E-mail - no required)

MongoDBLog (Object to log into MongoDB - no required)

MSTeamsLog (Object to log into MS Teams - no required)

SqlServerLog (Object to log into Sql Server - no required)

TextLog (Object to log into text file - no required)

When Log Type is "Audit", MongoDBLog or SqlServerLog required.

Syntax Logger

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

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

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

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, "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>");

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>);

Code Examples

using Solution.Framework.Logger.Classes;

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