1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
namespace Tango.Logging
{
/// <summary>
/// Represents a helper class for logging information and errors.
/// </summary>
public static class LogManager
{
private static List<ILogger> _loggers;
private static ConcurrentQueue<LogItemBase> _logs;
private static Thread _loggingThread;
private static bool _isStarted;
/// <summary>
/// Gets or sets a value indicating whether to propagate logs instantly (Warning - not thread safe).
/// </summary>
public static bool OverrideQueue { get; set; }
/// <summary>
/// Initializes the <see cref="LogManager"/> class.
/// </summary>
static LogManager()
{
_loggers = new List<ILogger>();
_logs = new ConcurrentQueue<LogItemBase>();
Categories = new List<LogCategory>();
Categories.Add(LogCategory.Critical);
Categories.Add(LogCategory.Debug);
Categories.Add(LogCategory.Error);
Categories.Add(LogCategory.General);
Categories.Add(LogCategory.Warning);
}
/// <summary>
/// Gets or sets the logging categories filter.
/// </summary>
public static List<LogCategory> Categories { get; private set; }
/// <summary>
/// Registers a logger.
/// </summary>
/// <param name="logger">The logger.</param>
public static void RegisterLogger(ILogger logger)
{
if (logger != null && !_loggers.Contains(logger))
{
_loggers.Add(logger);
}
}
/// <summary>
/// Unregisters a logger.
/// </summary>
/// <param name="logger">The logger.</param>
public static void UnregisterLogger(ILogger logger)
{
if (logger != null && _loggers.Contains(logger))
{
_loggers.Remove(logger);
}
}
/// <summary>
/// Add new exception log item.
/// </summary>
/// <param name="e">Exception.</param>
/// <param name="description">Error description.</param>
public static Exception Log(Exception e, String description = null, [CallerMemberName] string caller = null, [CallerFilePath] string file = null, [CallerLineNumber] int lineNumber = 0)
{
return Log(e, LogCategory.Error, description, caller, file, lineNumber);
}
/// <summary>
/// Add new exception log item.
/// </summary>
/// <param name="e">Exception.</param>
/// <param name="description">Error description.</param>
public static Exception Log(Exception e, LogCategory category, String description = null, [CallerMemberName] string caller = null, [CallerFilePath] string file = null, [CallerLineNumber] int lineNumber = 0)
{
if (!Categories.Contains(category)) return e;
ExceptionLogItem log = new ExceptionLogItem();
log.CallerMethodName = caller;
log.CallerFile = file;
log.CallerLineNumber = lineNumber;
log.TimeStamp = DateTime.Now;
log.Exception = e;
log.Category = category;
log.Description = description != null ? description : e.ToString();
if (!OverrideQueue)
{
AppendLog(log);
}
else
{
AppendLogInstantly(log);
}
return e;
}
/// <summary>
/// Add new message log item.
/// </summary>
/// <param name="message">Message.</param>
public static String Log(String message, [CallerMemberName] string caller = null, [CallerFilePath] string file = null, [CallerLineNumber] int lineNumber = 0)
{
return Log(message, LogCategory.General, caller, file, lineNumber);
}
/// <summary>
/// Add new message log item.
/// </summary>
/// <param name="message">Message.</param>
public static String Log(String message, LogCategory category, [CallerMemberName] string caller = null, [CallerFilePath] string file = null, [CallerLineNumber] int lineNumber = 0)
{
if (!Categories.Contains(category)) return message;
MessageLogItem log = new MessageLogItem();
log.CallerMethodName = caller;
log.CallerFile = file;
log.CallerLineNumber = lineNumber;
log.TimeStamp = DateTime.Now;
log.Category = category;
log.Message = message;
if (!OverrideQueue)
{
AppendLog(log);
}
else
{
AppendLogInstantly(log);
}
return message;
}
/// <summary>
/// Appends the log.
/// </summary>
/// <param name="log">The log.</param>
private static void AppendLog(LogItemBase log)
{
if (log != null)
{
_loggers.Where(x => x.Enabled && x.Immediate).ToList().ForEach(x => x.OnLog(log));
}
_logs.Enqueue(log);
StartLoggingThread();
}
/// <summary>
/// Starts the logging thread.
/// </summary>
private static void StartLoggingThread()
{
if (!_isStarted)
{
_isStarted = true;
_loggingThread = new Thread(LoggingThreadMethod);
_loggingThread.IsBackground = true;
_loggingThread.Start();
}
}
/// <summary>
/// Loggings thread method.
/// </summary>
//[DebuggerStepThrough]
//[DebuggerHidden]
private static void LoggingThreadMethod()
{
while (_isStarted)
{
while (_logs.Count > 0)
{
LogItemBase log;
if (_logs.TryDequeue(out log))
{
if (log != null)
{
_loggers.Where(x => x.Enabled && !x.Immediate).ToList().ForEach(x => x.OnLog(log));
}
}
}
Thread.Sleep(10);
}
}
/// <summary>
/// Appends the log instantly.
/// </summary>
/// <param name="log">The log.</param>
[DebuggerStepThrough]
[DebuggerHidden]
private static void AppendLogInstantly(LogItemBase log)
{
bool wroteLog = false;
while (!wroteLog)
{
try
{
_loggers.Where(x => x.Enabled).ToList().ForEach(x => x.OnLog(log));
wroteLog = true;
}
catch
{
Thread.Sleep(5);
}
}
}
}
}
|