MsSqlLoggerService 1.2.0

MsSQLLoggerService

This service implements the ILoggerService from the MethodResultWrapper nuGet package using an Ms Sql database table as persistence layer

Instantiate the service by invoking its constructor;

Pre-conditions for this service to work property

The connection string provided should allow inserting rows into a table that should conform to the following DDL.

Loggin table definition example

CREATE TABLE [dbo].[Log] ( Id [int] IDENTITY(1,1) NOT NULL, [UserId] varchar NULL, [CompanyId] varchar NULL, [SeverityCode] char NOT NULL, [MachineName] varchar NOT NULL, [Context] varchar NOT NULL, [Message] nvarchar NOT NULL, [CreateDateUtc] [datetime] NOT NULL,

CONSTRAINT [PK_Log] 
	PRIMARY KEY CLUSTERED [Id] DESC

);

Columns

Id

The Id column is not required and will not be populted by the service. However it might be convenient to have a primary column sorted DESC so that the last logs will be at the top of a select statement by default. If you define this column make sure the database will fill it accordingly by for example using the IDENTITY keyword

UserId (default column name)

• You can provide your own column name for this column
• The userId column persists the identification of the connected user if any.
• This column should be nullable.
• This column should be of type varchar
• The logger will truncate any info exceding the max column length

CompanyId (default column name)

• You can provide your own column name for this column
• The companyId column persists the identification of the company of the connected user if any.
• This column should be nullable.
• This column should be of type varchar
• The logger will truncate any info exceding the max column length

SeverityCode (default column name)

• You can provide your own column name for this column
• The SeverityCode column persists the MethodResultWrapper.SeverityEnum code
• This column should be non nullable.
• This column should be of type char (one char is enough)

MachineName (default column name)

• You can provide your own column name for this column
• The CompanyName column persists Environment.MachineName.
• This column should be non nullable.
• This column should be of type varchar
• The logger will truncate any info exceding the max column length

Context (default column name)

• You can provide your own column name for this column
• The Context column persists class file, method name and code line number.
• This column should be non nullable.
• This column should be of type varchar
• The logger will truncate any info exceding the max column length

Message (default column name)

• You can provide your own column name for this column
• The Message column persists the message info.
• This column should be non nullable.
• This column should be of type nvarchar(MAX)

CreateDateUtc (default column name)

• You can provide your own column name for this column
• The Message column persists the UTC date.
• This column should be non nullable.
• This column should be of type datetime

Usage

Example 1 : providing your own values for the schema, table and column names

using System; using pvWay.MethodResultWrapper; using pvWay.MsSqlLoggerService;

namespace MsSqlLoggerServiceLab { internal static class Program { private static void Main(/string[] args/) { const string cn = "data source=Localhost;initial catalog=iota_PRD_20200208;" + "integrated security=True;MultipleActiveResultSets=True;";

        var ls = new Logger(
            cn,
            SeverityEnum.Debug,
            "dbo",
            "Log",
            "UserId",
            "CompanyId",
            "MachineName",
            "SeverityCode",
            "Context",
            "Message",
            "CreateDateUtc",
            "me",
            "myCompany");

        ls.Log(new Exception());

        Console.WriteLine("hit enter to quit");
        Console.ReadLine();
    }
}

}

Example 2 : using all default values

using System; using pvWay.MethodResultWrapper; using pvWay.MsSqlLoggerService;

namespace MsSqlLoggerServiceLab { internal static class Program { private static void Main(/string[] args/) { const string cn = "data source=Localhost;initial catalog=iota_PRD_20200208;" + "integrated security=True;MultipleActiveResultSets=True;";

        var ls = new Logger(cn);

		ls.SetUser("me", "myCompany");

        ls.Log(new Exception());

        Console.WriteLine("hit enter to quit");
        Console.ReadLine();
    }
}

}