Skip to content

Latest commit

 

History

History
229 lines (191 loc) · 6.91 KB

RollingFileLogProvider.md

File metadata and controls

229 lines (191 loc) · 6.91 KB
sidebar_position sidebar_label
11
How to use and configure RollingFileLogProvider

How to use and configure RollingFileLogProvider

The RollingFileLogProvider can be instantiated in one of two ways.

With a template:

file

  • Type: string
  • Description: The path to a writable file.

template

  • Type: string
  • Description: The template used to format log entries. See TemplateLogFormatter for more information.

level

  • Type: LogLevel enum (NotSet, Debug, Info, Warn, Error, Fatal, Audit)
  • Description: The level of the log provider. If NotSet, the level of the containing Logger is used.

timeout

  • Type: Nullable<TimeSpan>
  • Description: The timeout of the log provider.

maxFileSizeKilobytes

  • Type: int
  • Description: The maximum file size, in bytes, of the file. If the file size is greater than this value, it is archived.

maxArchiveCount

  • Type: int
  • Description: The maximum number of archive files that will be kept. If the number of archive files is greater than this value, then they are deleted, oldest first.

rolloverPeriod

  • Type: RolloverPeriod enum (Never, Daily, Hourly)
  • Description: The rollover period, indicating if/how the file should archived on a periodic basis.

With a formatter:

file

  • Type: string
  • Description: The path to a writable file.

formatter

  • Type: ILogFormatter
  • Description: An object that formats log entries prior to writing to standard out. See ILogFormatter for more information.

level

  • Type: LogLevel enum (NotSet, Debug, Info, Warn, Error, Fatal, Audit)
  • Description: The level of the log provider. If NotSet, the level of the containing Logger is used.

timeout

  • Type: Nullable<TimeSpan>
  • Description: The timeout of the log provider.

maxFileSizeKilobytes

  • Type: int
  • Description: The maximum file size, in bytes, of the file. If the file size is greater than this value, it is archived.

maxArchiveCount

  • Type: int
  • Description: The maximum number of archive files that will be kept. If the number of archive files is greater than this value, then they are deleted, oldest first.

rolloverPeriod

  • Type: RolloverPeriod enum (Never, Daily, Hourly)
  • Description: The rollover period, indicating if/how the file should archived on a periodic basis.

Adding to Dependency Injection

To add a RollingFileLogProvider to a logger, call one of the five AddRollingFileLogProvider extension method overloads. Four of the overloads are similar, differing by how the ILogFormatter is specified.

Specifying a custom template:

public void ConfigureServices(IServiceCollection services)
{
    services.AddLogger()
        .AddRollingFileLogProvider(
            file:       "C:\\my\\path\\log.txt",
            template:   "{level}: {message}",
            level:      LogLevel.Info,
            timeout:    TimeSpan.FromSeconds(1),
            maxFileSizeKilobytes: 2048,
            maxArchiveCount: 20,
            rolloverPeriod: RolloverPeriod.Daily);
}

Specifying a custom ILogFormatter:

public void ConfigureServices(IServiceCollection services)
{
    IDependency dependency = new MyDependency();
    int parameter = 12345;

    ILogFormatter formatter = new CustomLogFormatter(dependency, parameter);

    services.AddLogger()
        .AddRollingFileLogProvider(
            file:       "C:\\my\\path\\log.txt",
            formatter:  formatter,
            level:      LogLevel.Info,
            timeout:    TimeSpan.FromSeconds(1),
            maxFileSizeKilobytes: 2048,
            maxArchiveCount: 20,
            rolloverPeriod: RolloverPeriod.Daily);
}

Specifying a custom ILogFormatter generically including custom constructor parameters:

public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<IDependency, MyDependency>();

    services.AddLogger()
        .AddRollingFileLogProvider<CustomLogFormatter>(
            file:                   "C:\\my\\path\\log.txt",
            level:                  LogLevel.Info,
            timeout:                TimeSpan.FromSeconds(1),
            maxFileSizeKilobytes:   2048,
            maxArchiveCount:        20,
            rolloverPeriod:         RolloverPeriod.Daily,
            logFormatterParameters: 12345);
}

Specifying a custom ILogFormatter with a callback function:

public void ConfigureServices(IServiceCollection services)
{
    services.AddLogger()
        .AddRollingFileLogProvider(
            file:                   "C:\\my\\path\\log.txt",
            formatterRegistration:  serviceProvider => new CustomLogFormatter(new MyDependency(), 12345),
            level:                  LogLevel.Info,
            timeout:                TimeSpan.FromSeconds(1),
            maxFileSizeKilobytes:   2048,
            maxArchiveCount:        20,
            rolloverPeriod:         RolloverPeriod.Daily);
}

Fully customizing the rolling file log provider with a callback function:

public void ConfigureServices(IServiceCollection services)
{
    services.AddLogger()
        .AddRollingFileLogProvider(options =>
        {
            options.File = "C:\\my\\path\\log.txt";
            // Could also set the formatter with one of the other
            // SetFormatter overloads or the SetTemplate method.
            options.SetFormatter<CustomLogFormatter>(12345);
            options.Level = LogLevel.Info;
            options.Timeout = TimeSpan.FromSeconds(1);
            options.MaxFileSizeKilobytes = 2048;
            options.MaxArchiveCount = 20;
            options.RolloverPeriod = RolloverPeriod.Daily;
        });
}

Configuration for RollingFileLogProvider

Specifying a template:

{
  "Rocklib.Logging": {
    "Providers": [
      {
        "Type": "RockLib.Logging.RollingFileLogProvider, RockLib.Logging",
        "Value": {
          "File": "C:\\my\\path\\log.txt",
          "Template": "{level}: {message}",
          "Level": "Info",
          "Timeout": "00:00:01",
          "MaxFileSizeKilobytes": 2048,
          "MaxArchiveCount": 20,
          "RolloverPeriod": "Daily"
        }
      }
    ]
  }
}

Specifying an ILogFormatter:

{
  "Rocklib.Logging": {
    "Providers": [
      {
        "Type": "RockLib.Logging.RollingFileLogProvider, RockLib.Logging",
        "Value": {
          "File": "C:\\my\\path\\log.txt",
          "Formatter": {
            "Type": "MyAssembly.CustomLogFormatter, MyAssembly",
            "Value": {
              "Dependency": {
                "Type": "MyAssembly.MyDependency, MyAssembly"
              },
              "Parameter": 12345
            }
          },
          "Level": "Info",
          "Timeout": "00:00:01",
          "MaxFileSizeKilobytes": 2048,
          "MaxArchiveCount": 20,
          "RolloverPeriod": "Daily"
        }
      }
    ]
  }
}