SyslogLayout Class

A specialized layout that renders Syslog-formatted events in format Rfc3164 / Rfc5424

Inheritance Hierarchy

SystemObject
  NLog.LayoutsLayout
    NLog.LayoutsCompoundLayout
      NLog.LayoutsSyslogLayout

Namespace: NLog.Layouts
Assembly: NLog.Targets.Network (in NLog.Targets.Network.dll) Version: 6.0.0+be83582280f7a841b0d3c6ae75b4f95aaf07e914

Syntax

public class SyslogLayout : CompoundLayout

Public Class SyslogLayout
	Inherits CompoundLayout

Dim instance As SyslogLayout

type SyslogLayout =  
    class
        inherit CompoundLayout
    end

The SyslogLayout type exposes the following members.

Constructors

	Name	Description
	SyslogLayout	Initializes a new instance of the SyslogLayout class.

Properties

	Name	Description
	DisableThreadAgnostic	Disables ThreadAgnosticAttribute to capture volatile LogEvent-properties from active thread context
	IncludeEventProperties	Gets or sets a value indicating whether LogEvent Properties should be included for StructuredData when Rfc5424 =
	Layouts	Gets the inner layouts. (Inherited from CompoundLayout.)
	LoggingConfiguration	Gets the logging configuration this target is part of. (Inherited from Layout.)
	Rfc3164	Gets or sets a value indicating whether to use RFC 3164 for Syslog Format
	Rfc5424	Gets or sets a value indicating whether to use RFC 5424 for Syslog Format
	StructuredDataId	Gets or sets the prefix for StructuredData when Rfc5424 =
	StructuredDataParams	List of StructuredData Parameters to include when Rfc5424 =
	SyslogAppName	Name of the device / application / process sending the Syslog-message (Optional)
	SyslogFacility	Device Facility
	SyslogHostName	The FQDN or IPv4 address or IPv6 address or hostname of the sender machine (Optional)
	SyslogLevel	Message Severity
	SyslogMessage	Mesage Payload
	SyslogMessageId	The type of message that should be the same for events with the same semantics. Ex ${event-properties:EventId} (Optional)
	SyslogProcessId	Process Id or Process Name or Logger Name (Optional)
	SyslogTimestamp	Gets or sets a value indicating what DateTime format should be used when Rfc5424 =

Methods

	Name	Description
	CloseLayout	Closes the layout. (Overrides CompoundLayoutCloseLayout.)
	GetFormattedMessage	Renders formatted output using the log event as context. (Overrides CompoundLayoutGetFormattedMessage(LogEventInfo).)
	InitializeLayout	Initializes the layout. (Overrides CompoundLayoutInitializeLayout.)
	Precalculate	Precalculates the layout for the specified log event and stores the result in per-log event cache. Skips context capture when Layout have [ThreadAgnostic], and only contains layouts with [ThreadAgnostic]. (Inherited from Layout.)
	Render(LogEventInfo)	Renders formatted output using the log event as context. (Inherited from Layout.)
	Render(LogEventInfo, StringBuilder)	Optimized version of Render(LogEventInfo) that works best when override of RenderFormattedMessage(LogEventInfo, StringBuilder) is available. (Inherited from Layout.)
	RenderFormattedMessage	Renders formatted output using the log event as context. (Overrides CompoundLayoutRenderFormattedMessage(LogEventInfo, StringBuilder).)
	ResolveServiceT	Resolve from DI ServiceRepository (Inherited from Layout.)
	ToString	Returns a string that represents the current object. (Inherited from CompoundLayout.)

Remarks