Methods and steps of logging with log4net under. Net core

Time:2021-1-11

Log4NetI believe everyone is familiar with it. It’s a mainstream and famous log component.

Official website:logging.apache.org

Open source address:https://github.com/apache/logging-log4net

Best practices

Adding component packages to a project


Install-Package log4net

add tolog4net.configfile


<?xml version="1.0" encoding="utf-8" ?>
<configuration>
 <configSections>
 <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
 </configSections>
 <log4net debug="false">

 <appender name="info" type="log4net.Appender.RollingFileAppender,log4net">
  <param name="File" value="log4net/info/" />
  <param name="AppendToFile" value="true" />
  <param name="MaxSizeRollBackups" value="-1"/>
  <param name="MaximumFileSize" value="5MB"/>
  <param name="RollingStyle" value="Composite" />
  <param name="DatePattern" value="yyyyMMdd\HH&quot;.log&quot;" />
  <param name="StaticLogFileName" value="false" />
  <layout type="log4net.Layout.PatternLayout,log4net">
  <param name="ConversionPattern" value="%n
{
 &quot;system&quot;: &quot;Meowv.Blog&quot;,
 &quot;datetime&quot;: &quot;%d&quot;,
 &quot;description&quot;: &quot;%m&quot;,
 &quot;level&quot;: &quot;%p&quot;,
 &quot;info&quot;: &quot;%exception&quot;
}" />
  </layout>
  <filter type="log4net.Filter.LevelRangeFilter">
  <levelMin value="INFO" />
  <levelMax value="INFO" />
  </filter>
 </appender>

 <appender name="error" type="log4net.Appender.RollingFileAppender,log4net">
  <param name="File" value="log4net/error/" />
  <param name="AppendToFile" value="true" />
  <param name="MaxSizeRollBackups" value="-1"/>
  <param name="MaximumFileSize" value="5MB"/>
  <param name="RollingStyle" value="Composite" />
  <param name="DatePattern" value="yyyyMMdd\HH&quot;.log&quot;" />
  <param name="StaticLogFileName" value="false" />
  <layout type="log4net.Layout.PatternLayout,log4net">
  <param name="ConversionPattern" value="%n
{
 &quot;system&quot;: &quot;Meowv.Blog&quot;,
 &quot;datetime&quot;: &quot;%d&quot;,
 &quot;description&quot;: &quot;%m&quot;,
 &quot;level&quot;: &quot;%p&quot;,
 &quot;info&quot;: &quot;%exception&quot;
}" />
  </layout>
  <filter type="log4net.Filter.LevelRangeFilter">
  <levelMin value="ERROR" />
  <levelMax value="ERROR" />
  </filter>
 </appender>

 <root>
  <level value="ALL"></level>
  <appender-ref ref="info"/>
  <appender-ref ref="error"/>
 </root>

 </log4net>

</configuration>

Console project


using log4net;
using log4net.Config;
using System;
using System.IO;
using System.Reflection;

namespace ConsoleAppDemo
{
 class Program
 {
  static void Main(string[] args)
  {
   var log4netRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
   XmlConfigurator.Configure(log4netRepository, new FileInfo("log4net.config"));

   ILog log = LogManager.GetLogger(log4netRepository.Name, "NETCorelog4net");

   log.Info("NETCorelog4net log");
   log.Info("test log");
   log.Error("error");
   log.Info("linezero");
   Console.ReadKey();
  }
 }
}

 

Aspnetcore project

Create a new static class and write an extension methodUseLog4Net(), forlog4netinitialization.


public static class Log4NetExtensions
{
 public static IHostBuilder UseLog4Net(this IHostBuilder hostBuilder)
 {
  var log4netRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
  XmlConfigurator.Configure(log4netRepository, new FileInfo("log4net.config"));

  return hostBuilder;
 }
}

Extended method returnIHostBuilderObject, so that you can chain call, beautify the code, and thenProgram.csUsing extension methods inUseLog4Net()


using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

namespace WebAppDemo
{
 public class Program
 {
  public static void Main(string[] args)
  {
   CreateHostBuilder(args).Build().Run();
  }

  public static IHostBuilder CreateHostBuilder(string[] args) =>
   Host.CreateDefaultBuilder(args)
    .ConfigureWebHostDefaults(webBuilder =>
    {
     webBuilder.UseStartup<Startup>();
    }).UseLog4Net();
 }
}

After the configuration is completed, write the log anywhere.


using log4net;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Linq;

namespace WebAppDemo.Controllers
{
 [ApiController]
 [Route("[controller]")]
 public class WeatherForecastController : ControllerBase
 {
  private static readonly string[] Summaries = new[]
  {
   "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
  };

  private readonly ILog _log;

  public WeatherForecastController()
  {
   _log = LogManager.GetLogger(typeof(WeatherForecastController));
  }

  [HttpGet]
  public IEnumerable<WeatherForecast> Get()
  {
   _log.Info("Hello, this is a Weather api!");
   _log.Warn("Wran !!!");
   _log.Error("Controller Error");

   var rng = new Random();
   return Enumerable.Range(1, 5).Select(index => new WeatherForecast
   {
    Date = DateTime.Now.AddDays(index),
    TemperatureC = rng.Next(-20, 55),
    Summary = Summaries[rng.Next(Summaries.Length)]
   })
   .ToArray();
  }
 }
}

So far, this article about the method and steps of using log4net to record logs under. Net core is introduced here. For more related. Net core log4net content, please search previous articles of developer or continue to browse the following related articles. I hope you can support developer more in the future!