|
That is embarrassing! Thanks Dewey!
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
Dear Gholan, When website users sign up , sign in, delete or send message etc, I want to log it. can minilog4net be suitable or is there better solution? Thank you in advance.
|
|
|
|
|
Yes, by all means, that is what it was created for.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
This is good stuff! Thanks for sharing it.
|
|
|
|
|
Thanks Hoya!
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
Since the format of a log entry is invariant.
It is better to use "a fixed length array + String.Concat(array)", instead of StringBuilder, since the former has better performance.
For the log parameters (objs in the log method), it is easy to just use one line of code to convert them to a string.
String.Join(Environment.NewLine, Array.ConvertAll (objs, (o)=>{return o == null ? String.Empty : o.ToString ())
modified 12-May-12 22:26pm.
|
|
|
|
|
Thanks WMJordan!
You are probably right StringBuilder is a bit heavy on startup, although I would have to test to make sure.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
Thank you for taking time to consider this small issue.
I have been told about the heavy configuration about Log4Net and I have never used it before.
BTW, I am going to develop my own logger above your work.
In production environment, the logging should not be heavy. But sometimes, it is necessary to temporally escalate the log level to address the problem which only occurs there. Simple dynamic configuration might be used. For example, in the configuration file, we simply specify the log level as None, Summary or Debug, then the framework uses a NonLogFormatter, SummaryLogFormatter and DebugLogFormatter respectively after the configuration file is modified.
I use my own configuration framework so the modification of the configuration file won't require the application being restarted. The only thing I am going to do is to develop a customizable log formatter interface to support different log levels.
The rest stuff in Log4Net, such as multiple log sink, dynamic configurable log format, etc. aren't my concern. Thank you for your neat article and code! It is giving me a good start.
|
|
|
|
|
I see you now save using a timer, but you don't explain why.
Was there a problem with the threading, and would it not have been solved by using TPL(although TPL would limit the .Net version to 4+)?
|
|
|
|
|
Thanks Dewey!
Threads have the following problem :
- the take up a lot of time setting up (using a profiler will verify)
- the loop had Thread.Sleep in it which is considered bad
The timer way is much cleaner code wise, and simpler to understand.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
I finally got around to doing some research on this, and you're 100% correct about the threads.
They take a lot of cycles setting up, and almost as much winding down. In addition, they allocate quite a bit of memory as well.
In my research, it turns out that Thread.Sleep is best used for testing, not production, and if used in production, it should be Thread.Sleep(0), which is almost of no use, LOL!
Thanks for the heads up, now I have some of my code to fix up!
|
|
|
|
|
Very nice Mehdi looks like a very useful tool.
Thanks for your effort.
|
|
|
|
|
Thanks Mike!
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
I have a test project in my solution which uses nUnit.
For the first test it is OK, but after that any test will fail with:
nUnitTester.Tester.EntitySaveAndLoad:
SetUp : System.IO.IOException : The process cannot access the file \Test\nUnitTester\bin\Debug\logs\Test.log; because it is being used by another process.
|
|
|
|
|
NUnit keeps the session/objects active in memory, so the files are still open.
Try closing the nunit gui and running again.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
Closing the GUI solves the problem, but it is frustrating.
Any way to close the file or dispose the logger I can put in TearDown?
|
|
|
|
|
Yes, null the objects you are using.
You can also change the private shutdown method to public and call that when you want.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
If the final destination is death, then we should enjoy every second of the journey.
|
|
|
|
|
|
Hi Mehdi
thanks for this nice piece of code!!
I'm using your logger in a webservice and I noticed it doesn't act properly with date logs: it continues to log on the same file.... the problem is it store the _lastFileDate in memory but if the process is recycled it resets the value and so it doesn't create a new file...
Thank you!
|
|
|
|
|
Interesting, I will look into it.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
|
|
|
|
|
Here is my modified version that fit my needs: it appends datetime to filename and then compare current datetime with the one extracted from filename in order to change log file; I also added a LogVerbosity to set threshold logging message...
using System;
using System.Collections;
using System.IO;
using System.Text;
using System.Threading;
using System.Globalization;
namespace MyLogger
{
public interface ILog
{
void Debug(object msg, params object[] objs);
void Error(object msg, params object[] objs);
void Info(object msg, params object[] objs);
void Warn(object msg, params object[] objs);
void Fatal(object msg, params object[] objs);
}
public enum LogVerbosity
{
FATAL = 0,
ERROR,
WARNING,
INFO,
DEBUG
}
internal class FileLogger
{
public static readonly FileLogger Instance = new FileLogger();
private FileLogger()
{
AppDomain.CurrentDomain.ProcessExit += new EventHandler(CurrentDomain_ProcessExit);
AppDomain.CurrentDomain.DomainUnload += new EventHandler(CurrentDomain_ProcessExit);
_worker = new Thread(new ThreadStart(Writer));
_worker.IsBackground = true;
_worker.Start();
}
private Thread _worker;
private bool _working = true;
private Queue _que = new Queue();
private StreamWriter _output;
private string _baseFilename;
private string _filename;
private int _sizeLimit = 0;
private long _lastSize = 0;
private DateTime _lastFileDate;
private bool _showMethodName = false;
private string _FilePath = "";
private const string dateTimeFormat = "yyyy-MM-dd";
private LogVerbosity _verbosity = LogVerbosity.DEBUG;
public bool ShowMethodNames
{
get { return _showMethodName; }
}
public LogVerbosity Verbosity
{
get { return _verbosity; }
set { _verbosity = value; }
}
public void Init(string filename, int sizelimitKB, bool showmethodnames, LogVerbosity verbosity)
{
_showMethodName = showmethodnames;
_sizeLimit = sizelimitKB;
_baseFilename = filename;
_filename = buildFilename();
_verbosity = verbosity;
_FilePath = Path.GetDirectoryName(filename);
if (_FilePath != "")
{
_FilePath = Directory.CreateDirectory(_FilePath).FullName;
if (_FilePath.EndsWith("\\") == false)
_FilePath += "\\";
}
_output = new StreamWriter(_filename, true);
FileInfo fi = new FileInfo(_filename);
_lastSize = fi.Length;
_lastFileDate = fi.LastWriteTime;
}
private string buildFilename()
{
return Path.Combine(Path.GetDirectoryName(_baseFilename), string.Format("{0}_{1}{2}", Path.GetFileNameWithoutExtension(_baseFilename), DateTime.Today.ToString(dateTimeFormat), Path.GetExtension(_baseFilename)));
}
private void shutdown()
{
_working = false;
_worker.Abort();
}
void CurrentDomain_ProcessExit(object sender, EventArgs e)
{
shutdown();
}
private void Writer()
{
while (_working)
{
while (_que.Count > 0)
{
object o = _que.Dequeue();
if (_output != null && o != null)
{
if (_sizeLimit > 0)
{
#region [ rolling size limit ]
_lastSize += ("" + o).Length;
if (_lastSize > _sizeLimit * 1000)
{
_output.Flush();
_output.Close();
int count = 1;
while (File.Exists(_FilePath + Path.GetFileNameWithoutExtension(_filename) + "." + count.ToString("0000")))
count++;
File.Move(_filename,
_FilePath +
Path.GetFileNameWithoutExtension(_filename) +
"." + count.ToString("0000"));
_output = new StreamWriter(_filename, true);
_lastSize = 0;
}
#endregion
}
string fileDate = _filename.Substring(_filename.LastIndexOf('_') + 1, dateTimeFormat.Length);
DateTime fileDateFromName = DateTime.ParseExact(fileDate, dateTimeFormat, CultureInfo.InvariantCulture);
if (DateTime.Now.Subtract(_lastFileDate).Days > 0 || DateTime.Now.Subtract(fileDateFromName).Days > 0)
{
#region [ rolling dates ]
_output.Flush();
_output.Close();
_filename = buildFilename();
_output = new StreamWriter(_filename, true);
_lastFileDate = DateTime.Now;
_lastSize = 0;
#endregion
}
_output.Write(o);
}
}
if (_output != null)
_output.Flush();
Thread.Sleep(500);
}
_output.Flush();
_output.Close();
}
private string FormatLog(string log, string type, string meth, string msg, object[] objs)
{
StringBuilder sb = new StringBuilder();
sb.AppendLine(
"" + DateTime.Now.ToString("dd'/'MM'/'yyyy HH:mm:ss.fff") +
"|" + log +
"|" + Thread.CurrentThread.ManagedThreadId +
"|" + type +
"|" + meth +
"| " + string.Format(msg, objs));
return sb.ToString();
}
public void Log(string logtype, string type, string meth, string msg, params object[] objs)
{
_que.Enqueue(FormatLog(logtype, type, meth, msg, objs));
}
}
internal class logger : ILog
{
public logger(Type type)
{
typename = type.Namespace + "." + type.Name;
}
private string typename = "";
private void log(string logtype, string msg, params object[] objs)
{
string meth = "";
if (FileLogger.Instance.ShowMethodNames)
{
System.Diagnostics.StackTrace st = new System.Diagnostics.StackTrace(2);
System.Diagnostics.StackFrame sf = st.GetFrame(0);
meth = sf.GetMethod().Name;
}
FileLogger.Instance.Log(logtype, typename, meth, msg, objs);
}
#region ILog Members
public void Debug(object msg, params object[] objs)
{
if(FileLogger.Instance.Verbosity >= LogVerbosity.DEBUG)
log("DEBUG", "" + msg, objs);
}
public void Error(object msg, params object[] objs)
{
if (FileLogger.Instance.Verbosity >= LogVerbosity.ERROR)
log("ERROR", "" + msg, objs);
}
public void Info(object msg, params object[] objs)
{
if (FileLogger.Instance.Verbosity >= LogVerbosity.INFO)
log("INFO", "" + msg, objs);
}
public void Warn(object msg, params object[] objs)
{
if (FileLogger.Instance.Verbosity >= LogVerbosity.WARNING)
log("WARN", "" + msg, objs);
}
public void Fatal(object msg, params object[] objs)
{
if (FileLogger.Instance.Verbosity >= LogVerbosity.FATAL)
log("FATAL", "" + msg, objs);
}
#endregion
}
public static class LogManager
{
public static ILog GetLogger(Type obj)
{
return new logger(obj);
}
public static void Configure(string filename, int sizelimitKB, bool showmethodnames, LogVerbosity verbosity)
{
FileLogger.Instance.Init(filename, sizelimitKB, showmethodnames, verbosity);
}
}
}
|
|
|
|
|
Great job
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
|
|
|
|
|
Can I use this to log to a database table instead of a text file?
|
|
|
|
|
Not in this version I'm afraid, you can however write the database code yourself, just implement your own writer method.
Its the man, not the machine - Chuck Yeager
If at first you don't succeed... get a better publicist
|
|
|
|
|
nice article.
Would be best if you mentioned the features your version is missing compared to the original log4net.
|
|
|
|
|