CodeWithSaar.Extensions.Logging.File 1.0.0-beta1

CodeWithSaar.Extensions.Logging.File

A file logger provider implementation for Microsoft.Extensions.Logging. At this moment, this package is very easy to use in debugging environment.

Refer to the Known-limitations before you use this in production.

Getting Started

• Add NuGet Package:

  dotnet add package CodeWithSaar.Extensions.Logging.File
  

• In ASP.NET Core project, enable the logging provider:

  ...
  // Add services to the container.
  builder.Services.AddLogging(loggingBuilder =>{
      loggingBuilder.AddFile();
  });
  ...
  

  Check out the example project.

• Run the application and see the log output to output.log.

Customization

Set a different file name

There are generally 2 ways to set log configurations.

• By code:

  builder.Services.AddLogging(loggingBuilder =>
  {
      loggingBuilder.AddFile(opt => opt.OutputFilePath = "newfilename.log");
  });
  

• By configuration file (Typically, appsettings.json):

  {
      // General logging
      "Logging": {
          "LogLevel": {
              "Default": "Debug"
          },
          // File provider overwrites
          "FileProvider":
          {
              // Output to output.v2.log file
              "OutputFilePath": "output.v2.log",
              // Specify a different logging level
              "LogLevel":{
                  "Default": "Information"
              }
          }
      }
  }
  

Set different logging levels

Logging levels could be set in through appsettings.json / appsettings.Development.json or whatever the configuration providers in your project.

It would take the default settings like this:

    {
        // Logging Information or above to file
        "Logging": {
            "LogLevel": {
                "Default": "Debug"
            }
        }
    }

Or it could be set to it's own:

{
    // Default logging level of Debug
    "Logging": {
        "LogLevel": {
            "Default": "Debug"
        },
        "FileProvider":
        {
            // Output to output.v2.log file
            "OutputFilePath": "output.v2.log",
            // Specify a different logging level of Information for logs output to the file.
            "LogLevel":{
                "Default": "Information"
            }
        }
    }
}

Known limitations

• Scope is not supported yet;
• There might be concurrency issues;
• File writing performance is not optimized;