Added sample for ASP.NET Core 6.0 on .NET 6 (#736)

* Added sample for ASP.NET Core 6.0 on .NET 6

* AppVeyor run on Visual Studio 2022 image to be able to target .NET 6

* Aligned log levels in appsettings.Development.json with ASP.NET Core 5 sample

* Clear providers and set minimum level from code

* Moved logging initialization code in ASP.NET Core 6 sample just before the call to UseNLog

* Use the layout from the wiki for the ASP.NET Core 6 sample

* VS2022

Co-authored-by: Julian Verdurmen <[email protected]>

NLog.Web.sln

@@ -1,6 +1,6 @@
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.29324.140
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.31903.59
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{52CA242D-DB20-41D9-8B79-A5A965ECA105}"
 	ProjectSection(SolutionItems) = preProject
@@ -28,6 +28,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ASP.NET Core 3 - VS2019", "
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ASP.NET Core 5 NLog Example", "examples\ASP.NET Core 5\ASP.NET Core 5 NLog Example\ASP.NET Core 5 NLog Example.csproj", "{6B629300-2FD1-4465-B077-24D01E2BB5E7}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ASP.NET Core 6 NLog Example", "examples\ASP.NET Core 6\ASP.NET Core 6 NLog Example\ASP.NET Core 6 NLog Example.csproj", "{C7F367FA-9DFC-4AA4-81AF-1B4933EAE516}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -64,6 +66,10 @@ Global
 		{6B629300-2FD1-4465-B077-24D01E2BB5E7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6B629300-2FD1-4465-B077-24D01E2BB5E7}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6B629300-2FD1-4465-B077-24D01E2BB5E7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C7F367FA-9DFC-4AA4-81AF-1B4933EAE516}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C7F367FA-9DFC-4AA4-81AF-1B4933EAE516}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C7F367FA-9DFC-4AA4-81AF-1B4933EAE516}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C7F367FA-9DFC-4AA4-81AF-1B4933EAE516}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -73,6 +79,7 @@ Global
 		{0BF1FB4E-D5AE-46DE-9E80-E2DD40235552} = {A9FB260C-9052-45D3-827A-20590F9D2FEF}
 		{A0DF49D3-74E1-4FD2-8197-017A824B9AED} = {A9FB260C-9052-45D3-827A-20590F9D2FEF}
 		{6B629300-2FD1-4465-B077-24D01E2BB5E7} = {A9FB260C-9052-45D3-827A-20590F9D2FEF}
+		{C7F367FA-9DFC-4AA4-81AF-1B4933EAE516} = {A9FB260C-9052-45D3-827A-20590F9D2FEF}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {B8468549-60D6-49AC-A6F7-44391E4C392C}

README.md

@@ -24,6 +24,7 @@ The packages contain targets and layout-renderes specific to ASP.NET (Core), MVC
 ## 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](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-3)
 - [Getting started for ASP.NET Core 2](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-2)
@@ -45,6 +46,7 @@ For updates and releases, check [CHANGELOG.MD](CHANGELOG.MD) or [Releases](https
 ## 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.0
 - For ASP.NET Core 2, .NET Standard 2.0+ and .NET 4.6+

appveyor.yml

@@ -1,7 +1,7 @@
 version: 5.0.0.{build}
 clone_folder: c:\projects\nlogweb
 configuration: Release
-image: Visual Studio 2019
+image: Visual Studio 2022
 platform: Any CPU
 
 nuget:

azure-pipelines.yml

@@ -1,6 +1,6 @@
 pool:
   name: Azure Pipelines
-  vmImage: 'windows-2019'
+  vmImage: 'windows-2022'
   demands:
   - msbuild
   - visualstudio

examples/ASP.NET Core 5/ASP.NET Core 5 NLog Example/Controllers/HomeController.cs

@@ -1,11 +1,7 @@
 using ASP.NetCore5_NLog_Web_Example.Models;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
-using System;
-using System.Collections.Generic;
 using System.Diagnostics;
-using System.Linq;
-using System.Threading.Tasks;
 
 namespace ASP.NetCore5_NLog_Web_Example.Controllers
 {

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/ASP.NET Core 6 NLog Example.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <RootNamespace>ASP.NetCore6_NLog_Web_Example</RootNamespace>
+    <AssemblyName>ASP.NetCore6_NLog_Web_Example</AssemblyName>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\src\NLog.Web.AspNetCore\NLog.Web.AspNetCore.csproj" />
+  </ItemGroup>
+
+</Project>

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Controllers/HomeController.cs

@@ -0,0 +1,34 @@
+using ASP.NetCore6_NLog_Web_Example.Models;
+using Microsoft.AspNetCore.Mvc;
+using System.Diagnostics;
+
+namespace ASP.NetCore6_NLog_Web_Example.Controllers
+{
+    public class HomeController : Controller
+    {
+        private readonly ILogger<HomeController> _logger;
+
+        public HomeController(ILogger<HomeController> logger)
+        {
+            _logger = logger;
+            _logger.LogDebug(1, "NLog injected into HomeController");
+        }
+
+        public IActionResult Index()
+        {
+            _logger.LogInformation("Hello, this is the index!");
+            return View();
+        }
+
+        public IActionResult Privacy()
+        {
+            return View();
+        }
+
+        [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
+        public IActionResult Error()
+        {
+            return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
+        }
+    }
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Models/ErrorViewModel.cs

@@ -0,0 +1,9 @@
+namespace ASP.NetCore6_NLog_Web_Example.Models
+{
+    public class ErrorViewModel
+    {
+        public string? RequestId { get; set; }
+
+        public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
+    }
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Program.cs

@@ -0,0 +1,51 @@
+using NLog;
+using NLog.Web;
+
+var logger = NLog.LogManager.Setup().LoadConfigurationFromAppSettings().GetCurrentClassLogger();
+
+try
+{
+    var builder = WebApplication.CreateBuilder(args);
+
+    // Add services to the container.
+    builder.Services.AddControllersWithViews();
+
+    // NLog: Setup NLog for Dependency injection
+    builder.Logging.ClearProviders();
+    builder.Logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);
+    builder.Host.UseNLog();
+
+    var app = builder.Build();
+
+    // Configure the HTTP request pipeline.
+    if (!app.Environment.IsDevelopment())
+    {
+        app.UseExceptionHandler("/Home/Error");
+        // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
+        app.UseHsts();
+    }
+
+    app.UseHttpsRedirection();
+    app.UseStaticFiles();
+
+    app.UseRouting();
+
+    app.UseAuthorization();
+
+    app.MapControllerRoute(
+        name: "default",
+        pattern: "{controller=Home}/{action=Index}/{id?}");
+
+    app.Run();
+}
+catch (Exception exception)
+{
+    // NLog: catch setup errors
+    logger.Error(exception, "Stopped program because of exception");
+    throw;
+}
+finally
+{
+    // Ensure to flush and stop internal timers/threads before application-exit (Avoid segmentation fault on Linux)
+    NLog.LogManager.Shutdown();
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Properties/launchSettings.json

@@ -0,0 +1,28 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:28115",
+      "sslPort": 44341
+    }
+  },
+  "profiles": {
+    "ASP.NetCore6_NLog_Web_Example": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "https://localhost:7125;http://localhost:5125",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/Home/Index.cshtml

@@ -0,0 +1,8 @@
+@{
+    ViewData["Title"] = "Home Page";
+}
+
+<div class="text-center">
+    <h1 class="display-4">Welcome</h1>
+    <p>Learn about <a href="https://docs.microsoft.com/aspnet/core">building Web apps with ASP.NET Core</a>.</p>
+</div>

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/Home/Privacy.cshtml

@@ -0,0 +1,6 @@
+@{
+    ViewData["Title"] = "Privacy Policy";
+}
+<h1>@ViewData["Title"]</h1>
+
+<p>Use this page to detail your site's privacy policy.</p>

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/Shared/Error.cshtml

@@ -0,0 +1,25 @@
+@model ErrorViewModel
+@{
+    ViewData["Title"] = "Error";
+}
+
+<h1 class="text-danger">Error.</h1>
+<h2 class="text-danger">An error occurred while processing your request.</h2>
+
+@if (Model?.ShowRequestId ?? false)
+{
+    <p>
+        <strong>Request ID:</strong> <code>@Model?.RequestId</code>
+    </p>
+}
+
+<h3>Development Mode</h3>
+<p>
+    Swapping to <strong>Development</strong> environment will display more detailed information about the error that occurred.
+</p>
+<p>
+    <strong>The Development environment shouldn't be enabled for deployed applications.</strong>
+    It can result in displaying sensitive information from exceptions to end users.
+    For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
+    and restarting the app.
+</p>

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/Shared/_Layout.cshtml

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>@ViewData["Title"] - ASP.NetCore6_NLog_Web_Example</title>
+    <link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
+    <link rel="stylesheet" href="~/css/site.css" asp-append-version="true" />
+    <link rel="stylesheet" href="~/ASP.NetCore6_NLog_Web_Example.styles.css" asp-append-version="true" />
+</head>
+<body>
+    <header>
+        <nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
+            <div class="container-fluid">
+                <a class="navbar-brand" asp-area="" asp-controller="Home" asp-action="Index">ASP.NetCore6_NLog_Web_Example</a>
+                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target=".navbar-collapse" aria-controls="navbarSupportedContent"
+                        aria-expanded="false" aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+                <div class="navbar-collapse collapse d-sm-inline-flex justify-content-between">
+                    <ul class="navbar-nav flex-grow-1">
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Index">Home</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+        </nav>
+    </header>
+    <div class="container">
+        <main role="main" class="pb-3">
+            @RenderBody()
+        </main>
+    </div>
+
+    <footer class="border-top footer text-muted">
+        <div class="container">
+            &copy; 2021 - ASP.NetCore6_NLog_Web_Example - <a asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
+        </div>
+    </footer>
+    <script src="~/lib/jquery/dist/jquery.min.js"></script>
+    <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
+    <script src="~/js/site.js" asp-append-version="true"></script>
+    @await RenderSectionAsync("Scripts", required: false)
+</body>
+</html>

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/Shared/_Layout.cshtml.css

@@ -0,0 +1,48 @@
+/* Please see documentation at https://docs.microsoft.com/aspnet/core/client-side/bundling-and-minification
+for details on configuring this project to bundle and minify static web assets. */
+
+a.navbar-brand {
+  white-space: normal;
+  text-align: center;
+  word-break: break-all;
+}
+
+a {
+  color: #0077cc;
+}
+
+.btn-primary {
+  color: #fff;
+  background-color: #1b6ec2;
+  border-color: #1861ac;
+}
+
+.nav-pills .nav-link.active, .nav-pills .show > .nav-link {
+  color: #fff;
+  background-color: #1b6ec2;
+  border-color: #1861ac;
+}
+
+.border-top {
+  border-top: 1px solid #e5e5e5;
+}
+.border-bottom {
+  border-bottom: 1px solid #e5e5e5;
+}
+
+.box-shadow {
+  box-shadow: 0 .25rem .75rem rgba(0, 0, 0, .05);
+}
+
+button.accept-policy {
+  font-size: 1rem;
+  line-height: inherit;
+}
+
+.footer {
+  position: absolute;
+  bottom: 0;
+  width: 100%;
+  white-space: nowrap;
+  line-height: 60px;
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/Shared/_ValidationScriptsPartial.cshtml

@@ -0,0 +1,2 @@
+<script src="~/lib/jquery-validation/dist/jquery.validate.min.js"></script>
+<script src="~/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js"></script>

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/_ViewImports.cshtml

@@ -0,0 +1,3 @@
+@using ASP.NetCore6_NLog_Web_Example
+@using ASP.NetCore6_NLog_Web_Example.Models
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/Views/_ViewStart.cshtml

@@ -0,0 +1,3 @@
+@{
+    Layout = "_Layout";
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/appsettings.Development.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Trace",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  }
+}

examples/ASP.NET Core 6/ASP.NET Core 6 NLog Example/appsettings.json

@@ -0,0 +1,10 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Trace",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  },
+  "AllowedHosts": "*"
+}