Click or drag to resize

FileTarget Class

FileTarget for writing formatted messages to one or more log-files.
Inheritance Hierarchy

Namespace:  NLog.Targets
Assembly:  NLog (in NLog.dll) Version: 6.0.0+cfb73701cda54e2410b006f649f072e90daef707
Syntax
public class FileTarget : TargetWithLayoutHeaderAndFooter

The FileTarget type exposes the following members.

Constructors
  NameDescription
Public methodFileTarget
Initializes a new instance of the FileTarget class.
Public methodFileTarget(String)
Initializes a new instance of the FileTarget class.
Top
Properties
  NameDescription
Public propertyArchiveAboveSize
Gets or sets the size in bytes above which log files will be automatically archived. Zero or negative means disabled.
Public propertyArchiveEvery
Gets or sets a value indicating whether to trigger archive operation based on time-period, by moving active-file to file-path specified by ArchiveFileName
Public propertyArchiveFileName
Legacy archive logic where file-archive-logic moves active file to path specified by ArchiveFileName, and then recreates the active file. Use ArchiveSuffixFormat to control suffix format, instead of now obsolete token {#}
Public propertyArchiveOldFileOnStartup
Gets or sets a value indicating whether any existing log-file should be archived on startup.
Public propertyArchiveSuffixFormat
Gets or sets the format-string to convert archive sequence-number by using string.Format
Public propertyAutoFlush
Gets or sets a value indicating whether to automatically flush the file buffers after each log message.
Public propertyBufferSize
Gets or sets the log file buffer size in bytes.
Public propertyCreateDirs
Gets or sets a value indicating whether to create directories if they do not exist.
Public propertyDeleteOldFileOnStartup
Gets or sets a value indicating whether to delete old log file on startup.
Public propertyDiscardAll
Gets or sets whether or not this target should just discard all data that its asked to write. Mostly used for when testing NLog Stack except final write
Public propertyEnableFileDelete
Gets or sets a value indicating whether to enable log file(s) to be deleted.
Public propertyEncoding
Gets or sets the file encoding.
Public propertyCode exampleFileName
Gets or sets the name of the file to write to.
Public propertyFooter
Gets or sets the footer.
(Inherited from TargetWithLayoutHeaderAndFooter.)
Public propertyHeader
Gets or sets the header.
(Inherited from TargetWithLayoutHeaderAndFooter.)
Protected propertyIsInitialized
Gets a value indicating whether the target has been initialized.
(Inherited from Target.)
Public propertyKeepFileOpen
Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event.
Public propertyLayout
Gets or sets the layout used to format log messages.
(Inherited from TargetWithLayoutHeaderAndFooter.)
Public propertyLineEnding
Gets or sets the line ending mode.
Protected propertyLoggingConfiguration
Gets the logging configuration this target is part of.
(Inherited from Target.)
Public propertyMaxArchiveDays
Gets or sets the maximum days of archive files that should be kept. Zero or negative means disabled.
Public propertyMaxArchiveFiles
Gets or sets the maximum number of archive files that should be kept. Negative means disabled.
Public propertyName
Gets or sets the name of the target.
(Inherited from Target.)
Public propertyOpenFileCacheSize
Gets or sets the maximum number of files to be kept open.
Public propertyOpenFileCacheTimeout
Gets or sets the maximum number of seconds that files are kept open. Zero or negative means disabled.
Public propertyOpenFileFlushTimeout
Gets or sets the maximum number of seconds before open files are flushed. Zero or negative means disabled.
Public propertyReplaceFileContentsOnEachWrite
Gets or sets a value indicating whether to replace file contents on each write instead of appending log message at the end.
Protected propertySyncRoot
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.)
Public propertyWriteBom
Gets or sets a value indicating whether to write BOM (byte order mark) in created files.
Public propertyWriteFooterOnArchivingOnly
Gets or sets a value indicating whether the footer should be written only when the file is archived.
Public propertyWriteHeaderWhenInitialFileNotEmpty
Gets or sets whether to write the Header on initial creation of file appender, even if the file is not empty. Default value is , which means only write header when initial file is empty (Ex. ensures valid CSV files)
Top
Methods
  NameDescription
Public methodStatic memberCalculateNextWeekday
Calculate the DateTime of the requested day of the week.
Protected methodCloseTarget
Closes the target to release any initialized resources
(Overrides TargetCloseTarget.)
Protected methodCreateFileStream
Creates stream for appending to the specified filePath
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
Flushes all pending file operations.
(Overrides TargetFlushAsync(AsyncContinuation).)
Protected methodInitializeTarget
Initializes the target before writing starts
(Overrides TargetInitializeTarget.)
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 methodRenderFormattedMessage
Formats the log event for write.
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)
Writes async log event to the log target.
(Inherited from Target.)
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.
(Overrides TargetWrite(IListAsyncLogEventInfo).)
Protected methodWrite(LogEventInfo)
Writes logging event to the target destination
(Overrides TargetWrite(LogEventInfo).)
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
Remarks
See Also