ElmahCoreEx.Postgresql 2.1.3

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

// Install ElmahCoreEx.Postgresql as a Cake Tool
#tool nuget:?package=ElmahCoreEx.Postgresql&version=2.1.3                

Build Status Latest Version Version Pre-release Last Commit

Code Quality Dependencies

License Contributors

About

This is a fork of the ElmahCore project, with changes for PR's that were sitting idle. It should be an almost slot in replacement for ElmahCore v2.1.2.

See changelog.md for any further changes from v2.1.2

The interfaces and namespaces have been kept the same.

License

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

Warnings & Dragons

The source code for the front end appears non-existent, in ElmahCore the front end Vue SPA files are all minified. Consider this a warning sign for the continuation of the front end without a rewrite WITH SOURCE. Source-maps may have enough content to obtain the code but this has not be investigated.

Using ElmahCore

ELMAH for Net.Standard 2.0 and .Net 6

Add NuGet package ElmahCoreEx

Simple usage

// Startup.cs
services.AddElmah() //in ConfigureServices
// ...
app.UseElmah(); //in Configure, must be set after initializing other exception handlers
    //such as UseExceptionHandler and UseDeveloperExceptionPage

Default ELMAH endpoint 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;
});
app.UseAuthentication();
app.UseAuthorization();
app.UseElmah(); //needs to be placed after `UseAuthentication` and `UseAuthorization`

or the user will be redirected to the sign in screen even if they are authenticated.

Change Error Log type

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

public class MyErrorLog: ErrorLog {
    // Implement ErrorLog
}    

The ErrorLog adapters:

  • MemoryErrorLog – store errors in memory (by default)
  • XmlFileErrorLog – store errors in XML files
  • SqlErrorLog - store errors in MS SQL (add reference to ElmahCoreEx.Sql)
  • MysqlErrorLog - store errors in MySQL (add reference to ElmahCoreEx.MySql)
  • PgsqlErrorLog - store errors in PostgreSQL (add reference to ElmahCoreEx.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

Source Preview

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

services.AddElmah(options =>
{
   options.SourcePaths = new []
   {
      @"D:\src\ElmahCore.DemoCore6",
      @"D:\src\ElmahCore.Mvc",
      @"D:\src\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.

Logging method parameters

Since version 2.0.6 ElmahCore can log method parameters.

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 or IErrorNotifierWithId 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 implemented

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 is compatible.  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

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
2.1.3 1,195 7/7/2023
2.1.3-beta.1 77 6/27/2023
2.1.3-alpha.2 77 6/27/2023
2.1.3-alpha.1.20 75 6/27/2023
2.1.3-alpha.1.2 75 6/5/2023
2.1.3-alpha.1.1 76 6/5/2023
2.1.3-alpha.1 75 6/5/2023
2.1.3-alpha.0.20 79 6/3/2023
2.1.3-alpha.0 82 6/2/2023
0.0.0-alpha.0.127 81 6/2/2023