Class FileSinkSystem.Configuration

Configuration for file sink

Inheritance
object
SinkConfiguration
FileSinkSystem.Configuration
Inherited Members
Namespace: Unity.Logging.Sinks
Assembly: Unity.Logging.dll
Syntax
public class FileSinkSystem.Configuration : SinkConfiguration

Constructors

Configuration(LoggerWriterConfig, string, FormatterStruct, long, int, TimeSpan, bool?, LogLevel?, FixedString512Bytes?)

Write logs to the file in a text form

Declaration
public Configuration(LoggerWriterConfig writeTo, string absFileName, FormatterStruct formatter = default, long maxFileSizeBytes = 5242880, int maxRoll = 15, TimeSpan maxTimeSpan = default, bool? captureStackTrace = null, LogLevel? minLevel = null, FixedString512Bytes? outputTemplate = null)
Parameters
Type Name Description
LoggerWriterConfig writeTo

Logger config
string absFileName

Absolute file path to the log file
FormatterStruct formatter

Formatter that should be used by this sink. Text is default
long maxFileSizeBytes

Threshold of file size in bytes after which new file should be created (rolling). Default of 5 MB. Set to 0 MB if no rolling by file size is needed
int maxRoll

Max amount of rolls after which old files will be rewritten
TimeSpan maxTimeSpan

Threshold of time after which new file should be created (rolling). 'default' if no rolling by time is needed
bool? captureStackTrace

True if stack traces should be captured
LogLevel? minLevel

Minimal level of logs for this particular sink. Null if common level should be used
FixedString512Bytes? outputTemplate

Output message template for this particular sink. Null if common template should be used

Fields

CurrentFileConfig

Instance of FileSinkSystem.CurrentFileConfiguration

Declaration
public FileSinkSystem.CurrentFileConfiguration CurrentFileConfig
Field Value
Type Description
FileSinkSystem.CurrentFileConfiguration

GeneralConfig

Instance of FileSinkSystem.GeneralSinkConfiguration

Declaration
public FileSinkSystem.GeneralSinkConfiguration GeneralConfig
Field Value
Type Description
FileSinkSystem.GeneralSinkConfiguration

RollingFileConfig

Instance of FileSinkSystem.RollingFileConfiguration

Declaration
public FileSinkSystem.RollingFileConfiguration RollingFileConfig
Field Value
Type Description
FileSinkSystem.RollingFileConfiguration

Methods

CreateSinkInstance(Logger)

Creates the FileSink

Declaration
public override SinkSystemBase CreateSinkInstance(Logger logger)
Parameters
Type Name Description
Logger logger

Logger that owns sink
Returns
Type Description
SinkSystemBase

SinkSystemBase
Overrides