-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
FilteringTargetWrapper.cs
194 lines (181 loc) · 7.9 KB
/
FilteringTargetWrapper.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
//
// 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.
//
namespace NLog.Targets.Wrappers
{
using System.Collections.Generic;
using NLog.Common;
using NLog.Conditions;
using NLog.Config;
using NLog.Filters;
/// <summary>
/// Filters log entries based on a condition.
/// </summary>
/// <seealso href="https://github.com/nlog/nlog/wiki/FilteringWrapper-target">Documentation on NLog Wiki</seealso>
/// <example>
/// <p>This example causes the messages not contains the string '1' to be ignored.</p>
/// <p>
/// To set up the target in the <a href="config.html">configuration file</a>,
/// use the following syntax:
/// </p>
/// <code lang="XML" source="examples/targets/Configuration File/FilteringWrapper/NLog.config" />
/// <p>
/// The above examples assume just one target and a single rule. See below for
/// a programmatic configuration that's equivalent to the above config file:
/// </p>
/// <code lang="C#" source="examples/targets/Configuration API/FilteringWrapper/Simple/Example.cs" />
/// </example>
[Target("FilteringWrapper", IsWrapper = true)]
public class FilteringTargetWrapper : WrapperTargetBase
{
/// <summary>
/// Initializes a new instance of the <see cref="FilteringTargetWrapper" /> class.
/// </summary>
public FilteringTargetWrapper()
: this(null, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="FilteringTargetWrapper" /> class.
/// </summary>
/// <param name="name">Name of the target.</param>
/// <param name="wrappedTarget">The wrapped target.</param>
/// <param name="condition">The condition.</param>
public FilteringTargetWrapper(string name, Target wrappedTarget, ConditionExpression condition)
: this(wrappedTarget, condition)
{
Name = name;
}
/// <summary>
/// Initializes a new instance of the <see cref="FilteringTargetWrapper" /> class.
/// </summary>
/// <param name="wrappedTarget">The wrapped target.</param>
/// <param name="condition">The condition.</param>
public FilteringTargetWrapper(Target wrappedTarget, ConditionExpression condition)
{
WrappedTarget = wrappedTarget;
Condition = condition;
}
/// <summary>
/// Gets or sets the condition expression. Log events who meet this condition will be forwarded
/// to the wrapped target.
/// </summary>
/// <docgen category='Filtering Options' order='10' />
public ConditionExpression Condition { get => (Filter as ConditionBasedFilter)?.Condition; set => Filter = value != null ? new ConditionBasedFilter() { Condition = value, DefaultFilterResult = FilterResult.Ignore } : null; }
/// <summary>
/// Gets or sets the condition expression. Log events who meet this condition will be forwarded
/// to the wrapped target.
/// </summary>
/// <docgen category='Filtering Options' order='10' />
[RequiredParameter]
public Filter Filter { get; set; }
/// <inheritdoc/>
protected override void InitializeTarget()
{
base.InitializeTarget();
if (!OptimizeBufferReuse && WrappedTarget != null && WrappedTarget.OptimizeBufferReuse)
{
OptimizeBufferReuse = GetType() == typeof(FilteringTargetWrapper); // Class not sealed, reduce breaking changes
}
}
/// <summary>
/// Checks the condition against the passed log event.
/// If the condition is met, the log event is forwarded to
/// the wrapped target.
/// </summary>
/// <param name="logEvent">Log event.</param>
protected override void Write(AsyncLogEventInfo logEvent)
{
if (FilterIncludeLogEvent(logEvent.LogEvent))
{
WrappedTarget.WriteAsyncLogEvent(logEvent);
}
else
{
logEvent.Continuation(null);
}
}
/// <inheritdoc/>
protected override void Write(IList<AsyncLogEventInfo> logEvents)
{
bool hasIgnoredLogEvents = false;
IList<AsyncLogEventInfo> filterLogEvents = null;
AsyncLogEventInfo filterLogEvent = default(AsyncLogEventInfo);
for (int i = 0; i < logEvents.Count; ++i)
{
if (FilterIncludeLogEvent(logEvents[i].LogEvent))
{
if (hasIgnoredLogEvents && filterLogEvents == null)
{
if (filterLogEvent.LogEvent != null)
{
filterLogEvents = new List<AsyncLogEventInfo>();
filterLogEvents.Add(filterLogEvent);
filterLogEvent = default(AsyncLogEventInfo);
}
else
{
filterLogEvent = logEvents[i];
}
}
if (filterLogEvents != null)
filterLogEvents.Add(logEvents[i]);
}
else
{
if (!hasIgnoredLogEvents && i > 0)
{
filterLogEvents = new List<AsyncLogEventInfo>();
for (int j = 0; j < i; ++j)
filterLogEvents.Add(logEvents[j]);
}
hasIgnoredLogEvents = true;
logEvents[i].Continuation(null);
}
}
if (!hasIgnoredLogEvents)
WrappedTarget.WriteAsyncLogEvents(logEvents);
else if (filterLogEvents != null)
WrappedTarget.WriteAsyncLogEvents(filterLogEvents);
else if (filterLogEvent.LogEvent != null)
WrappedTarget.WriteAsyncLogEvent(filterLogEvent);
}
private bool FilterIncludeLogEvent(LogEventInfo logEvent)
{
var filterResult = Filter.GetFilterResult(logEvent);
if (filterResult == FilterResult.Ignore || filterResult == FilterResult.IgnoreFinal)
return false;
else
return true;
}
}
}