-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Burak Akgerman
committed
Dec 29, 2022
1 parent
43502d2
commit b1a0909
Showing
1 changed file
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
![NLog](https://raw.githubusercontent.com/NLog/NLog.github.io/master/images/NLog-logo-only_small.png) | ||
|
||
# NLog.Web (ASP.NET & ASP.NET Core) | ||
|
||
[![NuGet Release](https://img.shields.io/nuget/v/NLog.Web.AspNetCore.svg?label=NLog.Web.AspNetCore)](https://www.nuget.org/packages/NLog.Web.AspNetCore) | ||
<!--[![NuGet Pre Release](https://img.shields.io/nuget/vpre/NLog.Web.AspNetCore.svg?label=NLog.Web.AspNetCore)](https://www.nuget.org/packages/NLog.Web.AspNetCore)--> | ||
|
||
[![NuGet Release](https://img.shields.io/nuget/v/NLog.Web.svg?label=NLog.Web)](https://www.nuget.org/packages/NLog.Web) | ||
<!--[![NuGet Pre Release](https://img.shields.io/nuget/vpre/NLog.Web.svg?label=NLog.Web)](https://www.nuget.org/packages/NLog.Web) --> | ||
|
||
[![Build status](https://img.shields.io/appveyor/ci/nlog/nlog-web/master.svg)](https://ci.appveyor.com/project/nlog/nlog-web/branch/master) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=ncloc)](https://sonarcloud.io/dashboard/?id=nlog.web&branch=master) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=bugs)](https://sonarcloud.io/dashboard/?id=nlog.web&branch=master) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=vulnerabilities)](https://sonarcloud.io/dashboard/?id=nlog.web&branch=master) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=code_smells)](https://sonarcloud.io/project/issues?id=nlog.web&branch=master&resolved=false&types=CODE_SMELL) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=duplicated_lines_density)](https://sonarcloud.io/component_measures/domain/Duplications?id=nlog.web&branch=master) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=sqale_debt_ratio)](https://sonarcloud.io/dashboard/?id=nlog.web&branch=master) | ||
[![](https://sonarcloud.io/api/project_badges/measure?project=nlog.web&branch=master&metric=coverage)](https://sonarcloud.io/component_measures?id=nlog.web&branch=master&metric=coverage) | ||
|
||
These packages are extensions to [NLog](https://github.com/NLog/NLog/), and provides targets and layout-renderes specific to ASP.NET (Core), MVC and IIS. | ||
|
||
## Getting started with NLog | ||
|
||
- [Getting started for ASP.NET Core 6](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-6) | ||
- [Getting started for ASP.NET Core 5](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-5) | ||
- [Getting started for ASP.NET Core 3.1](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-3) | ||
- [Getting started for .NET Core Console application](https://github.com/NLog/NLog/wiki/Getting-started-with-.NET-Core-2---Console-application) | ||
- [How to use structured logging](https://github.com/NLog/NLog/wiki/How-to-use-structured-logging) | ||
- [Blog posts for how to get started with ASP.NET Core and NLog](https://github.com/damienbod/AspNetCoreNlog) | ||
|
||
### Config | ||
- All config options: [nlog-project.org/config](https://nlog-project.org/config) | ||
|
||
### Troubleshooting | ||
- [Troubleshooting](https://github.com/NLog/NLog/wiki/Logging-troubleshooting) | ||
- [Internal log](https://github.com/NLog/NLog/wiki/Internal-logging) | ||
|
||
|
||
## Releases | ||
|
||
For updates and releases, check [CHANGELOG.MD](CHANGELOG.MD) or [Releases](https://github.com/NLog/NLog.Web/releases) | ||
|
||
## ASP.NET Core | ||
The [NLog.Web.AspNetCore](https://www.nuget.org/packages/NLog.Web.AspNetCore)-package supports the platforms: | ||
|
||
- For ASP.NET Core 6, .NET 6 | ||
- For ASP.NET Core 5, .NET 5 | ||
- For ASP.NET Core 3, .NET Core 3 | ||
- For ASP.NET Core 2.1 .NET Standard 2.0 for .NET 4.6.1 | ||
|
||
ℹ️ Missing the trace and debug logs? [Check your appsettings.json](https://github.com/NLog/NLog.Web/wiki/Missing-trace%5Cdebug-logs-in-ASP.NET-Core-6%3F) | ||
|
||
Use the NLog.Web.AspNetCore package | ||
|
||
- [Supported layout renderers for ASP.NET Core](https://nlog-project.org/config/?tab=layout-renderers&search=package:nlog.web.aspnetcore) | ||
|
||
## ASP.NET (non-core) | ||
|
||
The [NLog.Web](https://www.nuget.org/packages/NLog.Web)-package works with classic ASP.NET MVC | ||
|
||
- [Supported targets for ASP.NET](https://nlog-project.org/config/?tab=targets&search=package:nlog.web) | ||
- [Supported layout renderers for ASP.NET](https://nlog-project.org/config/?tab=layout-renderers&search=package:nlog.web) | ||
- NLog 5.0 requires that NLog.config must include NLog.Web in extensions: | ||
|
||
```xml | ||
<!-- enable ASP.NET layout renderers --> | ||
<extensions> | ||
<add assembly="NLog.Web"/> | ||
</extensions> | ||
``` | ||
|
||
## HTTP module (ASP.NET non-core) | ||
|
||
_note: not listed on https://nlog-project.org/config_ | ||
|
||
There is a ASP.NET ASP.NET HttpModule that enables NLog to hook BeginRequest and EndRequest events easily. | ||
|
||
The `NLogHttpModule` needs a registration in the web.config: | ||
```xml | ||
<system.webServer> | ||
<modules runAllManagedModulesForAllRequests="true"> | ||
<add name="NLog" type="NLog.Web.NLogHttpModule, NLog.Web" /> | ||
</modules> | ||
</system.webServer> | ||
``` | ||
|
||
## Contributions | ||
Contributions are highly appreciated! Please make sure if works for ASP.NET and ASP.NET Core if possible and make sure it is covered by unit tests. | ||
|
||
|
||
## License | ||
|
||
BSD |