![]() | SyslogTarget Class |
Namespace: NLog.Targets
The SyslogTarget type exposes the following members.
Name | Description | |
---|---|---|
![]() | SyslogTarget |
Initializes a new instance of the SyslogTarget class.
|
Name | Description | |
---|---|---|
![]() | Address |
Gets or sets the network destination address.
(Inherited from NetworkTarget.) |
![]() | Compress |
Type of compression for protocol payload. Useful for UDP where datagram max-size is 8192 bytes.
(Inherited from NetworkTarget.) |
![]() | CompressMinBytes |
Skip compression when protocol payload is below limit to reduce overhead in cpu-usage and additional headers
(Inherited from NetworkTarget.) |
![]() | ConnectionCacheSize |
Gets or sets the size of the connection cache (number of connections which are kept alive). Requires KeepConnection = (Inherited from NetworkTarget.) |
![]() | Encoding |
Gets or sets the encoding to be used.
(Inherited from NetworkTarget.) |
![]() | IncludeEventProperties |
Gets or sets a value indicating whether LogEvent Properties should be included for StructuredData when Rfc5424 = |
![]() | IsInitialized |
Gets a value indicating whether the target has been initialized.
(Inherited from Target.) |
![]() | KeepAliveTimeSeconds |
The number of seconds a connection will remain idle before the first keep-alive probe is sent
(Inherited from NetworkTarget.) |
![]() | KeepConnection |
Gets or sets a value indicating whether to keep connection open whenever possible.
(Inherited from NetworkTarget.) |
![]() | Layout |
Gets or sets the layout used to format log messages.
(Overrides TargetWithLayoutLayout.) |
![]() | LineEnding |
Gets or sets the end of line value if a newline is appended at the end of log message NewLine.
(Inherited from NetworkTarget.) |
![]() | LoggingConfiguration |
Gets the logging configuration this target is part of.
(Inherited from Target.) |
![]() | MaxConnections |
Gets or sets the maximum simultaneous connections. Requires KeepConnection = false
(Inherited from NetworkTarget.) |
![]() | MaxMessageSize |
Gets or sets the maximum message size in bytes. On limit breach then OnOverflow action is activated.
(Inherited from NetworkTarget.) |
![]() | MaxQueueSize |
Gets or sets the maximum queue size for a single connection. Requires KeepConnection = (Inherited from NetworkTarget.) |
![]() | Name |
Gets or sets the name of the target.
(Inherited from Target.) |
![]() | NewLine |
Gets or sets a value indicating whether to append newline at the end of log message.
(Inherited from NetworkTarget.) |
![]() | NoDelay |
Gets or sets whether to disable the delayed ACK timer, and avoid delay of 200 ms.
(Inherited from NetworkTarget.) |
![]() | OnConnectionOverflow |
Gets or sets the action that should be taken, when more connections than MaxConnections.
(Inherited from NetworkTarget.) |
![]() | OnOverflow |
Gets or sets the action that should be taken if the message is larger than MaxMessageSize (Inherited from NetworkTarget.) |
![]() | OnQueueOverflow |
Gets or sets the action that should be taken, when more pending messages than MaxQueueSize.
(Inherited from NetworkTarget.) |
![]() | 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
|
![]() | SendTimeoutSeconds |
The number of seconds a TCP socket send-operation will block before timeout error. Default = 100 secs (0 = wait forever when network cable unplugged and tcp-buffer becomes full).
(Inherited from NetworkTarget.) |
![]() | SslCertificateFile |
Gets or sets the file path to custom SSL certificate for TCP Socket SSL connections
(Inherited from NetworkTarget.) |
![]() | SslCertificatePassword |
Gets or sets the password for the custom SSL certificate specified by SslCertificateFile (Inherited from NetworkTarget.) |
![]() | SslProtocols |
Gets or sets the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP.
(Inherited from NetworkTarget.) |
![]() | StructuredDataId |
Gets or sets the prefix for StructuredData when Rfc5424 = |
![]() | StructuredDataParams |
List of StructuredData Parameters to include when Rfc5424 = |
![]() | SyncRoot |
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.) |
![]() | 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 = |
Name | Description | |
---|---|---|
![]() | CloseTarget |
Closes the target to release any initialized resources
(Inherited from NetworkTarget.) |
![]() | 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 |
Flush any pending log messages asynchronously (in case of asynchronous targets).
(Inherited from NetworkTarget.) |
![]() | GetBytesToWrite |
Gets the payload bytes to be written.
(Inherited from NetworkTarget.) |
![]() | GetHeaderToWrite |
Gets the header bytes to be written.
(Overrides NetworkTargetGetHeaderToWrite(LogEventInfo, String, Byte).) |
![]() | InitializeTarget |
Initializes the target before writing starts
(Inherited from NetworkTarget.) |
![]() | 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 Target.) |
![]() | Write(AsyncLogEventInfo) |
Sends the
rendered logging event over the network optionally concatenating it with a newline character.
(Inherited from NetworkTarget.) |
![]() | 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 target destination
(Inherited from Target.) |
![]() | 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.) |
Name | Description | |
---|---|---|
![]() | LogEventDropped |
Occurs when LogEvent has been dropped.
(Inherited from NetworkTarget.) |