-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
AllEventPropertiesLayoutRenderer.cs
235 lines (209 loc) · 8.58 KB
/
AllEventPropertiesLayoutRenderer.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
//
// Copyright (c) 2004-2019 Jaroslaw Kowalski <jaak@jkowalski.net>, Kim Christensen, Julian Verdurmen
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// * Neither the name of Jaroslaw Kowalski nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
using System.Collections;
namespace NLog.LayoutRenderers
{
using System;
using System.Text;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using NLog.Config;
using NLog.Internal;
/// <summary>
/// Log event context data.
/// </summary>
[LayoutRenderer("all-event-properties")]
[ThreadAgnostic]
[ThreadSafe]
[MutableUnsafe]
public class AllEventPropertiesLayoutRenderer : LayoutRenderer
{
private string _format;
private string _beforeKey;
private string _afterKey;
private string _afterValue;
/// <summary>
/// Initializes a new instance of the <see cref="AllEventPropertiesLayoutRenderer"/> class.
/// </summary>
public AllEventPropertiesLayoutRenderer()
{
Separator = ", ";
Format = "[key]=[value]";
}
/// <summary>
/// Gets or sets string that will be used to separate key/value pairs.
/// </summary>
/// <docgen category='Rendering Options' order='10' />
public string Separator { get; set; }
/// <summary>
/// Get or set if empty values should be included.
///
/// A value is empty when null or in case of a string, null or empty string.
/// </summary>
[DefaultValue(false)]
public bool IncludeEmptyValues { get; set; } = false;
#if NET4_5
/// <summary>
/// Also render the caller information attributes? (<see cref="System.Runtime.CompilerServices.CallerMemberNameAttribute"/>,
/// <see cref="System.Runtime.CompilerServices.CallerFilePathAttribute"/>, <see cref="System.Runtime.CompilerServices.CallerLineNumberAttribute"/>).
///
/// See https://msdn.microsoft.com/en-us/library/hh534540.aspx
/// </summary>
/// <docgen category='Rendering Options' order='10' />
[DefaultValue(false)]
public bool IncludeCallerInformation { get; set; }
#endif
/// <summary>
/// Gets or sets how key/value pairs will be formatted.
/// </summary>
/// <docgen category='Rendering Options' order='10' />
public string Format
{
get => _format;
set
{
if (!value.Contains("[key]"))
throw new ArgumentException("Invalid format: [key] placeholder is missing.");
if (!value.Contains("[value]"))
throw new ArgumentException("Invalid format: [value] placeholder is missing.");
_format = value;
var formatSplit = _format.Split(new[] { "[key]", "[value]" }, StringSplitOptions.None);
if (formatSplit.Length == 3)
{
_beforeKey = formatSplit[0];
_afterKey = formatSplit[1];
_afterValue = formatSplit[2];
}
else
{
_beforeKey = null;
_afterKey = null;
_afterValue = null;
}
}
}
/// <summary>
/// Renders all log event's properties and appends them to the specified <see cref="StringBuilder" />.
/// </summary>
/// <param name="builder">The <see cref="StringBuilder"/> to append the rendered data to.</param>
/// <param name="logEvent">Logging event.</param>
protected override void Append(StringBuilder builder, LogEventInfo logEvent)
{
if (logEvent.HasProperties)
{
var formatProvider = GetFormatProvider(logEvent);
bool first = true;
IEnumerable<KeyValuePair<object, object>> properties = GetProperties(logEvent);
if (!IncludeEmptyValues)
{
properties = properties.Where(p => !IsEmptyPropertyValue(p.Value));
}
foreach (var property in properties)
{
if (!first)
{
builder.Append(Separator);
}
first = false;
if (_beforeKey == null || _afterKey == null || _afterValue == null)
{
var key = Convert.ToString(property.Key, formatProvider);
var value = Convert.ToString(property.Value, formatProvider);
var pair = Format.Replace("[key]", key)
.Replace("[value]", value);
builder.Append(pair);
}
else
{
builder.Append(_beforeKey);
builder.AppendFormattedValue(property.Key, null, formatProvider);
builder.Append(_afterKey);
builder.AppendFormattedValue(property.Value, null, formatProvider);
builder.Append(_afterValue);
}
}
}
}
private static bool IsEmptyPropertyValue(object value)
{
if (value is string s)
{
return string.IsNullOrEmpty(s);
}
return value == null;
}
#if NET4_5
/// <summary>
/// The names of caller information attributes.
/// https://msdn.microsoft.com/en-us/library/hh534540.aspx
/// TODO NLog ver. 5 - Remove these properties
/// </summary>
private static List<string> CallerInformationAttributeNames = new List<string>
{
{"CallerMemberName"},
{"CallerFilePath"},
{"CallerLineNumber"},
};
/// <summary>
/// Also render the call attributes? (<see cref="System.Runtime.CompilerServices.CallerMemberNameAttribute"/>,
/// <see cref="System.Runtime.CompilerServices.CallerFilePathAttribute"/>, <see cref="System.Runtime.CompilerServices.CallerLineNumberAttribute"/>).
/// </summary>
///
#endif
private IDictionary<object, object> GetProperties(LogEventInfo logEvent)
{
var properties = logEvent.Properties;
#if NET4_5
if (IncludeCallerInformation)
{
return properties;
}
if (logEvent.CallSiteInformation != null)
{
// TODO NLog ver. 5 - Remove these properties. Instead output artificial properties, extracted from LogEventInfo.CallSiteInformation
foreach (string propertyName in CallerInformationAttributeNames)
{
if (properties.ContainsKey(propertyName))
{
return properties.Where(p => !CallerInformationAttributeNames.Contains(p.Key)).ToDictionary(p => p.Key, p => p.Value);
}
}
}
return properties;
#else
return properties;
#endif
}
}
}