Databases
StackOverflow2013
Postsdbo
POc# thread safe logging issue not using singleton
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POc# thread safe logging issue not using singleton
    primarykey
    data
    text
    <p>I'm creating a logging class in C# and I need it to be thread safe. I've implemented TextWriter.Synchronized and locks but I'm getting a very strange issue with the locks where they seem to not work.</p> <p>I don't want to use a singleton or a static class because I want to be able to have multiple instances of this logging class at any given time and I want to synchronize the threads based on the log's filename. So if I have 30 threads with 3 different instances of the Log class all using the same log file, it will synchronize properly and not have any issues. Below is what I've come up with so far. I've left out some of the code that is irrelevant, like the constructor and close/dispose.</p> <pre><code>public class Log : IDisposable { public enum LogType { Information, Warning, Error } private FileStream m_File; private TextWriter m_Writer; private string m_Filename; //this is used to hold sync objects per registered log file private static SortedList&lt;string, object&gt; s_SyncObjects = new SortedList&lt;string, object&gt;(); //this is used to lock and modify the above variable private static readonly object s_SyncRoot = new object(); public void WriteLine(Log.LogType MsgType, string Text) { //this is the problem i think, the lock isn't functioning correctly //see below this code for an example log file with issues lock (Log.s_SyncObjects[this.m_Filename]) { this.m_Writer.WriteLine(DateTime.Now.ToString("MM/dd/yyyy HH:mm:ss:fffffff") + " " + MsgType.ToString() + ": " + Text); } return; } public void Open(string Filename) { //make filename lowercase to ensure it's always the same this.m_Filename = Filename.ToLower(); this.m_File = new FileStream(Filename, FileMode.Append, FileAccess.Write, FileShare.ReadWrite); this.m_Writer = TextWriter.Synchronized(new StreamWriter(this.m_File) { AutoFlush = true }); //lock the syncroot and modify the collection of sync objects //this should make it so that every instance of this class no matter //what thread it's running in will have a unique sync object per log file lock (Log.s_SyncRoot) { if (!Log.s_SyncObjects.ContainsKey(this.m_Filename)) Log.s_SyncObjects.Add(this.m_Filename, new object()); } } } </code></pre> <p>To test this I'm creating 3 instances of the logger pointing to the same log file, creating 30 threads and assigning each thread one of the loggers (in order 1,2,3,1,2,3), then I run all 30 threads until I press q.</p> <p>This works great for writing line by line in a log file and keeping the times the writes happen in the correct order but here is what I get in the log file. It seems that the thread overwrites a portion of the log file and it seems to happen with different instances of the logger on different threads, never the same instance of the logger on different threads. The log file below has the time the entry was created, the logger ID (1 based), the thread ID (0 based) and the message "test".</p> <pre><code>08/27/2012 11:47:34:3469116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3469116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3469116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3469116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3469116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3469116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3479116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3479116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3479116 Information: LOGID: 1, THREADID: 9, MSG: test 08/27/2012 11:47:34:3479116 Information: LOGID08/27/2012 11:47:34:3479116 Information: LOGID: 3, THREADID: 23, MSG: test 08/27/2012 11:47:34:3479116 08/27/2012 11:47:34:3509118 Information: LOGID: 1, THREADID: 0, MSG: test 08/27/2012 11:47:34:3509118 Information: LOGID: 1, THREADID: 0, MSG: test 08/27/2012 11:47:34:3509118 Information: LOGID: 1, THREADID: 0, MSG: test 08/27/2012 11:47:34:3509118 Information: LOGID: 1, THREADID: 0, MSG: test 08/27/2012 11:47:34:3509118 Information: LOGID: 1, THREADID: 0, MSG: test </code></pre> <p>Notice that 2 of the lines have been mangled. I'm guessing this is due to the locks not working properly, or my misuse of the locks. I would also prefer not to use queuing or any kind of singleton. This behavior doesn't seem to happen if I change the lock within WriteLine to the m_SyncRoot variable and make it non-static. I have no idea why that works but to me it seems like that is not what I want to do. I also don't want to lock on a static m_SyncRoot alone because then if I have 3 instances of the logger pointing to 3 different log files then each one will block the other for no reason.</p> <p>I'm so lost on this, am I completely screwing this up?</p> <p>In case anyone needs it, here is the test class for generating the threads</p> <pre><code>public class LogTest { private Log m_Log1; private Log m_Log2; private Log m_Log3; private Thread[] m_Threads; private const int THREAD_COUNT = 30; private bool m_Done; public LogTest() { this.m_Log1 = new Log(); this.m_Log2 = new Log(); this.m_Log3 = new Log(); this.m_Log1.Open("test.txt"); this.m_Log2.Open("test.txt"); this.m_Log3.Open("test.txt"); this.m_Threads = new Thread[THREAD_COUNT]; this.m_Done = false; } public void run() { for (int i = 0; i &lt; THREAD_COUNT; i++) { Thread th = new Thread(new ParameterizedThreadStart(this.LogThread)); this.m_Threads[i] = th; } for (int i = 0; i &lt; THREAD_COUNT; i++) { int logId = 1; Log temp = this.m_Log1; if ((i % 3) == 1) { temp = this.m_Log2; logId = 2; } else if ((i % 3) == 2) { temp = this.m_Log3; logId = 3; } this.m_Threads[i].Start(new object[] { logId, i, temp }); } ConsoleKeyInfo key = new ConsoleKeyInfo(); while ((key = Console.ReadKey()).KeyChar != 'q') ; this.m_Done = true; } private void LogThread(object state) { int loggerId = (int)((object[])state)[0]; int threadId = (int)((object[])state)[1]; Log l = (Log)((object[])state)[2]; while (!this.m_Done) { l.WriteLine(Log.LogType.Information, String.Format("LOGID: {0}, THREADID: {1}, MSG: {2}", loggerId, threadId, "test")); } } } </code></pre> <p><strong>EDIT:</strong> edited to change static m_ to s_ as suggested and added the AutoFlush property to the StreamWriter; setting it to true... still does not work.</p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USvane
    1. USvane
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POc# thread safe logging issue not using singleton
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POc# thread safe logging issue not using singleton
      1. USDotNetRookie
      1. VTFavorite
    3. VO
      singulars
      1. POc# thread safe logging issue not using singleton
      1. This table or related slice is empty.
      1. VTUpMod
    1. COcode review: `m_` prefix is not used for static variables. `s_` is acceptable.
      singulars
      1. POc# thread safe logging issue not using singleton
      1. USAnkush
    2. COTake a look at [The concurrent_queue Container in VS2010](http://blogs.msdn.com/b/nativeconcurrency/archive/2009/11/23/the-concurrent-queue-container-in-vs2010.aspx)
      singulars
      1. POc# thread safe logging issue not using singleton
      1. USlsalamon
    3. COWhat about log4net or NLog?
      singulars
      1. POc# thread safe logging issue not using singleton
      1. USGSerjo
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload