AutoFlushTargetWrapper Class |
Namespace: NLog.Targets.Wrappers
The AutoFlushTargetWrapper type exposes the following members.
Name | Description | |
---|---|---|
AutoFlushTargetWrapper |
Initializes a new instance of the AutoFlushTargetWrapper class.
| |
AutoFlushTargetWrapper(Target) |
Initializes a new instance of the AutoFlushTargetWrapper class.
| |
AutoFlushTargetWrapper(String, Target) |
Initializes a new instance of the AutoFlushTargetWrapper class.
|
Name | Description | |
---|---|---|
AsyncFlush |
Delay the flush until the LogEvent has been confirmed as written
| |
Condition |
Gets or sets the condition expression. Log events who meet this condition will cause
a flush on the wrapped target.
| |
FlushOnConditionOnly |
Only flush when LogEvent matches condition. Ignore explicit-flush, config-reload-flush and shutdown-flush
| |
IsInitialized |
Gets a value indicating whether the target has been initialized.
(Inherited from Target.) | |
LoggingConfiguration |
Gets the logging configuration this target is part of.
(Inherited from Target.) | |
Name |
Gets or sets the name of the target.
(Inherited from Target.) | |
SyncRoot |
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.) | |
WrappedTarget |
Gets or sets the target that is wrapped by this target.
(Inherited from WrapperTargetBase.) |
Name | Description | |
---|---|---|
CloseTarget |
Closes the target to release any initialized resources
(Overrides TargetCloseTarget.) | |
Dispose |
Closes the target.
(Inherited from Target.) | |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
(Inherited from Target.) | |
Flush |
Flush any pending log messages (in case of asynchronous targets).
(Inherited from Target.) | |
FlushAsync |
Schedules a flush operation, that triggers when all pending flush operations are completed (in case of asynchronous targets).
(Overrides WrapperTargetBaseFlushAsync(AsyncContinuation).) | |
InitializeTarget |
Initializes the target before writing starts
(Overrides TargetInitializeTarget.) | |
PrecalculateVolatileLayouts |
Calls the Precalculate(LogEventInfo) on each volatile layout
used by this target.
This method won't prerender if all layouts in this target are thread-agnostic.
(Inherited from Target.) | |
RenderLogEvent(Layout, LogEventInfo) |
Renders the logevent into a string-result using the provided layout
(Inherited from Target.) | |
RenderLogEventT(LayoutT, LogEventInfo, T) |
Renders the logevent into a result-value by using the provided layout
(Inherited from Target.) | |
ResolveServiceT |
Resolve from DI ServiceRepository (Inherited from Target.) | |
ToString | Returns a string that represents the current object. (Inherited from WrapperTargetBase.) | |
Write(AsyncLogEventInfo) |
Forwards the call to the WrappedTarget.Write()
and calls Flush(AsyncContinuation) on it if LogEvent satisfies
the flush condition or condition is null.
(Overrides TargetWrite(AsyncLogEventInfo).) | |
Write(IListAsyncLogEventInfo) |
Writes an array of logging events to the log target. By default it iterates on all
events and passes them to "Write" method. Inheriting classes can use this method to
optimize batch writes.
(Inherited from Target.) | |
Write(LogEventInfo) |
Writes logging event to the log target. Must be overridden in inheriting
classes.
(Inherited from WrapperTargetBase.) | |
WriteAsyncLogEvent |
Writes the log to the target.
(Inherited from Target.) | |
WriteAsyncLogEvents(AsyncLogEventInfo) |
Writes the array of log events.
(Inherited from Target.) | |
WriteAsyncLogEvents(IListAsyncLogEventInfo) |
Writes the array of log events.
(Inherited from Target.) | |
WriteAsyncThreadSafe(AsyncLogEventInfo) |
Writes a log event to the log target, in a thread safe manner.
Any override of this method has to provide their own synchronization mechanism.
!WARNING! Custom targets should only override this method if able to provide their
own synchronization mechanism. Layout-objects are not guaranteed to be
thread-safe, so using them without a SyncRoot-object can be dangerous.
(Inherited from Target.) | |
WriteAsyncThreadSafe(IListAsyncLogEventInfo) |
Writes an array of logging events to the log target, in a thread safe manner.
Any override of this method has to provide their own synchronization mechanism.
!WARNING! Custom targets should only override this method if able to provide their
own synchronization mechanism. Layout-objects are not guaranteed to be
thread-safe, so using them without a SyncRoot-object can be dangerous.
(Inherited from Target.) | |
WriteFailedNotInitialized |
LogEvent is written to target, but target failed to successfully initialize
(Inherited from Target.) |
To set up the target in the configuration file, use the following syntax:
1<?xml version="1.0" ?> 2<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 4 <targets> 5 <target name="file" xsi:type="AutoFlushWrapper" condition="level >= LogLevel.Debug"> 6 <target xsi:type="File" fileName="${basedir}/file.txt" /> 7 </target> 8 </targets> 9 10 <rules> 11 <logger name="*" minlevel="Debug" writeTo="file" /> 12 </rules> 13</nlog>
To set up the log target programmatically use code like this:
1using System; 2 3using NLog; 4using NLog.Targets; 5using NLog.Targets.Wrappers; 6using System.Diagnostics; 7 8class Example 9{ 10 static void Main(string[] args) 11 { 12 FileTarget wrappedTarget = new FileTarget(); 13 wrappedTarget.FileName = "${basedir}/file.txt"; 14 15 AutoFlushTargetWrapper target = new AutoFlushTargetWrapper(); 16 target.WrappedTarget = wrappedTarget; 17 target.Condition = "level >= LogLevel.Debug"; 18 NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug); 19 20 Logger logger = LogManager.GetLogger("Example"); 21 logger.Debug("log message"); 22 } 23}