Log4net.Extension.AspNetCore 1.0.2

.NET 5.0 .NET Core 1.1 .NET Standard 2.0
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Log4net.Extension.AspNetCore --version 1.0.2
NuGet\Install-Package Log4net.Extension.AspNetCore -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Log4net.Extension.AspNetCore" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Log4net.Extension.AspNetCore --version 1.0.2
#r "nuget: Log4net.Extension.AspNetCore, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Log4net.Extension.AspNetCore as a Cake Addin
#addin nuget:?package=Log4net.Extension.AspNetCore&version=1.0.2

// Install Log4net.Extension.AspNetCore as a Cake Tool
#tool nuget:?package=Log4net.Extension.AspNetCore&version=1.0.2

Log4net.Extension.AspNetCore

Lightweight Logging Extension implementation of log4net

Install Package

https://www.nuget.org/packages/Log4net.Extension.AspNetCore

Configure

  • Add the AddLog4Net() call into your Configure method of the Startup class.
using Microsoft.Extensions.Logging;

public class Startup
{
    //...

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        //...

        loggerFactory.AddLog4Net(); 

        //...
    }
}
  • Add a log4net.config file with the content:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  
  <log4net>
    <appender name="DebugAppender" type="log4net.Appender.ConsoleAppender,log4net">
      <layout type="log4net.Layout.PatternLayout,log4net">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
      </layout>
    </appender>
    <appender name="InfoAppender" type="log4net.Appender.RollingFileAppender,log4net">
      <param name="File" value="Logs/" />
      <param name="AppendToFile" value="true" />
      <param name="RollingStyle" value="Date" />
      <param name="DatePattern" value="&quot;Logs_&quot;yyyyMMdd&quot;_All.txt&quot;" />
      <param name="StaticLogFileName" value="false" />
      <layout type="log4net.Layout.PatternLayout,log4net">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
      </layout>
    </appender>
    <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender,log4net">
      <param name="File" value="Logs/" />
      <param name="AppendToFile" value="true" />
      <param name="RollingStyle" value="Date" />
      <param name="DatePattern" value="&quot;Logs_&quot;yyyyMMdd&quot;.txt&quot;" />
      <param name="StaticLogFileName" value="false" />
      <layout type="log4net.Layout.PatternLayout,log4net">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <levelMin value="ERROR" />
        <levelMax value="FATAL" />
      </filter>
    </appender>
    <root>
      <level value="ALL" />
      <appender-ref ref="ErrorAppender" />
      <appender-ref ref="InfoAppender" />
    </root>
    <logger name="WebLogger">
      <appender-ref ref="ErrorAppender" />
    </logger>
  </log4net>
</configuration>
  • Add a global ExceptionFilter:
public void ConfigureServices(IServiceCollection services)
{
    //...

    services.AddControllers(options =>
    {
        options.Filters.Add<ExceptionFilter>();
    });

    //...
}
  • appsettings.json
{
  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}
  • appsettings.Development.json
{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}
  • Add the log directory as static, so we can view the logs online.
using Microsoft.Extensions.Logging;

public class Startup
{
    //...

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        //...

        loggerFactory.AddLog4Net(); 

        //...

        app.UseFileServer(new FileServerOptions()
        {
            FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"Logs")),
            RequestPath = new PathString("/Log"),
            EnableDirectoryBrowsing = true
        });

        //...
    }
}

Global Exception Filter

public class ExceptionFilter : IExceptionFilter
{
    private readonly ILogger<ExceptionFilter> _logger;
    public ExceptionFilter(ILogger<ExceptionFilter> logger)
    {
        _logger = logger;
    }

    public void OnException(ExceptionContext filterContext)
    {
        var log = new StringBuilder();

        //log the url
        if (filterContext.HttpContext.Request.GetDisplayUrl() != null)
            log.AppendLine(filterContext.HttpContext.Request.GetDisplayUrl());

        log.AppendLine($"\tIP: {filterContext.HttpContext.Connection.RemoteIpAddress}");

        foreach (var key in filterContext.HttpContext.Request.Headers.Keys)
        {
            log.AppendLine($"\t{key}: {filterContext.HttpContext.Request.Headers[key]}");
        }

        var exception = filterContext.Exception;
        log.AppendLine("\tError Message:" + exception.Message);
        if (exception.InnerException != null)
        {
            PrintInnerException(exception.InnerException, log);
        }
        log.AppendLine("\tError HelpLink:" + exception.HelpLink);
        log.AppendLine("\tError StackTrace:" + exception.StackTrace);

        _logger.LogError(log.ToString());
    }

    private void PrintInnerException(Exception ex, StringBuilder log)
    {
        log.AppendLine("\tError InnerMessage:" + ex.Message);
        if (ex.InnerException != null)
        {
            PrintInnerException(ex.InnerException, log);
        }
    }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.1 is compatible.  netcoreapp2.0 is compatible.  netcoreapp2.1 is compatible.  netcoreapp2.2 is compatible.  netcoreapp3.0 is compatible.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.5 1,427 11/16/2022
1.0.4 424 4/14/2022
1.0.3 345 7/12/2021
1.0.2 547 12/5/2020
1.0.0 414 12/5/2020

Add multi-version support