Auto status change to "Under Review"
@@ -1,65 +1,65 | |||
|
1 | 1 | namespace Implab.Diagnostics { |
|
2 | 2 | struct OperationContext { |
|
3 | 3 | public readonly static OperationContext EMPTY = new OperationContext(LogicalOperation.EMPTY, false); |
|
4 | 4 | |
|
5 | 5 | LogicalOperation m_initial; |
|
6 | 6 | LogicalOperation m_current; |
|
7 | 7 | bool m_ownership; |
|
8 | 8 | |
|
9 | 9 | public OperationContext(LogicalOperation operation, bool ownership) { |
|
10 | 10 | Safe.ArgumentNotNull(operation, "operation"); |
|
11 | 11 | |
|
12 | 12 | m_initial = operation; |
|
13 | 13 | m_current = operation; |
|
14 | 14 | m_ownership = ownership; |
|
15 | 15 | } |
|
16 | 16 | |
|
17 | 17 | public LogicalOperation CurrentOperation { |
|
18 | 18 | get { return m_current; } |
|
19 | 19 | } |
|
20 | 20 | |
|
21 | 21 | public void BeginLogicalOperation(string name) { |
|
22 | 22 | m_current = new LogicalOperation(name, m_current); |
|
23 | 23 | } |
|
24 | 24 | |
|
25 | 25 | public LogicalOperation DetachLogicalOperation() { |
|
26 | 26 | var detached = m_current; |
|
27 | 27 | if (m_current != LogicalOperation.EMPTY) { |
|
28 | 28 | if (m_current != m_initial) |
|
29 | 29 | m_current = m_current.Parent; |
|
30 | 30 | else if (m_ownership) |
|
31 | 31 | m_current = LogicalOperation.EMPTY; |
|
32 | 32 | else { |
|
33 |
TraceLog.TraceWarning("DetachLogicalOperation can't be |
|
|
33 | TraceLog.TraceWarning("DetachLogicalOperation can't be performed in the current context"); | |
|
34 | 34 | detached = LogicalOperation.EMPTY; |
|
35 | 35 | } |
|
36 | 36 | } else { |
|
37 |
TraceLog.TraceWarning("DetachLogicalOperation can't be |
|
|
37 | TraceLog.TraceWarning("DetachLogicalOperation can't be performed in the current context"); | |
|
38 | 38 | } |
|
39 | 39 | |
|
40 | 40 | return detached; |
|
41 | 41 | } |
|
42 | 42 | |
|
43 | 43 | public LogicalOperation EndLogicalOperation() { |
|
44 | 44 | var current = m_current; |
|
45 | 45 | if (m_current != LogicalOperation.EMPTY && (m_current != m_initial || m_ownership)) { |
|
46 | 46 | m_current = m_current.Parent; |
|
47 | 47 | if (current == m_initial) { |
|
48 | 48 | // we have complete the owned operation |
|
49 | 49 | m_initial = m_current; |
|
50 | 50 | m_ownership = false; |
|
51 | 51 | } |
|
52 | 52 | } else { |
|
53 |
TraceLog.TraceWarning("EndLogicalOperation can't be |
|
|
53 | TraceLog.TraceWarning("EndLogicalOperation can't be performed in the current context"); | |
|
54 | 54 | } |
|
55 | 55 | return current; |
|
56 | 56 | } |
|
57 | 57 | |
|
58 | 58 | public void Leave() { |
|
59 | 59 | |
|
60 | 60 | if ((m_ownership && m_current != LogicalOperation.EMPTY) || (!m_ownership && m_current != m_initial) ) |
|
61 | 61 | TraceLog.TraceWarning("Trying to leave unfinished logical operation {0}", m_current.Name); |
|
62 | 62 | } |
|
63 | 63 | } |
|
64 | 64 | } |
|
65 | 65 |
@@ -1,83 +1,82 | |||
|
1 | 1 | using System; |
|
2 | 2 | using System.Collections.Generic; |
|
3 | 3 | using System.Threading; |
|
4 | 4 | |
|
5 | 5 | namespace Implab.Diagnostics { |
|
6 | 6 | /// <summary> |
|
7 | 7 | /// Trace context is bound to the specific thread, each thread has it's own ThreadContext. |
|
8 | 8 | /// </summary> |
|
9 | 9 | /// <remarks> |
|
10 | 10 | /// ThreadContext manages relations between logical operations and threads. |
|
11 | 11 | /// </remarks> |
|
12 | 12 | public class TraceContext { |
|
13 | 13 | |
|
14 | 14 | [ThreadStatic] |
|
15 | 15 | static TraceContext _instance; |
|
16 | 16 | |
|
17 | 17 | OperationContext m_current = OperationContext.EMPTY; |
|
18 | 18 | readonly Stack<OperationContext> m_stack = new Stack<OperationContext>(); |
|
19 | 19 | readonly int m_threadId; |
|
20 | 20 | |
|
21 | 21 | public static TraceContext Instance { |
|
22 | 22 | get { |
|
23 | 23 | if (_instance == null) |
|
24 | 24 | _instance = new TraceContext(); |
|
25 | 25 | return _instance; |
|
26 | 26 | } |
|
27 | 27 | } |
|
28 | 28 | |
|
29 | 29 | public TraceContext() { |
|
30 | 30 | m_threadId = Thread.CurrentThread.ManagedThreadId; |
|
31 | 31 | } |
|
32 | 32 | |
|
33 | 33 | public int ThreadId { |
|
34 | 34 | get { return m_threadId; } |
|
35 | 35 | } |
|
36 | 36 | |
|
37 | 37 | public LogicalOperation CurrentOperation { |
|
38 | 38 | get { |
|
39 | 39 | return m_current.CurrentOperation; |
|
40 | 40 | } |
|
41 | 41 | } |
|
42 | 42 | |
|
43 | 43 | public void EnterLogicalOperation(LogicalOperation operation, bool takeOwnership) { |
|
44 | 44 | //var prev = CurrentOperation; |
|
45 | 45 | //LogChannel<TraceEvent>.Default.LogEvent(new TraceEvent(takeOwnership ? TraceEventType.Attach : TraceEventType.Enter, String.Format("{0} -> {1}",prev.Name, operation.Name))); |
|
46 | 46 | m_stack.Push(m_current); |
|
47 | 47 | m_current = new OperationContext(operation, takeOwnership); |
|
48 | 48 | } |
|
49 | 49 | |
|
50 | 50 | public void StartLogicalOperation(string name) { |
|
51 | 51 | LogChannel<TraceEvent>.Default.LogEvent(new TraceEvent(TraceEventType.OperationStarted, name)); |
|
52 | 52 | m_current.BeginLogicalOperation(name); |
|
53 | 53 | } |
|
54 | 54 | |
|
55 | 55 | public void StartLogicalOperation() { |
|
56 | 56 | StartLogicalOperation(String.Empty); |
|
57 | 57 | } |
|
58 | 58 | |
|
59 |
public |
|
|
60 |
|
|
|
61 | LogChannel<TraceEvent>.Default.LogEvent(new TraceEvent(TraceEventType.OperationCompleted, String.Format("-{0} : {1}ms",op.Name, op.Duration))); | |
|
59 | public LogicalOperation EndLogicalOperation() { | |
|
60 | return m_current.EndLogicalOperation(); | |
|
62 | 61 | } |
|
63 | 62 | |
|
64 | 63 | public LogicalOperation DetachLogicalOperation() { |
|
65 | 64 | var prev = m_current.DetachLogicalOperation(); |
|
66 | 65 | //LogChannel<TraceEvent>.Default.LogEvent(new TraceEvent(TraceEventType.Detach, String.Format("{0} -> {1}",prev.Name, CurrentOperation.Name))); |
|
67 | 66 | return prev; |
|
68 | 67 | } |
|
69 | 68 | |
|
70 | 69 | public void Leave() { |
|
71 | 70 | if (m_stack.Count > 0) { |
|
72 | 71 | m_current.Leave(); |
|
73 | 72 | //var prev = CurrentOperation; |
|
74 | 73 | m_current = m_stack.Pop(); |
|
75 | 74 | //LogChannel<TraceEvent>.Default.LogEvent(new TraceEvent(TraceEventType.Leave, String.Format("{0} -> {1}", prev.Name, CurrentOperation.Name))); |
|
76 | 75 | } else { |
|
77 | 76 | TraceLog.TraceWarning("Attempt to leave the last operation context"); |
|
78 | 77 | m_current = OperationContext.EMPTY; |
|
79 | 78 | } |
|
80 | 79 | } |
|
81 | 80 | } |
|
82 | 81 | } |
|
83 | 82 |
@@ -1,29 +1,47 | |||
|
1 | 1 | using System; |
|
2 | 2 | |
|
3 | 3 | namespace Implab.Diagnostics { |
|
4 | 4 | public class TraceEvent { |
|
5 | 5 | public string Message { |
|
6 | 6 | get; |
|
7 | 7 | private set; |
|
8 | 8 | } |
|
9 | 9 | |
|
10 | 10 | public TraceEventType EventType { |
|
11 | 11 | get; |
|
12 | 12 | private set; |
|
13 | 13 | } |
|
14 | 14 | |
|
15 | public TraceEvent(TraceEventType type, string message) { | |
|
15 | /// <summary> | |
|
16 | /// The logical operation this event belongs to. | |
|
17 | /// </summary> | |
|
18 | public LogicalOperation Operation { | |
|
19 | get; | |
|
20 | private set; | |
|
21 | } | |
|
22 | ||
|
23 | /// <summary> | |
|
24 | /// Gets the time offset in milliseconds from the start of the operation, if the operation is not specified the value is zero. | |
|
25 | /// </summary> | |
|
26 | public int OperationTime { | |
|
27 | get; | |
|
28 | private set; | |
|
29 | } | |
|
30 | ||
|
31 | public TraceEvent(LogicalOperation operation, TraceEventType type, string message) { | |
|
16 | 32 | EventType = type; |
|
17 | 33 | Message = message; |
|
34 | Operation = operation; | |
|
35 | if (operation != null) | |
|
36 | OperationTime = operation.Duration; | |
|
18 | 37 | } |
|
19 | 38 | |
|
20 | 39 | public override string ToString() { |
|
21 | /*return EventType == TraceEventType.Information ? Message : String.Format("{0}: {1}", EventType, Message);*/ | |
|
22 | 40 | return Message; |
|
23 | 41 | } |
|
24 | 42 | |
|
25 | public static TraceEvent Create(TraceEventType type, string format, params object[] args) { | |
|
26 | return new TraceEvent(type, format == null ? String.Empty : String.Format(format, args)); | |
|
43 | public static TraceEvent Create(LogicalOperation operation, TraceEventType type, string format, params object[] args) { | |
|
44 | return new TraceEvent(operation, type, format == null ? String.Empty : String.Format(format, args)); | |
|
27 | 45 | } |
|
28 | 46 | } |
|
29 | 47 | } |
@@ -1,50 +1,70 | |||
|
1 | 1 | using System; |
|
2 | 2 | using System.Collections.Generic; |
|
3 | 3 | using System.Diagnostics; |
|
4 | 4 | using System.Linq; |
|
5 | 5 | using System.Text; |
|
6 | 6 | using System.Threading.Tasks; |
|
7 | 7 | |
|
8 | 8 | namespace Implab.Diagnostics { |
|
9 | 9 | /// <summary> |
|
10 | /// ΠΠ»Π°ΡΡ Π΄Π»Ρ ΠΏΡΠ±Π»ΠΈΠΊΠ°ΡΠΈΠΈ ΡΠΎΠ±ΡΡΠΈΠΉ Π²ΡΠΏΠΎΠ»Π½Π΅Π½ΠΈΡ ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΡ, ΡΠΎΠ±ΡΡΠΈΡ ΠΏΡΠ±Π»ΠΈΠΊΡΡΡΡΡ ΡΠ΅ΡΠ΅Π· <see cref="LogChannel{TraceEvent}"/>. | |
|
11 | /// ΠΡΡΠ½Π°Π» ΡΡΠ°ΡΡΠΈΡΠΎΠ²ΠΊΠΈ ΠΎΡΡΠ°ΠΆΠ°Π΅Ρ Π»ΠΎΠ³ΠΈΡΠ΅ΡΠΊΠΈΠΉ Ρ ΠΎΠ΄ Π²ΡΠΏΠΎΠ»Π½Π΅Π½ΠΈΡ ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΡ ΠΈ ΡΡΡΠ΅ΡΡΠ²ΡΠ΅Ρ Π²ΡΠ΅Π³Π΄Π°, ΠΏΠΎΡΠΊΠΎΠ»ΡΠΊΡ ΡΠ΅ΡΠ½ΠΎ ΡΠ²ΡΠ·Π°Π½ Ρ | |
|
12 | /// ΠΊΠΎΠ½ΡΠ΅ΠΊΡΡΠΎΠΌ ΡΡΠ°ΡΡΠΈΡΠΎΠ²ΠΊΠΈ. | |
|
10 | /// This class is used to trace a logical flow of the application, it publishes events to the default <see cref="TraceEvent"/> channel. | |
|
13 | 11 | /// </summary> |
|
14 | 12 | public static class TraceLog { |
|
13 | /// <summary> | |
|
14 | /// Starts the logical operation nested to the current operation nested to the current one. | |
|
15 | /// </summary> | |
|
15 | 16 | [Conditional("TRACE")] |
|
16 | 17 | public static void StartLogicalOperation() { |
|
17 | 18 | TraceContext.Instance.StartLogicalOperation(); |
|
19 | ||
|
18 | 20 | } |
|
19 | 21 | |
|
22 | /// <summary> | |
|
23 | /// Starts the logical operation with the specified name, this name is usefull in logs. | |
|
24 | /// </summary> | |
|
25 | /// <param name="name">Name.</param> | |
|
20 | 26 | [Conditional("TRACE")] |
|
21 | 27 | public static void StartLogicalOperation(string name) { |
|
22 | 28 | TraceContext.Instance.StartLogicalOperation(name); |
|
23 | 29 | } |
|
24 | 30 | |
|
31 | /// <summary> | |
|
32 | /// Ends the logical operation and restores the previous one. | |
|
33 | /// </summary> | |
|
25 | 34 | [Conditional("TRACE")] |
|
26 | 35 | public static void EndLogicalOperation() { |
|
27 | TraceContext.Instance.EndLogicalOperation(); | |
|
36 | var op = TraceContext.Instance.EndLogicalOperation(); | |
|
37 | LogChannel<TraceEvent>.Default.LogEvent(new TraceEvent(TraceEventType.OperationCompleted, String.Format("-{0} : {1}ms",op.Name, op.Duration))); | |
|
28 | 38 | } |
|
29 | 39 | |
|
40 | /// <summary> | |
|
41 | /// Writes an informational message. | |
|
42 | /// </summary> | |
|
43 | /// <param name="format">Format.</param> | |
|
44 | /// <param name="arguments">Arguments.</param> | |
|
30 | 45 | [Conditional("TRACE")] |
|
31 | 46 | public static void TraceInformation(string format, params object[] arguments) { |
|
32 | 47 | LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Information, format, arguments)); |
|
33 | 48 | } |
|
34 | 49 | |
|
50 | /// <summary> | |
|
51 | /// Writes a warning message. | |
|
52 | /// </summary> | |
|
53 | /// <param name="format">Format.</param> | |
|
54 | /// <param name="arguments">Arguments.</param> | |
|
35 | 55 | [Conditional("TRACE")] |
|
36 | 56 | public static void TraceWarning(string format, params object[] arguments) { |
|
37 | 57 | LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Warning, format, arguments)); |
|
38 | 58 | } |
|
39 | 59 | |
|
40 | 60 | [Conditional("TRACE")] |
|
41 | 61 | public static void TraceError(string format, params object[] arguments) { |
|
42 | 62 | LogChannel<TraceEvent>.Default.LogEvent(TraceEvent.Create(TraceEventType.Error, format, arguments)); |
|
43 | 63 | } |
|
44 | 64 | |
|
45 | 65 | [Conditional("TRACE")] |
|
46 | 66 | public static void TraceError(Exception err) { |
|
47 | 67 | TraceError("{0}", err); |
|
48 | 68 | } |
|
49 | 69 | } |
|
50 | 70 | } |
General Comments 3
ok, latest stable version should be in default
You need to be logged in to leave comments.
Login now