ElmahCore 2.1.2

dotnet add package ElmahCore --version 2.1.2                
NuGet\Install-Package ElmahCore -Version 2.1.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="ElmahCore" Version="2.1.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ElmahCore --version 2.1.2                
#r "nuget: ElmahCore, 2.1.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 ElmahCore as a Cake Addin
#addin nuget:?package=ElmahCore&version=2.1.2

// Install ElmahCore as a Cake Tool
#tool nuget:?package=ElmahCore&version=2.1.2                

This project is licensed under the terms of the Apache license 2.0.

Using ElmahCore

ELMAH for Net.Standard and Net.Core (3.1, 5, 6)

alt text

Add nuget package elmahcore

Simple usage

Startup.cs

1)	services.AddElmah() in ConfigureServices 
2)	app.UseElmah(); in Configure

app.UseElmah() must be after initializing other exception handling middleware, such as (UseExceptionHandler, UseDeveloperExceptionPage, etc.)

Default elmah path ~/elmah.

Change URL path

services.AddElmah(options => options.Path = "you_path_here")

Restrict access to the Elmah url

services.AddElmah(options =>
{
        options.OnPermissionCheck = context => context.User.Identity.IsAuthenticated;
});

Note: app.UseElmah(); needs to be after

app.UseAuthentication();
app.UseAuthorization();
app.UseElmah();

or the user will be redirected to the sign in screen even if he is authenticated.

Change Error Log type

You can create your own error log, which will store errors anywhere.

    class MyErrorLog: ErrorLog
    //implement ErrorLog

This ErrorLogs available in board:

  • MemoryErrorLog – store errors in memory (by default)
  • XmlFileErrorLog – store errors in XML files
  • SqlErrorLog - store errors in MS SQL (add reference to ElmahCore.Sql)
  • MysqlErrorLog - store errors in MySQL (add reference to ElmahCore.MySql)
  • PgsqlErrorLog - store errors in PostgreSQL (add reference to ElmahCore.Postgresql)
services.AddElmah<XmlFileErrorLog>(options =>
{
    options.LogPath = "~/log"; // OR options.LogPath = "с:\errors";
});
services.AddElmah<SqlErrorLog>(options =>
{
    options.ConnectionString = "connection_string";
    options.SqlServerDatabaseSchemaName = "Errors"; //Defaults to dbo if not set
    options.SqlServerDatabaseTableName = "ElmahError"; //Defaults to ELMAH_Error if not set
});

Raise exception

public IActionResult Test()
{
    HttpContext.RaiseError(new InvalidOperationException("Test"));
    ...
}

Microsoft.Extensions.Logging support

Since version 2.0 ElmahCore support Microsoft.Extensions.Logging alt text

Source Preview

Since version 2.0.1 ElmahCore support source preview. Just add paths to source files.

services.AddElmah(options =>
{
   options.SourcePaths = new []
   {
      @"D:\tmp\ElmahCore.DemoCore3",
      @"D:\tmp\ElmahCore.Mvc",
      @"D:\tmp\ElmahCore"
   };
});

Log the request body

Since version 2.0.5 ElmahCore can log the request body.

Logging SQL request body

Since version 2.0.6 ElmahCore can log the SQL request body. alt text

Logging method parameters

Since version 2.0.6 ElmahCore can log method parameters. alt text

using ElmahCore;
...

public void TestMethod(string p1, int p2)
{
    // Logging method parameters
    this.LogParams((nameof(p1), p1), (nameof(p2), p2));
    ...
}

Using UseElmahExceptionPage

You can replace UseDeveloperExceptionPage to UseElmahExceptionPage

if (env.IsDevelopment())
{
   //app.UseDeveloperExceptionPage();
   app.UseElmahExceptionPage();
}

Using Notifiers

You can create your own notifiers by implement IErrorNotifier interface and add notifier to Elmah options:

services.AddElmah<XmlFileErrorLog>(options =>
{
    options.Path = @"errors";
    options.LogPath = "~/logs";
    options.Notifiers.Add(new ErrorMailNotifier("Email",emailOptions));
});

Each notifier must have unique name.

Using Filters

You can use Elmah XML filter configuration in separate file, create and add custom filters:

services.AddElmah<XmlFileErrorLog>(options =>
{
    options.FiltersConfig = "elmah.xml";
    options.Filters.Add(new MyFilter());
})

Custom filter must implement IErrorFilter. XML filter config example:

<?xml version="1.0" encoding="utf-8" ?>
<elmah>
	<errorFilter>
		<notifiers>
			<notifier name="Email"/>
		</notifiers>
		<test>
			<and>
				<greater binding="HttpStatusCode" value="399" type="Int32" />
				<lesser  binding="HttpStatusCode" value="500" type="Int32" />
			</and> 
		</test>
	</errorFilter>
</elmah>

see more here

JavaScript filters not yet impemented 😦

Add notifiers to errorFilter node if you do not want to send notifications Filtered errors will be logged, but will not be sent.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.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 (15)

Showing the top 5 NuGet packages that depend on ElmahCore:

Package Downloads
Shesha.Elmah

Package Description

CrispyWaffle.Elmah

The CrispyWaffle ELMAH bridge package

Lookif.Layers.WebFramework

WebFramework Related to "Lookif template".

MDN.AspNetCore.Api

Package Description

MoravianStar.WebAPI

Package Description

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on ElmahCore:

Repository Stars
dotnetzoom/AspNetCore-WebApi-Course
🥇 Professional REST API design with ASP.NET Core WebAPI
shesha-io/shesha-framework
An open-source Low-Code development framework for .NET developers. Create .NET based business applications with 80% less code.
Version Downloads Last updated
2.1.2 1,310,472 5/14/2022
2.1.1 104,214 1/24/2022
2.1.0 7,916 1/19/2022
2.0.7 148,876 8/31/2021
2.0.6 511,935 2/6/2021
2.0.5 15,708 1/21/2021
2.0.4 3,087 1/20/2021
2.0.3 7,815 1/13/2021
2.0.2 4,453 12/28/2020
2.0.1 1,317 12/28/2020
2.0.0 1,545 12/25/2020
1.2.7 81,080 12/13/2020
1.2.6 6,456 12/13/2020
1.2.5 775,073 3/15/2019
1.2.4 38,304 2/5/2019
1.2.3 77,858 1/3/2019
1.2.2 2,912 12/17/2018
1.2.1 5,117 12/3/2018
1.2.0 16,255 10/9/2018
1.0.4 32,238 12/8/2017
1.0.3 1,889 12/8/2017
1.0.2 1,830 12/8/2017
1.0.1 1,842 12/8/2017
1.0.0 5,368 12/7/2017