##// END OF EJS Templates
implab » ImplabNet
RSS
improved trace system
cin -
r52:edf0bc558596 default
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,211 +1,238
1 using System;
1 using System;
2 using System.Collections.Generic;
2 using System.Collections.Generic;
3 using System.Linq;
3 using System.Linq;
4 using System.Text;
4 using System.Text;
5 using System.Threading;
5 using System.Threading;
6 using System.Threading.Tasks;
6 using System.Threading.Tasks;
7
7
8 namespace Implab.Diagnostics {
8 namespace Implab.Diagnostics {
9 /// <summary>
9 /// <summary>
10 /// Контекст трассировки, привязывается к потоку и содержит в себе информацию о стеке логических операций.
10 /// Контекст трассировки, привязывается к потоку и содержит в себе информацию о стеке логических операций.
11 /// </summary>
11 /// </summary>
12 /// <remarks>
12 /// <remarks>
13 /// Контекст трассировки передается слушателям событий для определения места, где возникло событие.
13 /// Контекст трассировки передается слушателям событий для определения места, где возникло событие.
14 /// </remarks>
14 /// </remarks>
15 public class TraceContext {
15 public class TraceContext {
16 LogicalOperation m_currentOperation;
16 LogicalOperation m_currentOperation;
17 readonly LogicalOperation m_bound;
17 readonly LogicalOperation m_bound;
18 readonly int m_threadId;
18 readonly int m_threadId;
19
19
20 [ThreadStatic]
20 [ThreadStatic]
21 static TraceContext _current;
21 static TraceContext _current;
22
22
23 /// <summary>
23 /// <summary>
24 /// Текущий контекст трассировки для потока, создается астоматически при первом обращении.
24 /// Текущий контекст трассировки для потока, создается астоматически при первом обращении.
25 /// </summary>
25 /// </summary>
26 public static TraceContext Current {
26 public static TraceContext Current {
27 get {
27 get {
28 if (_current == null) {
28 if (_current == null) {
29 _current = new TraceContext();
29 _current = new TraceContext();
30 _current.LogEvent(TraceEventType.Created,"[{0}]", _current.ThreadId);
30 _current.LogEvent(TraceEventType.Created,"[{0}]", _current.ThreadId);
31 }
31 }
32 return _current;
32 return _current;
33 }
33 }
34 }
34 }
35
35
36 TraceContext(TraceContext context)
36 TraceContext(TraceContext context)
37 : this(context, false) {
37 : this(context, false) {
38 }
38 }
39
39
40 TraceContext(TraceContext context, bool attach) {
40 TraceContext(TraceContext context, bool attach) {
41 if (context == null)
41 if (context == null)
42 throw new ArgumentNullException("context");
42 throw new ArgumentNullException("context");
43
43
44 m_currentOperation = context.CurrentOperation;
44 m_currentOperation = context.CurrentOperation;
45 m_bound = attach ? context.BoundOperation : context.CurrentOperation;
45 m_bound = attach ? context.BoundOperation : context.CurrentOperation;
46 m_threadId = Thread.CurrentThread.ManagedThreadId;
46 m_threadId = Thread.CurrentThread.ManagedThreadId;
47 }
47 }
48
48
49 TraceContext() {
49 TraceContext() {
50 m_currentOperation = new LogicalOperation();
50 m_currentOperation = new LogicalOperation();
51 m_bound = m_currentOperation;
51 m_bound = m_currentOperation;
52 m_threadId = Thread.CurrentThread.ManagedThreadId;
52 m_threadId = Thread.CurrentThread.ManagedThreadId;
53 }
53 }
54
54
55 /// <summary>
55 /// <summary>
56 /// При необходимости копирует состояние контекста трассивровки в текущий поток.
56 /// При необходимости копирует состояние контекста трассивровки в текущий поток.
57 /// </summary>
57 /// </summary>
58 /// <param name="from">Исходный контекст трассировки, который передается.</param>
58 /// <param name="from">Исходный контекст трассировки, который передается.</param>
59 /// <remarks>
59 /// <remarks>
60 /// <para>
60 /// <para>
61 /// Копирование происходит за счет создания нового контекста трассировки и заполнением его
61 /// Копирование происходит за счет создания нового контекста трассировки и заполнением его
62 /// состояния из переданного контекста. При этом копируется стек операций, однако в новом
62 /// состояния из переданного контекста. При этом копируется стек операций, однако в новом
63 /// контексте ранее начатые логические операции не могут быть завершены.
63 /// контексте ранее начатые логические операции не могут быть завершены.
64 /// </para>
64 /// </para>
65 /// <para>
65 /// <para>
66 /// Если передача состояния состоялась, то вызывается событие трассировки <see cref="TraceEventType.Fork"/>.
66 /// Если передача состояния состоялась, то вызывается событие трассировки <see cref="TraceEventType.Fork"/>.
67 /// </para>
67 /// </para>
68 /// </remarks>
68 /// </remarks>
69 public static void Fork(TraceContext from) {
69 public static void Fork(TraceContext from) {
70 if (_current == from)
70 if (_current == from)
71 return;
71 return;
72 if (from != null) {
72 if (from != null) {
73 var context = new TraceContext(from);
73 var context = new TraceContext(from);
74 context.LogEvent(TraceEventType.Fork, "[{0}]-->[{1}]",from.ThreadId, context.ThreadId);
74 context.LogEvent(TraceEventType.Fork, "[{0}]-->[{1}]",from.ThreadId, context.ThreadId);
75 _current = context;
75 _current = context;
76 } else {
76 } else {
77 _current = new TraceContext();
77 _current = new TraceContext();
78 }
78 }
79 }
79 }
80
80
81 /// <summary>
81 /// <summary>
82 /// Задает текущему потоку указанный контекст, текущей поток может заканчивать ранее начатые
82 /// Задает текущему потоку указанный контекст, текущей поток может заканчивать ранее начатые
83 /// логические операции в указанном контексте.
83 /// логические операции в указанном контексте.
84 /// </summary>
84 /// </summary>
85 /// <param name="source"></param>
85 /// <param name="source"></param>
86 public static void Attach(TraceContext source) {
86 public static void Attach(TraceContext source) {
87 if (_current == source)
87 if (_current == source)
88 return;
88 return;
89 if (source != null) {
89 if (source != null) {
90 var context = new TraceContext(source, true);
90 var context = new TraceContext(source, true);
91 context.LogEvent(TraceEventType.Attach, "[{0}]-->[{1}]", source.ThreadId, context.ThreadId);
91 context.LogEvent(TraceEventType.Attach, "[{0}]-->[{1}]", source.ThreadId, context.ThreadId);
92 _current = context;
92 _current = context;
93 } else {
93 } else {
94 _current = new TraceContext();
94 _current = new TraceContext();
95 }
95 }
96 }
96 }
97
97
98 /// <summary>
98 /// <summary>
99 /// Отсоединяет текущий контекст трассировки от потока, для дальнейшей его передачи другому потоку
99 /// Отсоединяет текущий контекст трассировки от потока, для дальнейшей его передачи другому потоку
100 /// <see cref="Attach(TraceContext)"/>.
100 /// <see cref="Attach(TraceContext)"/>.
101 /// </summary>
101 /// </summary>
102 /// <returns>Контекст трассировки потока</returns>
102 /// <returns>Контекст трассировки потока</returns>
103 /// <remarks>
103 /// <remarks>
104 /// После отсоединения контекста трассировки от потока, при первом обращении к трассировке в этом
104 /// После отсоединения контекста трассировки от потока, при первом обращении к трассировке в этом
105 /// потоке будет создан новый контекст.
105 /// потоке будет создан новый контекст.
106 /// </remarks>
106 /// </remarks>
107 public static TraceContext Detach() {
107 public static TraceContext Detach() {
108 var context = Current;
108 var context = Current;
109 context.LogEvent(TraceEventType.Detach, null);
109 context.LogEvent(TraceEventType.Detach, null);
110 _current = null;
110 _current = null;
111 return context;
111 return context;
112 }
112 }
113
113
114 /// <summary>
114 /// <summary>
115 /// Создает постоянную копию текущего контекста, данную копию можно хранить и использовать для передачи через <see cref="Fork(TraceContext)"/>
115 /// Создает постоянную копию текущего контекста, данную копию можно хранить и использовать для передачи через <see cref="Fork(TraceContext)"/>
116 /// </summary>
116 /// </summary>
117 /// <returns>Копия текущего контекста трассировки.</returns>
117 /// <returns>Копия текущего контекста трассировки.</returns>
118 public static TraceContext Snapshot() {
118 public static TraceContext Snapshot() {
119 return _current == null ? new TraceContext() : new TraceContext(_current);
119 return _current == null ? new TraceContext() : new TraceContext(_current,false);
120 }
120 }
121
121
122 /// <summary>
122 /// <summary>
123 /// Выполняет переданное действие в указанном контексте трассировки, по окончании восстанавливает предыдущий контекст трассировки потока.
123 /// Выполняет переданное действие в указанном контексте трассировки, по окончании восстанавливает предыдущий контекст трассировки потока.
124 /// </summary>
124 /// </summary>
125 /// <param name="action"></param>
125 /// <param name="action"></param>
126 public void Invoke(Action action) {
126 public void Invoke(Action action) {
127 if (action == null)
127 if (action == null)
128 throw new ArgumentNullException("action");
128 throw new ArgumentNullException("action");
129 var old = _current;
129 var old = _current;
130 Fork(this);
130 Fork(this);
131 try {
131 try {
132 action();
132 action();
133 } finally {
133 } finally {
134 if(_current != null)
134 _current.EndAllOperations();
135 _current.EndAllOperations();
135 _current = old;
136 _current = old;
136 }
137 }
137 }
138 }
138
139
139 /// <summary>
140 /// <summary>
140 /// Текущая логическая операция.
141 /// Текущая логическая операция.
141 /// </summary>
142 /// </summary>
142 public LogicalOperation CurrentOperation {
143 public LogicalOperation CurrentOperation {
143 get {
144 get {
144 return m_currentOperation;
145 return m_currentOperation;
145 }
146 }
146 }
147 }
147
148
148 /// <summary>
149 /// <summary>
149 /// Операция ниже которой нельзя опускаться в стеке логических операций, т.е. она не может быть завершена в текущем контексте.
150 /// Операция ниже которой нельзя опускаться в стеке логических операций, т.е. она не может быть завершена в текущем контексте.
150 /// </summary>
151 /// </summary>
151 public LogicalOperation BoundOperation {
152 public LogicalOperation BoundOperation {
152 get {
153 get {
153 return m_bound;
154 return m_bound;
154 }
155 }
155 }
156 }
156
157
157 /// <summary>
158 /// <summary>
158 /// Поток, в котором создан контекст трассировки.
159 /// Поток, в котором создан контекст трассировки.
159 /// </summary>
160 /// </summary>
160 public int ThreadId {
161 public int ThreadId {
161 get {
162 get {
162 return m_threadId;
163 return m_threadId;
163 }
164 }
164 }
165 }
165
166
166 /// <summary>
167 /// <summary>
167 /// Начинает безымянную логическую операцию.
168 /// Начинает безымянную логическую операцию.
168 /// </summary>
169 /// </summary>
169 public void StartLogicalOperation() {
170 public void StartLogicalOperation() {
170 StartLogicalOperation(null);
171 StartLogicalOperation(null);
171 }
172 }
172
173
173 /// <summary>
174 /// <summary>
174 /// Начинает логическую операцию с указанным именем. Созданная операция будет добвалена в стек логических операций контекста, затем будет создано соответсвующее событие.
175 /// Начинает логическую операцию с указанным именем. Созданная операция будет добвалена в стек логических операций контекста, затем будет создано соответсвующее событие.
175 /// </summary>
176 /// </summary>
176 /// <param name="name">Имя начинаемой операции.</param>
177 /// <param name="name">Имя начинаемой операции.</param>
177 public void StartLogicalOperation(string name) {
178 public void StartLogicalOperation(string name) {
178 m_currentOperation = new LogicalOperation(name, m_currentOperation);
179 m_currentOperation = new LogicalOperation(name, m_currentOperation);
179 LogEvent(TraceEventType.OperationStarted, name);
180 LogEvent(TraceEventType.OperationStarted, name);
180 }
181 }
181
182
182 /// <summary>
183 /// <summary>
183 /// Заканчивает логическую операцию начатую в текущем контексте. Операции, начатые в других контекстах не могут быть закончены в текущем контексте.
184 /// Заканчивает логическую операцию начатую в текущем контексте. Операции, начатые в других контекстах не могут быть закончены в текущем контексте.
184 /// </summary>
185 /// </summary>
185 /// <remarks>
186 /// <remarks>
186 /// При вызове данного метода создается событие журнала трассировки, либо о завершении операции, либо об ошибки, поскольку данная операция
187 /// При вызове данного метода создается событие журнала трассировки, либо о завершении операции, либо об ошибки, поскольку данная операция
187 /// начата в другом контексте.
188 /// начата в другом контексте.
188 /// </remarks>
189 /// </remarks>
189 public void EndLogicalOperation() {
190 public void EndLogicalOperation() {
190 if (m_bound == m_currentOperation) {
191 if (m_bound == m_currentOperation) {
191 LogEvent(TraceEventType.Error, "Trying to end the operation which isn't belongs to current trace");
192 LogEvent(TraceEventType.Error, "Trying to end the operation which isn't belongs to current trace");
192 } else {
193 } else {
193 var op = m_currentOperation;
194 var op = m_currentOperation;
194 LogEvent(TraceEventType.OperationCompleted, "{0} {1} ms", op.Name, op.Duration);
195 LogEvent(TraceEventType.OperationCompleted, "{0} {1} ms", op.Name, op.Duration);
195 m_currentOperation = m_currentOperation.Parent;
196 m_currentOperation = m_currentOperation.Parent;
196 }
197 }
197 }
198 }
198
199
199 /// <summary>
200 /// <summary>
201 /// Создает копию контекста и возвращается на предыдущую операцию в текущем контексте, это позволяет начать операцию в одном потоке, а завершить - в другом.
202 /// </summary>
203 /// <returns>Контекст трассировки, который можно присоединить к другому потоку.</returns>
204 public TraceContext DetachLogicalOperation() {
205 if (m_bound == m_currentOperation) {
206 return new TraceContext();
207 } else {
208 var detached = new TraceContext(this, true);
209 m_currentOperation = m_currentOperation.Parent;
210 return detached;
211 }
212 }
213
214 public void BindLogicalOperationToPromise(IPromiseBase promise) {
215 Safe.ArgumentNotNull(promise, "promise");
216
217 var ctx = DetachLogicalOperation();
218 promise.Finally(() => {
219 var old = _current;
220 TraceContext.Attach(ctx);
221 TraceContext.Current.EndLogicalOperation();
222 _current = old;
223 });
224 }
225
226 /// <summary>
200 /// Заврешает все начатые в этом контексте операции
227 /// Заврешает все начатые в этом контексте операции
201 /// </summary>
228 /// </summary>
202 public void EndAllOperations() {
229 public void EndAllOperations() {
203 while (m_bound != m_currentOperation)
230 while (m_bound != m_currentOperation)
204 EndLogicalOperation();
231 EndLogicalOperation();
205 }
232 }
206
233
207 void LogEvent(TraceEventType type, string format, params object[] args) {
234 void LogEvent(TraceEventType type, string format, params object[] args) {
208 LogChannel<TraceEvent>.Default.LogEvent(this, TraceEvent.Create(type, format, args));
235 LogChannel<TraceEvent>.Default.LogEvent(this, TraceEvent.Create(type, format, args));
209 }
236 }
210 }
237 }
211 }
238 }
Show file before | Show file after | Hide comments
@@ -1,31 +1,34
1 using System;
1 using System;
2 using System.Collections.Generic;
2 using System.Collections.Generic;
3 using System.Linq;
3 using System.Linq;
4 using System.Text;
4 using System.Text;
5
5
6 namespace Implab.Diagnostics {
6 namespace Implab.Diagnostics {
7 public class TraceEvent {
7 public class TraceEvent {
8 public string Message {
8 public string Message {
9 get;
9 get;
10 private set;
10 private set;
11 }
11 }
12
12
13 public TraceEventType EventType {
13 public TraceEventType EventType {
14 get;
14 get;
15 private set;
15 private set;
16 }
16 }
17
17
18 public TraceEvent(TraceEventType type, string message) {
18 public TraceEvent(TraceEventType type, string message) {
19 EventType = type;
19 EventType = type;
20 Message = message;
20 Message = message;
21 }
21 }
22
22
23 public override string ToString() {
23 public override string ToString() {
24 if (EventType == TraceEventType.Information)
25 return Message;
26 else
24 return String.Format("{0}: {1}", EventType, Message);
27 return String.Format("{0}: {1}", EventType, Message);
25 }
28 }
26
29
27 public static TraceEvent Create(TraceEventType type, string format, params object[] args) {
30 public static TraceEvent Create(TraceEventType type, string format, params object[] args) {
28 return new TraceEvent(type, format == null ? String.Empty : String.Format(format, args));
31 return new TraceEvent(type, format == null ? String.Empty : String.Format(format, args));
29 }
32 }
30 }
33 }
31 }
34 }
Show file before | Show file after | Hide comments
@@ -1,50 +1,55
1 using System;
1 using System;
2 using System.Collections.Generic;
2 using System.Collections.Generic;
3 using System.Diagnostics;
3 using System.Diagnostics;
4 using System.Linq;
4 using System.Linq;
5 using System.Text;
5 using System.Text;
6 using System.Threading.Tasks;
6 using System.Threading.Tasks;
7
7
8 namespace Implab.Diagnostics {
8 namespace Implab.Diagnostics {
9 /// <summary>
9 /// <summary>
10 /// Класс для публикации событий выполнения программы, события публикуются через <see cref="LogChannel{TraceEvent}"/>.
10 /// Класс для публикации событий выполнения программы, события публикуются через <see cref="LogChannel{TraceEvent}"/>.
11 /// Журнал трассировки отражает логический ход выполнения программы и существует всегда, поскольку тесно связан с
11 /// Журнал трассировки отражает логический ход выполнения программы и существует всегда, поскольку тесно связан с
12 /// контекстом трассировки.
12 /// контекстом трассировки.
13 /// </summary>
13 /// </summary>
14 public static class TraceLog {
14 public static class TraceLog {
15 [Conditional("TRACE")]
15 [Conditional("TRACE")]
16 public static void StartLogicalOperation() {
16 public static void StartLogicalOperation() {
17 TraceContext.Current.StartLogicalOperation();
17 TraceContext.Current.StartLogicalOperation();
18 }
18 }
19
19
20 [Conditional("TRACE")]
20 [Conditional("TRACE")]
21 public static void StartLogicalOperation(string name) {
21 public static void StartLogicalOperation(string name) {
22 TraceContext.Current.StartLogicalOperation(name);
22 TraceContext.Current.StartLogicalOperation(name);
23 }
23 }
24
24
25 [Conditional("TRACE")]
25 [Conditional("TRACE")]
26 public static void EndLogicalOperation() {
26 public static void EndLogicalOperation() {
27 TraceContext.Current.EndLogicalOperation();
27 TraceContext.Current.EndLogicalOperation();
28 }
28 }
29
29
30 [Conditional("TRACE")]
30 [Conditional("TRACE")]
31 public static void BindLogicalOperationToPromise(IPromiseBase promise) {
32 TraceContext.Current.BindLogicalOperationToPromise(promise);
33 }
34
35 [Conditional("TRACE")]
31 public static void TraceInformation(string format, params object[] arguments) {
36 public static void TraceInformation(string format, params object[] arguments) {
32 LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Information, format, arguments));
37 LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Information, format, arguments));
33 }
38 }
34
39
35 [Conditional("TRACE")]
40 [Conditional("TRACE")]
36 public static void TraceWarning(string format, params object[] arguments) {
41 public static void TraceWarning(string format, params object[] arguments) {
37 LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Warning, format, arguments));
42 LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Warning, format, arguments));
38 }
43 }
39
44
40 [Conditional("TRACE")]
45 [Conditional("TRACE")]
41 public static void TraceError(string format, params object[] arguments) {
46 public static void TraceError(string format, params object[] arguments) {
42 LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Error, format, arguments));
47 LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Error, format, arguments));
43 }
48 }
44
49
45 [Conditional("TRACE")]
50 [Conditional("TRACE")]
46 public static void TraceError(Exception err) {
51 public static void TraceError(Exception err) {
47 TraceError("{0}", err);
52 TraceError("{0}", err);
48 }
53 }
49 }
54 }
50 }
55 }
General Comments 0
You need to be logged in to leave comments. Login now