Class FileSinkSystem.Configuration
Configuration for file sink
Inherited Members
Namespace: Unity.Logging.Sinks
Syntax
public class Configuration : SinkConfiguration
Constructors
Configuration(LoggerWriterConfig, String, FormatterStruct, Int64, Int32, TimeSpan, Nullable<Boolean>, Nullable<LogLevel>, Nullable<FixedString512Bytes>)
Write logs to the file in a text form
Declaration
public Configuration(LoggerWriterConfig writeTo, string absFileName, FormatterStruct formatter = default(FormatterStruct), long maxFileSizeBytes = 5242880L, int maxRoll = 15, TimeSpan maxTimeSpan = default(TimeSpan), 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 |
Int64 | 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 |
Int32 | 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 |
Nullable<Boolean> | captureStackTrace | True if stack traces should be captured |
Nullable<LogLevel> | minLevel | Minimal level of logs for this particular sink. Null if common level should be used |
Nullable<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 |