CodeWithSaar.Extensions.Logging.File 1.0.0-beta4

CodeWithSaar.Extensions.Logging.File

A very easy to use file logger provider implementation for Microsoft.Extensions.Logging.

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

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, and you are expected to see log entries like this:

  [2022-04-12 12:12:42, Microsoft.Extensions.Hosting.Internal.Host, Debug] Hosting starting
  [2022-04-12 12:12:42, Microsoft.Hosting.Lifetime, Information] Now listening on: https://localhost:7038
  [2022-04-12 12:12:42, Microsoft.Hosting.Lifetime, Information] Now listening on: http://localhost:5125
  [2022-04-12 12:12:42, Microsoft.Hosting.Lifetime, Information] Application started. Press Ctrl+C to shut down.
  [2022-04-12 12:12:42, Microsoft.Hosting.Lifetime, Information] Hosting environment: Development
  [2022-04-12 12:12:42, Microsoft.Hosting.Lifetime, Information] Content root path: D:\Repos\CodeWithSaar.Extensions.Logging\examples\WebAPIExample\
  [2022-04-12 12:12:42, Microsoft.Extensions.Hosting.Internal.Host, Debug] Hosting started
  [2022-04-12 12:12:44, Microsoft.Hosting.Lifetime, Information] Application is shutting down...
  [2022-04-12 12:12:44, Microsoft.Extensions.Hosting.Internal.Host, Debug] Hosting stopping
  [2022-04-12 12:12:44, Microsoft.Extensions.Hosting.Internal.Host, Debug] Hosting stopped
  

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"
            }
        }
    }
}

Other customizations

There are more options than just the filename. All supports the settings from either the delegate in code or the configuration providers (like it in appsettings.json). Refer to FileLoggerOptions.cs for more properties to be customized like: ShowFullCategoryName, TimestampFormat, etc.

Known limitations

• Scope needs to be implemented;
• Writing performance needs to be benchmarked;