FileTarget Class |
Namespace: NLog.Targets
The FileTarget type exposes the following members.
Name | Description | |
---|---|---|
FileTarget |
Initializes a new instance of the FileTarget class.
| |
FileTarget(String) |
Initializes a new instance of the FileTarget class.
|
Name | Description | |
---|---|---|
ArchiveAboveSize |
Gets or sets the size in bytes above which log files will be automatically archived.
| |
ArchiveDateFormat |
Gets or sets a value specifying the date format to use when archiving files.
| |
ArchiveEvery |
Gets or sets a value indicating whether to automatically archive log files every time the specified time passes.
| |
ArchiveFileKind |
Is the ArchiveFileName an absolute or relative path?
| |
ArchiveFileName |
Gets or sets the name of the file to be used for an archive.
| |
ArchiveNumbering |
Gets or sets the way file archives are numbered.
| |
ArchiveOldFileOnStartup |
Gets or sets a value indicating whether to archive old log file on startup.
| |
ArchiveOldFileOnStartupAboveSize |
Gets or sets a value of the file size threshold to archive old log file on startup.
| |
AutoFlush |
Gets or sets a value indicating whether to automatically flush the file buffers after each log message.
| |
BufferSize |
Gets or sets the log file buffer size in bytes.
| |
CleanupFileName |
Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes.
If set to false, nothing gets written when the filename is wrong.
| |
ConcurrentWriteAttemptDelay |
Gets or sets the delay in milliseconds to wait before attempting to write to the file again.
| |
ConcurrentWriteAttempts |
Gets or sets the number of times the write is appended on the file before NLog
discards the log message.
| |
ConcurrentWrites |
Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host.
| |
CreateDirs |
Gets or sets a value indicating whether to create directories if they do not exist.
| |
DeleteOldFileOnStartup |
Gets or sets a value indicating whether to delete old log file on startup.
| |
DiscardAll |
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
| |
EnableArchiveFileCompression |
Gets or sets a value indicating whether to compress archive files into the zip archive format.
| |
EnableFileDelete |
Gets or sets a value indicating whether to enable log file(s) to be deleted.
| |
Encoding |
Gets or sets the file encoding.
| |
FileAttributes |
Gets or sets the file attributes (Windows only).
| |
FileCompressor |
Used to compress log files during archiving.
This may be used to provide your own implementation of a zip file compressor,
on platforms other than .Net4.5.
Defaults to ZipArchiveFileCompressor on .Net4.5 and to null otherwise.
| |
FileName |
Gets or sets the name of the file to write to.
| |
FileNameKind |
Is the FileName an absolute or relative path?
| |
Footer |
Gets or sets the footer.
(Inherited from TargetWithLayoutHeaderAndFooter.) | |
ForceManaged |
Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation.
| |
ForceMutexConcurrentWrites |
Gets or sets a value indicating whether file creation calls should be synchronized by a system global mutex.
| |
Header |
Gets or sets the header.
(Inherited from TargetWithLayoutHeaderAndFooter.) | |
IsInitialized |
Gets a value indicating whether the target has been initialized.
(Inherited from Target.) | |
KeepFileOpen |
Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event.
| |
Layout |
Gets or sets the text to be rendered.
(Inherited from TargetWithLayoutHeaderAndFooter.) | |
LineEnding |
Gets or sets the line ending mode.
| |
LoggingConfiguration |
Gets the logging configuration this target is part of.
(Inherited from Target.) | |
MaxArchiveDays |
Gets or sets the maximum days of archive files that should be kept.
| |
MaxArchiveFiles |
Gets or sets the maximum number of archive files that should be kept.
| |
Name |
Gets or sets the name of the target.
(Inherited from Target.) | |
NewLineChars |
Gets the characters that are appended after each line.
| |
OpenFileCacheSize |
Gets or sets the number of files to be kept open. Setting this to a higher value may improve performance
in a situation where a single File target is writing to many files
(such as splitting by level or by logger).
| |
OpenFileCacheTimeout |
Gets or sets the maximum number of seconds that files are kept open. Zero or negative means disabled.
| |
OpenFileFlushTimeout |
Gets or sets the maximum number of seconds before open files are flushed. Zero or negative means disabled.
| |
ReplaceFileContentsOnEachWrite |
Gets or sets a value indicating whether to replace file contents on each write instead of appending log message at the end.
| |
SyncRoot |
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.) | |
WriteBom |
Gets or sets a value indicating whether to write BOM (byte order mark) in created files.
Defaults to true for UTF-16 and UTF-32
| |
WriteFooterOnArchivingOnly |
Gets or sets a value indicating whether the footer should be written only when the file is archived.
| |
WriteHeaderWhenInitialFileNotEmpty |
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)
|
Name | Description | |
---|---|---|
CalculateNextWeekday |
Calculate the DateTime of the requested day of the week.
| |
CleanupInitializedFiles |
Removes records of initialized files that have not been
accessed in the last two days.
| |
CleanupInitializedFiles(DateTime) |
Removes records of initialized files that have not been
accessed after the specified date.
| |
CloseTarget |
Closes the file(s) opened for writing.
(Overrides TargetCloseTarget.) | |
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 |
Flushes all pending file operations.
(Overrides TargetFlushAsync(AsyncContinuation).) | |
InitializeTarget |
Initializes file logging by creating data structures that
enable efficient multi-file logging.
(Overrides TargetInitializeTarget.) | |
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.) | |
RenderFormattedMessage |
Formats the log event for write.
| |
RenderFormattedMessageToStream |
Gets the bytes to be written to the file.
| |
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.) | |
TransformStream |
Modifies the specified byte array before it gets sent to a file.
| |
Write(AsyncLogEventInfo) |
Writes async log event to the log target.
(Inherited from Target.) | |
Write(IListAsyncLogEventInfo) |
Writes the specified array of logging events to a file specified in the FileName
parameter.
(Overrides TargetWrite(IListAsyncLogEventInfo).) | |
Write(LogEventInfo) |
Writes the specified logging event to a file specified in the FileName
parameter.
(Overrides TargetWrite(LogEventInfo).) | |
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.) |