LogFaast 1.4.0

Developreh.LogFaast

The packgage contains RELEASE version of the dlls.

Blazing fast and simple application logger with:

• tens of thousands processed log entries per seccond
• minimal configuration,
• no instantiation needed,
• logs important informations to ease debugging,
• no dependencies,
• thread safe, log from multiple threads independently,
• log files split after approximately 24000 log entries in the log file (depends of the log queue load),
• zipping closed log files to save disk space,
• works on Windows and Linux as well (Mac is not tested).

Supported log levels:

• Debug (dbg)
• Info (inf)
• Warining (war)
• Error (err)
• Fatal (fatal)
• Exception (exc)

How to:

• LoggerConfig.xml, this configuration file needs to be placed in the directory of the executable.

• The only configuration there is, it is to provide directory for log files in LoggerConfig.xml file, with LogPath xml element.

• LoggerConfig.xml content:

  • On Windows:

  <?xml version="1.0" encoding="utf-8" ?>
  <LogConfig>
        <LogPath value="c:\ProgramData\OrganizationName\_Logfiles" type="string" />
  </LogConfig>
  

  • On Linux:

  <?xml version="1.0" encoding="utf-8" ?>
  <LogConfig>
        <LogPath value="/tmp/OrganizationName/_Logfiles" type="string" />
  </LogConfig>
  

• The last folder in the directory structure for log files is created by the logger itself.

  • It is the assembly name of the programm which utilizes this blazing fast logger.

• New log files are created when there is at least 1GB (1024 * 1024 * 1024 bytes) free space on the hard drive.

  • When there is less then 1GB of space, new log files will not be created and logs will be lost.

• And remember, the logger needs to have permission to write to the configured folder to log.

  • When there is an error creating configured directory structure, or other when initializing the logger (missong configuration file LoggerConfig.xml for instance), then the logger will throw an according exception.

• When there is an error within the logger itself, this error is sent to Console.Error output as well as into the txt file AssemblyName-ProcessId-InternalLoggerError.txt -> AwesomeSw-8795-InternalLoggerError.txt placed into the currently logged in user home directory, for instance:

  • On Windows:

  c:\Users\LoggedInUser\AwesomeSw-8795-InternalLoggerError.txt
  

  • On Linux:

  /home/loggedinuser/AwesomeSw-8795-InternalLoggerError.txt
  

Log Interfaces to Use:

Log.Exc(Exception e, string? message = null)
Log.Exc(Exception e, string format, params object[] logMsgs)

Log.Fatal(string? message, Exception? e = null)
Log.Fatal(string format, params object[] logMsgs)

Log.Err(string? message, Exception? e = null)
Log.Err(string format, params object[] logMsgs)

Log.War(string? message, Exception? e = null)
Log.War(string format, params object[] logMsgs)

Log.Inf(string? message)
Log.Inf(string format, params object[] logMsgs)

Log.Dbg(string? message)
Log.Dbg(string format, params object[] logMsgs)

• For instance:

public static void Main(string[] args)
{
    Log.Err($"An unpleasant error has occured. p1: {param1}, p2: {param2}");
    Log.Err("An unpleasant error has occured. p1: {0}, p2: {1}", param1, param2);
}

Log File Content:

Content of the log file is as follows:

time in format yyyy.MM.dd HH:mm:ss.fff, File Name  , line number,   Method Name , Thread Id, Thread Name, log level,And a message which was logged.

2024.02.01 18:01:46.343,                FileName.cs,          22,   MethodName(),         3,  ThreadName,       war,Logged message.

IMPORTANT note when logging the JSON strings with Log method that contains params parameter:

• When using Log methods with params parameter (eg. Log.Dbg(string format, params object[] logMsgs)) and one of the parameter is JSON string, than the method needs to be structured as follows, otherwise FormatException will be thrown:

  Log.Dbg("Message: {0}", json);

  • When the log message already contains JSON string, the only way how to write such a message with embeded JSON is this way: Log.Dbg("{0}", logMessageWithJson);
  • Other ways to write JSON strings with methods utilizing params interface result in the FormatException, like:
    • string interpolation: Log.Dbg($"{json}");
    • string concatenation: Log.Dbg("Received JSON: " + json); , or Log.Dbg(json); , or even Log.Dbg(logMessageWithJson);