Click or drag to resize

RetryingTargetWrapper Class

Retries in case of write error.
Inheritance Hierarchy
SystemObject
  NLog.TargetsTarget
    NLog.Targets.WrappersWrapperTargetBase
      NLog.Targets.WrappersRetryingTargetWrapper

Namespace:  NLog.Targets.Wrappers
Assembly:  NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b
Syntax
public class RetryingTargetWrapper : WrapperTargetBase

The RetryingTargetWrapper type exposes the following members.

Constructors
  NameDescription
Public methodRetryingTargetWrapper
Initializes a new instance of the RetryingTargetWrapper class.
Public methodRetryingTargetWrapper(Target, Int32, Int32)
Initializes a new instance of the RetryingTargetWrapper class.
Public methodRetryingTargetWrapper(String, Target, Int32, Int32)
Initializes a new instance of the RetryingTargetWrapper class.
Top
Properties
  NameDescription
Public propertyEnableBatchWrite
Gets or sets whether to enable batching, and only apply single delay when a whole batch fails
Protected propertyIsInitialized
Gets a value indicating whether the target has been initialized.
(Inherited from Target.)
Protected propertyLoggingConfiguration
Gets the logging configuration this target is part of.
(Inherited from Target.)
Public propertyName
Gets or sets the name of the target.
(Inherited from Target.)
Public propertyRetryCount
Gets or sets the number of retries that should be attempted on the wrapped target in case of a failure.
Public propertyRetryDelayMilliseconds
Gets or sets the time to wait between retries in milliseconds.
Protected propertySyncRoot
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.)
Public propertyWrappedTarget
Gets or sets the target that is wrapped by this target.
(Inherited from WrapperTargetBase.)
Top
Methods
  NameDescription
Protected methodCloseTarget
Closes the target to release any initialized resources
(Inherited from Target.)
Public methodDispose
Closes the target.
(Inherited from Target.)
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
(Inherited from Target.)
Public methodFlush
Flush any pending log messages (in case of asynchronous targets).
(Inherited from Target.)
Protected methodFlushAsync
Flush any pending log messages
(Inherited from WrapperTargetBase.)
Protected methodInitializeTarget
Initializes the target before writing starts
(Inherited from Target.)
Public methodPrecalculateVolatileLayouts
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.)
Protected methodRenderLogEvent(Layout, LogEventInfo)
Renders the logevent into a string-result using the provided layout
(Inherited from Target.)
Protected methodRenderLogEventT(LayoutT, LogEventInfo, T)
Renders the logevent into a result-value by using the provided layout
(Inherited from Target.)
Protected methodResolveServiceT
Resolve from DI ServiceRepository
(Inherited from Target.)
Public methodToString
Returns a string that represents the current object.
(Inherited from WrapperTargetBase.)
Protected methodWrite(AsyncLogEventInfo)
Writes the specified log event to the wrapped target, retrying and pausing in case of an error.
(Overrides TargetWrite(AsyncLogEventInfo).)
Protected methodWrite(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.)
Protected methodWrite(LogEventInfo)
Writes logging event to the log target. Must be overridden in inheriting classes.
(Inherited from WrapperTargetBase.)
Public methodWriteAsyncLogEvent
Writes the log to the target.
(Inherited from Target.)
Public methodWriteAsyncLogEvents(AsyncLogEventInfo)
Writes the array of log events.
(Inherited from Target.)
Public methodWriteAsyncLogEvents(IListAsyncLogEventInfo)
Writes the array of log events.
(Inherited from Target.)
Protected methodWriteAsyncThreadSafe(AsyncLogEventInfo)
Writes the specified log event to the wrapped target in a thread-safe manner.
(Overrides TargetWriteAsyncThreadSafe(AsyncLogEventInfo).)
Protected methodWriteAsyncThreadSafe(IListAsyncLogEventInfo)
Writes the specified log event to the wrapped target, retrying and pausing in case of an error.
(Overrides TargetWriteAsyncThreadSafe(IListAsyncLogEventInfo).)
Protected methodWriteFailedNotInitialized
LogEvent is written to target, but target failed to successfully initialize
(Inherited from Target.)
Top
Remarks
Examples

This example causes each write attempt to be repeated 3 times, sleeping 1 second between attempts if first one fails.

To set up the target in the configuration file, use the following syntax:

XML
 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="RetryingWrapper" retryCount="3" retryDelayMilliseconds="1000">
 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:

C#
 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        RetryingTargetWrapper target = new RetryingTargetWrapper();
16        target.WrappedTarget = wrappedTarget;
17        target.RetryCount = 3;
18        target.RetryDelayMilliseconds = 1000;
19
20        NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug);
21
22        Logger logger = LogManager.GetLogger("Example");
23        logger.Debug("log message");
24    }
25}
See Also