Click or drag to resize

DebugTarget Class

Mock target - useful for testing.
Inheritance Hierarchy
SystemObject
  NLog.TargetsTarget
    NLog.TargetsTargetWithLayout
      NLog.TargetsDebugTarget

Namespace:  NLog.Targets
Assembly:  NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b
Syntax
public sealed class DebugTarget : TargetWithLayout

The DebugTarget type exposes the following members.

Constructors
  NameDescription
Public methodDebugTarget
Initializes a new instance of the DebugTarget class.
Public methodDebugTarget(String)
Initializes a new instance of the DebugTarget class.
Top
Properties
  NameDescription
Public propertyCounter
Gets the number of times this target has been called.
Public propertyLastMessage
Gets the last message rendered by this target.
Public propertyLayout
Gets or sets the layout used to format log messages.
(Inherited from TargetWithLayout.)
Public propertyName
Gets or sets the name of the target.
(Inherited from Target.)
Top
Methods
  NameDescription
Public methodDispose
Closes the target.
(Inherited from Target.)
Public methodFlush
Flush any pending log messages (in case of asynchronous targets).
(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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Target.)
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.)
Top
Remarks
Examples

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="debug" xsi:type="Debug" layout="${message}" />
 6    </targets>
 7
 8    <rules>
 9        <logger name="*" minlevel="Info" writeTo="debug" />
10    </rules>
11</nlog>

To set up the log target programmatically use code like this:

C#
 1using System;
 2
 3using NLog;
 4using NLog.Targets;
 5
 6class Example
 7{
 8    static void Main(string[] args)
 9    {
10        DebugTarget target = new DebugTarget();
11        target.Layout = "${message}";
12
13        NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug);
14
15        Logger logger = LogManager.GetLogger("Example");
16        logger.Debug("log message");
17        logger.Debug("another log message");
18
19        Console.WriteLine("The debug target has been hit {0} times.", target.Counter);
20        Console.WriteLine("The last message was '{0}'.", target.LastMessage);
21    }
22}
See Also