log.net

This is a logging utility for .Net projects.

TL;NR

Outputting logs is very easy. Include Log.cs in your project and code like this:

using zb;

Log.D("Hello bugs");
Log.I("For your information");
Log.W("Caution! Heaven is falling!");
Log.E("What's wrong? Heaven fell!");

The outputs look like this:

[2020/06/28 13:56:21][DEBUG][Test.cs(27)::Main] De bugs
[2020/06/28 13:56:21][INFO] For your information
[2020/06/28 13:56:21][WARN] Caution, the sky is falling!
[2020/06/28 13:56:21][ERROR][Test.cs(30)::Main] What's wrong? Heaven fell!

Support

• .Net Core 1.0 and above
• .Net Framework 4.5 and above

Introduction

As you might notice, there has extra information at the beginning of the log line, before the message you passed. The extra information inludes log level, logging time stamp, etc. And in DEBUG and ERROR logs, code file name, code line, method name are also included.

Do not use Log class instance to output log messages. In fact, instance can not be created by using new Log(); Do not bother with the boring stuffs. Just pass your messages to the public static methods in Log class:

• D(string msg) : outputing debug message
• I(string msg) : outputing info message
• W(string msg) : outputing warning message
• E(string msg) : outputing error message

Specify log file(s)

To tell the methods to which file to output the messages, there have two choices

1. If only one log file in the projects, Log.LogFile = "test/result.log"; before any log method being called. And call logging methods with one argument, e.g. Log.E(msg);
2. If multiple log files is desired, pass two arguments to the logging methods. The first one is message and the second one is log file. e.g. Log.W(msg, file);

Log levels

There have 4 log levels, the later the greater.

• DEBUG
• INFO
• WARNING
• ERROR

You can set messages at which level and above can be logged. The default log level is DEBUG in Debug mode, and INFO in Release mode.

In your product, sometimes even INFO is not desired I guess. In that case, before any logging methods called, Log.LogLevel = Log.Level.WARN; will do the trick. Now debug and info messages shut up, just WARN and ERROR will go to log file(s).

Performance

By default, the log file will be openned and closed each time outputting is done. This makes the performance worse. If checking on log alway occurs after application ended, add DefineConstants LOG_FILE_KEEP_OPENNING in the project file before build your project. This flag tells logger just open the log file once and do not close it unless the process exits. It make outputting 20~100 times faster.

Thread safe

By default, the outputting is not thread safe. To make it enabled, add DefineConstants of LOG_LOCK to project file. Also, locking make performance not good, so add it just when it's really needed.

---

Enjoy, and any bug reporting and suggestion is welcome.