Pixelo.Utils.CustomLogger 1.0.9

INTRODUCTION

With this library you can add registry for any activities with 4 different channels :

• Write on file
• Write on DB
• Send Email
• Send telegram on Bot

HOW TO

To set parameters you need to set two things:

1. You must edit appsettings.json on your WebApi ( this object must insert inside Logging, like this ) :

"CustomLogger": {
      "Options": {
        "schemaNameTable": "",
        "ApplicationName": "Design Pattern",
        "ConnectionString": "Data Source=<YOURIP>;Initial Catalog=<YOURDB>;Persist Security Info=True;User ID=sa;Password=<YOURPASSWORD>;",
        "fileOptions": {
          "FilePath": "log_{date}.log",
          "FolderPath": "C:\\logs\\"
        },
        "MailSetting": {
          "SMTPassword": "SMTPassword",
          "SMTPEnabledSSL": true,
          "SMTPHOST": "SMTPHOST",
          "SMTPMitt": "SMTPMitt",
          "SMTPMittDisplayName": "Design Pattern Alerts",
          "SMTPPORT": 587,
          "SMTPSendEmailTo": "a.chiodo@pixelo.it",
          "xsltPath": "C:\\Source\\Repos\\CustomLogger\\WebApiTest\\xslt\\mail.xslt",
          "SecondsCachingBetweenMessagesOnSameApplication": 6
        },
        "telegramOptions": {
          "TotRetry": [
            "00:00:10.0000000",
            "00:00:20.0000000"
          ],
          "httpStatusRetry": 429,
          "SecondsCachingBetweenMessagesOnSameApplication": 10,
          "chatId": "55555555555",
          "Api_Key": "387563510:AAENrZ3EOWksWA_5a001xxxxxxxxxxxxxxx"
        },
        "LogLevels": {
          "Information": [
            "SendToFile"
          ],
          "Warning": [
            "SendToFile",
            "SendToDB"
          ],
          "Error": [
            "SendToFile",
            "SendToDB",
            "SendEmail"
          ],
          "Critical": [
            "SendToFile",
            "SendToDB",
            "SendEmail",
            "SendTelegram"
          ]
        }
      }
    }

Add on program.cs this section :

//HTTPFACTORY
builder.Services.AddTransient<LoggerHandler>();
builder.Services.AddHttpClient<IhttpsClientHelper, httpsClientHelper>("httpsWithCertificate").ConfigureHttpClient(
    client => { })
    .ConfigurePrimaryHttpMessageHandler(() =>
        new httpBindingOptions().getCertificateForHttpHandler(
            builder.Configuration.GetSection("httpHelperOptions:certificatePath").Value,
            builder.Configuration.GetSection("httpHelperOptions:certificatepassword").Value
            )
).AddHttpMessageHandler<LoggerHandler>();
//HTTPFACTORY
//CUSTOMLOGGER
builder.Logging.AddCustomLogger(options => {
    builder
    .Configuration
    .GetSection("Logging")
    .GetSection("CustomLogger")
    .GetSection("Options")
    .Bind(options);
});
//CUSTOMLOGGER
//MIDDLEWARE
app.UseMiddleware<CustomLoggingMiddleWare>();
//MIDDLEWARE

DB objects:

Include on your DB these tables:

CREATE TABLE [dbo].[tTracert](
	[Id] [bigint] IDENTITY(1,1) NOT NULL,
	[MethodName] [varchar](max) NOT NULL,
	[LevelLog] [tinyint] NOT NULL,
	[Message] [varchar](max) NOT NULL,
	[TimeLog] [datetime] NOT NULL,
	[idTransazione] [varchar](max) NULL,
 CONSTRAINT [PK_tTracert_New] PRIMARY KEY CLUSTERED 
(
	[Id] ASC
)
GO
CREATE TABLE [dbo].[tTraceMessage](
	[Id] [bigint] IDENTITY(1,1) NOT NULL,
	[Request] [varchar](max) NULL,
	[Response] [varchar](max) NOT NULL,
	[TimeRequest] [datetime] NOT NULL,
	[TimeResponse] [datetime] NOT NULL,
	[Action] [varchar](max) NOT NULL,
	[IsHttpError] [bit] NULL,
	[reference] [varchar](250) NULL,
 CONSTRAINT [PK_tTraceMessage_New] PRIMARY KEY CLUSTERED 
(
	[Id] ASC
)

First table is for insert logs, second table is to trace any http request external on your project

An Example on your controller on web api can be :

    [ApiController]
    [Route("[controller]")]
    public class SampleController : ControllerBase {
        IhttpsClientHelper http;
        protected ILogger<Pixelo.Utils.CustomLogger> logger;
        public SampleController(ILogger<Pixelo.Utils.CustomLogger> _logger, IhttpsClientHelper _httpclient) {
            logger = _logger;
            http = _httpclient;
        }
        [HttpGet(Name = "GetLogs")]
        public IActionResult getLogs(string message, LogLevel logLevel) {
            logger.Log(logLevel, message);
            return Ok();
        }
        [HttpPost]
        public async Task<IActionResult> CallExternalHttp(string url) {
            HttpResponseMessage httpResponseMessage = await http.sendAsync(url, "application/json", "GET");
            if (httpResponseMessage.StatusCode == System.Net.HttpStatusCode.OK)
                return Ok(httpResponseMessage.Content.ReadAsStringAsync());
            else
                return Ok(httpResponseMessage.StatusCode.ToString());
        }
    }

CONSIDERATIONS

• About param SecondsCachingBetweenMessagesOnSameApplication this means how many seconds must be wait to send another message to avoid block of the Telegram Bot or SMTP Server
• TotRetry is used on Telegram message when response bot is http 429 (Too many requests: retry later) in this case with parameter httpStatusRetry we retry with array TotRetry
• To create a Bot telegram is vey simple, you can find an explanation here : https://learn.microsoft.com/en-us/azure/bot-service/bot-service-channel-connect-telegram?view=azure-bot-service-4.0