-
Notifications
You must be signed in to change notification settings - Fork 799
/
LogEvent.cs
276 lines (246 loc) · 11.9 KB
/
LogEvent.cs
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
// Copyright 2013-2015 Serilog Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using System.Diagnostics;
// ReSharper disable IntroduceOptionalParameters.Global
namespace Serilog.Events;
/// <summary>
/// A log event.
/// </summary>
public class LogEvent
{
readonly Dictionary<string, LogEventPropertyValue> _properties;
ActivityTraceId _traceId;
ActivitySpanId _spanId;
LogEvent(
DateTimeOffset timestamp,
LogEventLevel level,
Exception? exception,
MessageTemplate messageTemplate,
Dictionary<string, LogEventPropertyValue> properties,
ActivityTraceId traceId,
ActivitySpanId spanId)
{
Timestamp = timestamp;
Level = level;
Exception = exception;
_traceId = traceId;
_spanId = spanId;
MessageTemplate = Guard.AgainstNull(messageTemplate);
_properties = Guard.AgainstNull(properties);
}
/// <summary>
/// Construct a new <seealso cref="LogEvent"/>.
/// </summary>
/// <param name="timestamp">The time at which the event occurred.</param>
/// <param name="level">The level of the event.</param>
/// <param name="exception">An exception associated with the event, or null.</param>
/// <param name="messageTemplate">The message template describing the event.</param>
/// <param name="properties">Properties associated with the event, including those presented in <paramref name="messageTemplate"/>.</param>
/// <exception cref="ArgumentNullException">When <paramref name="messageTemplate"/> is <code>null</code></exception>
/// <exception cref="ArgumentNullException">When <paramref name="properties"/> is <code>null</code></exception>
public LogEvent(DateTimeOffset timestamp, LogEventLevel level, Exception? exception, MessageTemplate messageTemplate, IEnumerable<LogEventProperty> properties)
: this(timestamp, level, exception, messageTemplate, properties, default, default)
{
}
/// <summary>
/// Construct a new <seealso cref="LogEvent"/>.
/// </summary>
/// <param name="timestamp">The time at which the event occurred.</param>
/// <param name="level">The level of the event.</param>
/// <param name="exception">An exception associated with the event, or null.</param>
/// <param name="messageTemplate">The message template describing the event.</param>
/// <param name="properties">Properties associated with the event, including those presented in <paramref name="messageTemplate"/>.</param>
/// <param name="traceId">The id of the trace that was active when the event was created, if any.</param>
/// <param name="spanId">The id of the span that was active when the event was created, if any.</param>
/// <exception cref="ArgumentNullException">When <paramref name="messageTemplate"/> is <code>null</code></exception>
/// <exception cref="ArgumentNullException">When <paramref name="properties"/> is <code>null</code></exception>
[CLSCompliant(false)]
public LogEvent(DateTimeOffset timestamp, LogEventLevel level, Exception? exception, MessageTemplate messageTemplate, IEnumerable<LogEventProperty> properties, ActivityTraceId traceId, ActivitySpanId spanId)
: this(timestamp, level, exception, messageTemplate, new Dictionary<string, LogEventPropertyValue>(), traceId, spanId)
{
Guard.AgainstNull(properties);
foreach (var property in properties)
AddOrUpdateProperty(property);
}
internal LogEvent(DateTimeOffset timestamp, LogEventLevel level, Exception? exception, MessageTemplate messageTemplate, EventProperty[] properties, ActivityTraceId traceId, ActivitySpanId spanId)
: this(timestamp, level, exception, messageTemplate, new Dictionary<string, LogEventPropertyValue>(Guard.AgainstNull(properties).Length), traceId, spanId)
{
for (var i = 0; i < properties.Length; ++i)
_properties[properties[i].Name] = properties[i].Value;
}
/// <summary>
/// The time at which the event occurred.
/// </summary>
public DateTimeOffset Timestamp { get; }
/// <summary>
/// The level of the event.
/// </summary>
public LogEventLevel Level { get; }
/// <summary>
/// The id of the trace that was active when the event was created, if any.
/// </summary>
[CLSCompliant(false)]
public ActivityTraceId? TraceId => _traceId == default ? null : _traceId;
/// <summary>
/// The id of the span that was active when the event was created, if any.
/// </summary>
[CLSCompliant(false)]
public ActivitySpanId? SpanId => _spanId == default ? null : _spanId;
/// <summary>
/// The message template describing the event.
/// </summary>
public MessageTemplate MessageTemplate { get; }
/// <summary>
/// Render the message template to the specified output, given the properties associated
/// with the event.
/// </summary>
/// <param name="output">The output.</param>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
public void RenderMessage(TextWriter output, IFormatProvider? formatProvider = null)
{
MessageTemplate.Render(Properties, output, formatProvider);
}
/// <summary>
/// Render the message template given the properties associated
/// with the event, and return the result.
/// </summary>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
public string RenderMessage(IFormatProvider? formatProvider = null)
{
return MessageTemplate.Render(Properties, formatProvider);
}
/// <summary>
/// Properties associated with the event, including those presented in <see cref="LogEvent.MessageTemplate"/>.
/// </summary>
public IReadOnlyDictionary<string, LogEventPropertyValue> Properties => _properties;
/// <summary>
/// An exception associated with the event, or null.
/// </summary>
public Exception? Exception { get; }
/// <summary>
/// Add a property to the event if not already present, otherwise, update its value.
/// </summary>
/// <param name="property">The property to add or update.</param>
/// <exception cref="ArgumentNullException">When <paramref name="property"/> is <code>null</code></exception>
public void AddOrUpdateProperty(LogEventProperty property)
{
Guard.AgainstNull(property);
_properties[property.Name] = property.Value;
}
/// <summary>
/// Add a property to the event if not already present, otherwise, update its value.
/// </summary>
/// <param name="property">The property to add or update.</param>
/// <exception cref="ArgumentNullException">When <paramref name="property"/> is <code>default</code></exception>
internal void AddOrUpdateProperty(in EventProperty property)
{
if (property.Equals(EventProperty.None)) throw new ArgumentNullException(nameof(property));
_properties[property.Name] = property.Value;
}
/// <summary>
/// Add a property to the event if not already present.
/// </summary>
/// <param name="property">The property to add.</param>
/// <exception cref="ArgumentNullException">When <paramref name="property"/> is <code>null</code></exception>
public void AddPropertyIfAbsent(LogEventProperty property)
{
Guard.AgainstNull(property);
#if FEATURE_DICTIONARYTRYADD
_properties.TryAdd(property.Name, property.Value);
#else
if (!_properties.ContainsKey(property.Name))
_properties.Add(property.Name, property.Value);
#endif
}
/// <summary>
/// Add a property to the event if not already present.
/// </summary>
/// <param name="property">The property to add.</param>
/// <exception cref="ArgumentNullException">When <paramref name="property"/> is <code>default</code></exception>
internal void AddPropertyIfAbsent(in EventProperty property)
{
if (property.Equals(EventProperty.None)) throw new ArgumentNullException(nameof(property));
#if FEATURE_DICTIONARYTRYADD
_properties.TryAdd(property.Name, property.Value);
#else
if (!_properties.ContainsKey(property.Name))
_properties.Add(property.Name, property.Value);
#endif
}
internal void AddPropertyIfAbsent(ILogEventPropertyFactory factory, string name, object? value, bool destructureObjects = false)
{
if (!_properties.ContainsKey(name))
{
_properties.Add(
name,
factory is ILogEventPropertyValueFactory factory2
? factory2.CreatePropertyValue(value, destructureObjects)
: factory.CreateProperty(name, value, destructureObjects).Value);
}
}
/// <summary>
/// Remove a property from the event, if present. Otherwise no action
/// is performed.
/// </summary>
/// <param name="propertyName">The name of the property to remove.</param>
public void RemovePropertyIfPresent(string propertyName)
{
_properties.Remove(propertyName);
}
/// <summary>
/// Construct a <see cref="LogEvent"/> using pre-allocated values for internal fields. Normally,
/// the <see cref="LogEvent"/> constructor allocates a dictionary to back <see cref="Properties"/>,
/// so that this is not unexpectedly shared. This is unnecessary in many integration scenarios,
/// leading to an additional nontrivial <see cref="Dictionary{TKey,TValue}"/> allocation. This
/// method allows specialized callers to avoid that overhead.
/// </summary>
/// <remarks>
/// Because this method exposes parameters that essentially map 1:1 with internal fields of <see cref="LogEvent"/>,
/// the parameter list may change across major Serilog versions.
/// </remarks>
/// <param name="timestamp">The time at which the event occurred.</param>
/// <param name="level">The level of the event.</param>
/// <param name="exception">An exception associated with the event, or null.</param>
/// <param name="messageTemplate">The message template describing the event.</param>
/// <param name="properties">Properties associated with the event, including those presented in <paramref name="messageTemplate"/>.</param>
/// <param name="traceId">The id of the trace that was active when the event was created, if any.</param>
/// <param name="spanId">The id of the span that was active when the event was created, if any.</param>
/// <exception cref="ArgumentNullException">When <paramref name="messageTemplate"/> is <code>null</code></exception>
/// <exception cref="ArgumentNullException">When <paramref name="properties"/> is <code>null</code></exception>
/// <returns>A constructed <see cref="LogEvent"/>.</returns>
[CLSCompliant(false)]
public static LogEvent UnstableAssembleFromParts(
DateTimeOffset timestamp,
LogEventLevel level,
Exception? exception,
MessageTemplate messageTemplate,
Dictionary<string, LogEventPropertyValue> properties,
ActivityTraceId traceId,
ActivitySpanId spanId)
{
return new LogEvent(timestamp, level, exception, messageTemplate, properties, traceId, spanId);
}
internal LogEvent Copy()
{
var properties = new Dictionary<string, LogEventPropertyValue>(_properties);
return new LogEvent(
Timestamp,
Level,
Exception,
MessageTemplate,
properties,
TraceId ?? default,
SpanId ?? default);
}
}