Click or drag to resize

NLogViewerTarget Class

Sends log messages to the remote instance of NLog Viewer.
Inheritance Hierarchy

Namespace:  NLog.Targets
Assembly:  NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b
Syntax
public class NLogViewerTarget : NetworkTarget

The NLogViewerTarget type exposes the following members.

Constructors
  NameDescription
Public methodNLogViewerTarget
Initializes a new instance of the NLogViewerTarget class.
Public methodNLogViewerTarget(String)
Initializes a new instance of the NLogViewerTarget class.
Top
Properties
  NameDescription
Public propertyAddress
Gets or sets the network address.
(Inherited from NetworkTarget.)
Public propertyAppInfo
Gets or sets the log4j:event log4japp-xml-element. By default it's the friendly name of the current AppDomain.
Public propertyCompress
Type of compression for protocol payload. Useful for UDP where datagram max-size is 8192 bytes.
(Inherited from NetworkTarget.)
Public propertyCompressMinBytes
Skip compression when protocol payload is below limit to reduce overhead in cpu-usage and additional headers
(Inherited from NetworkTarget.)
Public propertyConnectionCacheSize
Gets or sets the size of the connection cache (number of connections which are kept alive). Requires KeepConnection = true
(Inherited from NetworkTarget.)
Public propertyEncoding
Gets or sets the encoding to be used.
(Inherited from NetworkTarget.)
Public propertyFormattedMessage
Gets or sets the log4j:event message-xml-element. Default: ${message}
Public propertyIncludeCallSite
Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network.
Public propertyIncludeEventProperties
Gets or sets the option to include all properties from the log events
Public propertyIncludeNdc
Gets or sets whether to include log4j:NDC in output from ScopeContext nested context.
Public propertyIncludeNLogData
Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema.
Public propertyIncludeScopeNested
Gets or sets whether to include log4j:NDC in output from ScopeContext nested context.
Public propertyIncludeScopeProperties
Gets or sets whether to include the contents of the ScopeContext properties-dictionary.
Public propertyIncludeSourceInfo
Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network.
Protected propertyIsInitialized
Gets a value indicating whether the target has been initialized.
(Inherited from Target.)
Public propertyKeepAliveTimeSeconds
The number of seconds a connection will remain idle before the first keep-alive probe is sent
(Inherited from NetworkTarget.)
Public propertyKeepConnection
Gets or sets a value indicating whether to keep connection open whenever possible.
(Inherited from NetworkTarget.)
Public propertyLayout
Gets or sets the instance of Log4JXmlEventLayout that is used to format log messages.
(Overrides TargetWithLayoutLayout.)
Public propertyLineEnding
Gets or sets the end of line value if a newline is appended at the end of log message NewLine.
(Inherited from NetworkTarget.)
Public propertyLoggerName
Gets or sets the log4j:event logger-xml-attribute. Default: ${logger}
Protected propertyLoggingConfiguration
Gets the logging configuration this target is part of.
(Inherited from Target.)
Public propertyMaxConnections
Gets or sets the maximum simultaneous connections. Requires KeepConnection = false
(Inherited from NetworkTarget.)
Public propertyMaxMessageSize
Gets or sets the maximum message size in bytes. On limit breach then OnOverflow action is activated.
(Inherited from NetworkTarget.)
Public propertyMaxQueueSize
Gets or sets the maximum queue size for a single connection. Requires KeepConnection = true
(Inherited from NetworkTarget.)
Public propertyName
Gets or sets the name of the target.
(Inherited from Target.)
Public propertyNdcItemSeparator
Gets or sets the stack separator for log4j:NDC in output from ScopeContext nested context.
Public propertyNewLine
Gets or sets a value indicating whether to append newline at the end of log message.
(Inherited from NetworkTarget.)
Public propertyOnConnectionOverflow
Gets or sets the action that should be taken, when more connections than MaxConnections.
(Inherited from NetworkTarget.)
Public propertyOnOverflow
Gets or sets the action that should be taken if the message is larger than MaxMessageSize
(Inherited from NetworkTarget.)
Public propertyOnQueueOverflow
Gets or sets the action that should be taken, when more pending messages than MaxQueueSize.
(Inherited from NetworkTarget.)
Public propertyParameters
Gets the collection of parameters. Each parameter contains a mapping between NLog layout and a named parameter.
Public propertyRenderer
Gets the layout renderer which produces Log4j-compatible XML events.
Public propertyScopeNestedSeparator
Gets or sets the separator for ScopeContext operation-states-stack.
Public propertySendTimeoutSeconds
The number of seconds a TCP socket send-operation will block before timeout error. Default wait forever when network cable unplugged and tcp-buffer becomes full.
(Inherited from NetworkTarget.)
Public propertySslProtocols
Gets or sets the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.
(Inherited from NetworkTarget.)
Protected propertySyncRoot
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.)
Top
Methods
  NameDescription
Protected methodCloseTarget
Closes the target to release any initialized resources
(Inherited from NetworkTarget.)
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 asynchronously (in case of asynchronous targets).
(Inherited from NetworkTarget.)
Protected methodGetBytesToWrite
Gets the bytes to be written.
(Inherited from NetworkTarget.)
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 Target.)
Protected methodWrite(AsyncLogEventInfo)
Sends the rendered logging event over the network optionally concatenating it with a newline character.
(Inherited from NetworkTarget.)
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 target destination
(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.)
Protected methodWriteAsyncThreadSafe(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.)
Protected methodWriteAsyncThreadSafe(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.)
Protected methodWriteFailedNotInitialized
LogEvent is written to target, but target failed to successfully initialize
(Inherited from Target.)
Top
Events
  NameDescription
Public eventLogEventDropped
Occurs when LogEvent has been dropped.
(Inherited from NetworkTarget.)
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="viewer" xsi:type="NLogViewer" address="ucp://localhost:4000" />
 6    </targets>
 7
 8    <rules>
 9        <logger name="*" minlevel="Debug" writeTo="viewer" />
10    </rules>
11</nlog>

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

C#
 1using NLog;
 2using NLog.Targets;
 3
 4class Example
 5{
 6    static void Main(string[] args)
 7    {
 8        NLogViewerTarget target = new NLogViewerTarget();
 9        target.Address = "udp://localhost:4000";
10
11        NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug);
12
13        Logger logger = LogManager.GetLogger("Example");
14        logger.Trace("log message 1");
15        logger.Debug("log message 2");
16        logger.Info("log message 3");
17        logger.Warn("log message 4");
18        logger.Error("log message 5");
19        logger.Fatal("log message 6");
20    }
21}
See Also