SimpLog 2.2.2

What is SimpLog

Simple and very flexible tool for development with .NET Core. Saves logs to a file, or a database where you want. Also gives opportunity to receive logs via email with the proper configuration.

Log Types in SimpLog

Features of SimpLog

📚 Database structure for logging into a database

You need two tables, no matter the database. The databases are as follows:

Scripts for creating tables:

if object_id('StoreLog', 'U') is null     
create table [StoreLog](        
    [ID] int IDENTITY(1,1) PRIMARY KEY,
    [Log_Type] varchar(50),
    [Log_Error] varchar(50),
    [Log_Created] varchar(50),
    [Log_FileName] varchar(50),
    [Log_Path] varchar(50),
    [Log_SendEmail] bit,
    [Email_ID] int,
    [Saved_In_Database] varchar(50)     
)  
if object_id('EmailLog', 'U') is null     
create table [EmailLog](        
    [ID] int IDENTITY(1,1) PRIMARY KEY,
    [From_Email] varchar(50),
    [To_Email] varchar(50),
    [Bcc] varchar(50),
    [Email_Subject] varchar(50),
    [Email_Body] varchar(50),
    [Time_Sent] varchar(50)     
) 

create table if not exists StoreLog(        
    ID int AUTO_INCREMENT PRIMARY KEY,
    Log_Type varchar(50),
    Log_Error varchar(50),
    Log_Created varchar(50),
    Log_FileName varchar(50),
    Log_Path varchar(50),
    Log_SendEmail bit,
    Email_ID int,
    Saved_In_Database varchar(50)     
); 

create table if not exists EmailLog(        
    ID int AUTO_INCREMENT PRIMARY KEY,
    From_Email varchar(50),
    To_Email varchar(50),
    Bcc varchar(50),
    Email_Subject varchar(50),
    Email_Body varchar(50),
    Time_Sent varchar(50)     
) 

create table if not exists StoreLog(     
    "ID" serial,
    "Log_Type" varchar(50),
    "Log_Error" varchar(50),
    "Log_Created" varchar(50),
    "Log_FileName" varchar(50),
    "Log_Path" varchar(50),
    "Log_SendEmail" boolean,
    "Email_ID" int,
    "Saved_In_Database" varchar(50)     
);  
create table if not exists EmailLog(     
    "ID" serial,
    "From_Email" varchar(50),
    "To_Email" varchar(50),
    "Bcc" varchar(50),
    "Email_Subject" varchar(50),
    "Email_Body" varchar(50),
    "Time_Sent" varchar(50)     
); 

There is no script, just creates two collections called EmailLog and StoreLog.

Configuration

In Program.cs

await ServicesExtensions.SimpLog();

In Controller

private readonly SimpLog _simpLog;

and call the log like

_simpLog.Trace("place your message here");

options are as follows

_simpLog.Info({1}, {2}, {3}, {4}, {5}); 

and only {1} is required

File Save Types | Name | Description | | ----- | ----- | | DontSave | This option disables saving into a file only when called for the specific case! | | Standart | Opens file, saves it and closes file. On every request it opens and closes again the file | | BufferMemory | Creates buffer memory and a background process is also working in this case. When the information in the buffer become more than 95 characters, opens log file, saves the content and closes it. It is not on every request but on 95 symbols or every minute. Possible data loss in this case! |

In simplog.json

Create simplog.json file in the root folder of your startup project. On the same level where is appsettings.json. Please have in mind that every configuration in simplog.json is optional ☺️

  "SimpLog": {                              -> all of the below fields are optional
    "Main": {
      "WhyLogIsNotWorkingPath": string,     ->  If you want it to be saved somewhere else, just place here the path. Default value is
      "WhyLogIsNotWorkingFileName": string, ->  The file name of the custom log for the SimpLog library. If you need our support, needs to be send the content of this file.
      "Disable_Log": bool                   ->  If you want to disable SimpLog library log for library issues, then turn it to true. Default value is
    },
    "File_Configuration": {                 -> The configuration for log into a file.
      "PathToSaveLogs": string,             -> Path to save the log. Default is
      "LogFileName": string,                -> Log name of the log. Default value is
      "Enable_File_Log": bool               -> Default value is true. If you want to disable the file log, should be set to false. Default value is
    },
    "Email_Configuration": {                -> Email configuration.
      "SendEmail_Globally": bool,           -> Field to disable sending emails globally. Default value is true.
      "Email_From": string,                 -> Who will be the sender of your emails.
      "Email_To": string,                   -> Who will be the recipient of the emails.
      "Email_BCC": string,                  -> If you want, you can add blind copy.
      "Email_Connection": {                 -> Email configuration to the email service provider.
        "Host": string,
        "Port": string,
        "API_Key": string,
        "API_Value": string
      }
    },
    "Database_Configuration": {             -> Database configurations
      "Connection_String": string,          -> Depending on database type, use the correct connection string.
      "Global_Database_Type": string,       -> The type of a database. Please spell it correctly "MSSql" or "MySql" or "Postgre" or "MongoDb". N.B! Be carefull with spelling!
      "Use_OleDB": bool,                    -> Still not implementet, not any functionality here.
      "Global_Enabled_Save": bool           -> You can globally disable or enable saving into database. Default value is
    },
    "LogType": {
      "Trace": {                            -> TYPE OF LOG == Trace.
        "Log": true,                        -> For the type Trace, should be enabled or disabled logging into a file. Default value is true.
        "SendEmail": true,                  -> For the TYPE OF LOG, should be enabled or disabled sending emails. Default value is true.
        "SaveInDatabase": true              -> For the TYPE OF LOG, should be enabled saving into database. Default value is true.
      },
      "Debug": {                            -> Analogically TYPE OF LOG here is Debug 
        "Log": true,
        "SendEmail": true,
        "SaveInDatabase": true
      },
      "Info": {                             -> Analogically TYPE OF LOG here is Info
        "Log": true,
        "SendEmail": true,
        "SaveInDatabase": true
      },
      "Notice": {                           -> Analogically TYPE OF LOG here is Notice
        "Log": true,
        "SendEmail": true,
        "SaveInDatabase": true
      },
      "Warn": {                             -> Analogically TYPE OF LOG here is Warn
        "Log": true,
        "SendEmail": true,
        "SaveInDatabase": true
      },
      "Error": {                            -> Analogically TYPE OF LOG here is Error
        "Log": true,
        "SendEmail": true,
        "SaveInDatabase": true
      },
      "Fatal": {                            -> Analogically TYPE OF LOG here is Fatal
        "Log": true,
        "SendEmail": true,
        "SaveInDatabase": true
      }
    }
  }

Hope you enjoy the NuGet Package! 😉