ElmahCore.Common
2.0.4
ELMAH for ASP.NET Core
Install-Package ElmahCore.Common -Version 2.0.4
dotnet add package ElmahCore.Common --version 2.0.4
<PackageReference Include="ElmahCore.Common" Version="2.0.4" />
paket add ElmahCore.Common --version 2.0.4
This project is licensed under the terms of the Apache license 2.0.
Using ElmahCore
ELMAH for Net.Standard and Net.Core
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";
});
Rise exception
public IActionResult Test()
{
HttpContext.RiseError(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:\tmp\ElmahCore.DemoCore3",
@"D:\tmp\ElmahCore.Mvc",
@"D:\tmp\ElmahCore"
};
});
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.
This project is licensed under the terms of the Apache license 2.0.
Using ElmahCore
ELMAH for Net.Standard and Net.Core
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";
});
Rise exception
public IActionResult Test()
{
HttpContext.RiseError(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:\tmp\ElmahCore.DemoCore3",
@"D:\tmp\ElmahCore.Mvc",
@"D:\tmp\ElmahCore"
};
});
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.
Dependencies
-
.NETStandard 2.0
- Microsoft.AspNetCore.Hosting.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.WebUtilities (>= 2.2.0)
- Microsoft.Extensions.Options (>= 5.0.0)
- System.Text.Json (>= 4.6.0)
Used By
NuGet packages (4)
Showing the top 4 NuGet packages that depend on ElmahCore.Common:
Package | Downloads |
---|---|
ElmahCore
ELMAH for ASP.NET Core
|
|
ElmahCore.Sql
ELMAH for ASP.NET Core
|
|
ElmahCore.Postgresql
ELMAH for ASP.NET Core
|
|
ElmahCore.MySql
ELMAH for ASP.NET Core
|
GitHub repositories
This package is not used by any popular GitHub repositories.