Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
C# super simple logger class - Blog post: https://heiswayi.nrird.com/simple-logger-utility
/*
MIT License
Copyright (c) 2019 Heiswayi Nrird
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
public class SimpleLogger
{
private const string FILE_EXT = ".log";
private readonly string datetimeFormat;
private readonly string logFilename;
/// <summary>
/// Initiate an instance of SimpleLogger class constructor.
/// If log file does not exist, it will be created automatically.
/// </summary>
public SimpleLogger()
{
datetimeFormat = "yyyy-MM-dd HH:mm:ss.fff";
logFilename = System.Reflection.Assembly.GetExecutingAssembly().GetName().Name + FILE_EXT;
// Log file header line
string logHeader = logFilename + " is created.";
if (!System.IO.File.Exists(logFilename))
{
WriteLine(System.DateTime.Now.ToString(datetimeFormat) + " " + logHeader, false);
}
}
/// <summary>
/// Log a DEBUG message
/// </summary>
/// <param name="text">Message</param>
public void Debug(string text)
{
WriteFormattedLog(LogLevel.DEBUG, text);
}
/// <summary>
/// Log an ERROR message
/// </summary>
/// <param name="text">Message</param>
public void Error(string text)
{
WriteFormattedLog(LogLevel.ERROR, text);
}
/// <summary>
/// Log a FATAL ERROR message
/// </summary>
/// <param name="text">Message</param>
public void Fatal(string text)
{
WriteFormattedLog(LogLevel.FATAL, text);
}
/// <summary>
/// Log an INFO message
/// </summary>
/// <param name="text">Message</param>
public void Info(string text)
{
WriteFormattedLog(LogLevel.INFO, text);
}
/// <summary>
/// Log a TRACE message
/// </summary>
/// <param name="text">Message</param>
public void Trace(string text)
{
WriteFormattedLog(LogLevel.TRACE, text);
}
/// <summary>
/// Log a WARNING message
/// </summary>
/// <param name="text">Message</param>
public void Warning(string text)
{
WriteFormattedLog(LogLevel.WARNING, text);
}
private void WriteLine(string text, bool append = true)
{
try
{
using (System.IO.StreamWriter writer = new System.IO.StreamWriter(logFilename, append, System.Text.Encoding.UTF8))
{
if (!string.IsNullOrEmpty(text))
{
writer.WriteLine(text);
}
}
}
catch
{
throw;
}
}
private void WriteFormattedLog(LogLevel level, string text)
{
string pretext;
switch (level)
{
case LogLevel.TRACE:
pretext = System.DateTime.Now.ToString(datetimeFormat) + " [TRACE] ";
break;
case LogLevel.INFO:
pretext = System.DateTime.Now.ToString(datetimeFormat) + " [INFO] ";
break;
case LogLevel.DEBUG:
pretext = System.DateTime.Now.ToString(datetimeFormat) + " [DEBUG] ";
break;
case LogLevel.WARNING:
pretext = System.DateTime.Now.ToString(datetimeFormat) + " [WARNING] ";
break;
case LogLevel.ERROR:
pretext = System.DateTime.Now.ToString(datetimeFormat) + " [ERROR] ";
break;
case LogLevel.FATAL:
pretext = System.DateTime.Now.ToString(datetimeFormat) + " [FATAL] ";
break;
default:
pretext = "";
break;
}
WriteLine(pretext + text);
}
[System.Flags]
private enum LogLevel
{
TRACE,
INFO,
DEBUG,
WARNING,
ERROR,
FATAL
}
}
@geomorillo

This comment has been minimized.

Copy link

geomorillo commented May 30, 2017

exelent let me test it

@VinS101

This comment has been minimized.

Copy link

VinS101 commented Mar 29, 2018

I see your code has dependencies on System.IO classes such as File and StreamWriter and System.DateTime. Would it improve the code if you inject these dependencies as interfaces via the constructor?

@doingnz

This comment has been minimized.

Copy link

doingnz commented Apr 13, 2018

The append parameter of private void WriteLine(string text, bool append = true) is never used in the code. It will always default to true.

The way the constructor is using the append parameter is not clear. You might consider something like this where the local instance of append is set to false to force the creation of the log file if it does not exist:

        public SimpleLogger(bool append = false)
        {
            DatetimeFormat = "yyyy-MM-dd HH:mm:ss.fff";
            Filename = Assembly.GetExecutingAssembly().GetName().Name + ".log";

            // Log file header line
            string logHeader = Filename + " is created.";
            if (!File.Exists(Filename))
            {
                append =false; // force the file to be created
            }

            if (append == false)
            {
                WriteLine(DateTime.Now.ToString(DatetimeFormat) + " " + logHeader, false);
            }
        }
@saleph

This comment has been minimized.

Copy link

saleph commented Sep 4, 2019

Neat, just fine for simple usage to 0-external-deps apps. Just a small suggestion regarding multithreaded environment:

    private readonly object fileLock = new object();
...
    private void WriteLine(string text, bool append = true)
    {
        if (string.IsNullOrEmpty(text)) 
        {
            return;
        }
        lock (fileLock) 
        {
            using (System.IO.StreamWriter writer = new System.IO.StreamWriter(logFilename, append, System.Text.Encoding.UTF8))
            {
                writer.WriteLine(text);
            }
        }
    }

Just to avoid exception during multiple access.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.