Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace NLog methods that are now obsoletes #13824

Merged
merged 3 commits into from
Jun 8, 2023
Merged

Replace NLog methods that are now obsoletes #13824

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8f2564
Replace NLog obsolete methods
jtkech Jun 6, 2023
0cf8f43
React to review
jtkech Jun 7, 2023
af17295
Little refactoring
jtkech Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/OrchardCore/OrchardCore.Logging.NLog/HostBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
using System.IO;
using Microsoft.Extensions.Hosting;
using NLog;
using NLog.LayoutRenderers;
using NLog.Web;

namespace OrchardCore.Logging;
Expand All @@ -10,7 +9,9 @@ public static class HostBuilderExtensions
{
public static IHostBuilder UseNLogHost(this IHostBuilder builder)
{
LayoutRenderer.Register<TenantLayoutRenderer>(TenantLayoutRenderer.LayoutRendererName);
LogManager.Setup().SetupExtensions(builder =>
builder.RegisterLayoutRenderer<TenantLayoutRenderer>(TenantLayoutRenderer.LayoutRendererName));

builder.UseNLog();
builder.ConfigureAppConfiguration((context, _) =>
Copy link

@snakefoot snakefoot Jun 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notice that builder.UseNLog() with NLog.Web.AspNetCore v5, will automatically load nlog.config from the env.ContentRootPath.

So ConfigureAppConfiguration could be changed to just:

builder.ConfigureAppConfiguration((context, _) =>
{
   var environment = context.HostingEnvironment;
   LogManager.Configuration.Variables["configDir"] = environment.ContentRootPath;
}

{
Expand Down
11 changes: 7 additions & 4 deletions src/OrchardCore/OrchardCore.Logging.NLog/WebHostBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using Microsoft.Extensions.Hosting;
using NLog;
using NLog.Config;
using NLog.LayoutRenderers;
using NLog.Web;

namespace OrchardCore.Logging
Expand All @@ -13,7 +12,9 @@ public static class WebHostBuilderExtensions
{
public static IWebHostBuilder UseNLogWeb(this IWebHostBuilder builder)
{
LayoutRenderer.Register<TenantLayoutRenderer>(TenantLayoutRenderer.LayoutRendererName);
LogManager.Setup().SetupExtensions(builder =>
builder.RegisterLayoutRenderer<TenantLayoutRenderer>(TenantLayoutRenderer.LayoutRendererName));

builder.UseNLog();
builder.ConfigureAppConfiguration((context, _) =>
Copy link

@snakefoot snakefoot Jun 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notice that builder.UseNLog() with NLog.Web.AspNetCore v5, will automatically load nlog.config from the env.ContentRootPath.

So ConfigureAppConfiguration could be changed to just:

builder.ConfigureAppConfiguration((context, _) =>
{
   var environment = context.HostingEnvironment;
   LogManager.Configuration.Variables["configDir"] = environment.ContentRootPath;
}

{
Expand All @@ -30,10 +31,12 @@ internal static class AspNetExtensions
{
public static LoggingConfiguration ConfigureNLog(this IHostEnvironment env, string configFileRelativePath)
{
ConfigurationItemFactory.Default.RegisterItemsFromAssembly(typeof(AspNetExtensions).GetTypeInfo().Assembly);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of depending on assembly-scanning, then it could nice if just doing registration of the single custom LayoutRenderer:

var fileName = Path.Combine(env.ContentRootPath, configFileRelativePath);
LogManager.Setup().SetupLogFactory(factory => factory.AddCallSiteHiddenAssembly(typeof(AspNetExtensions).GetTypeInfo().Assembly))
          .SetupExtensions(ext => {
                ext.RegisterLayoutRenderer<TenantLayoutRenderer>(TenantLayoutRenderer.LayoutRendererName);
                ext.RegisterNLogWeb();
          })
          .LoadConfigurationFromFile(fileName);
return LogManager.Configuration;

LogManager.Setup().SetupExtensions(builder =>
builder.RegisterAssembly(typeof(AspNetExtensions).GetType().Assembly));

LogManager.AddHiddenAssembly(typeof(AspNetExtensions).GetTypeInfo().Assembly);
var fileName = Path.Combine(env.ContentRootPath, configFileRelativePath);
LogManager.LoadConfiguration(fileName);
LogManager.Setup().LoadConfigurationFromFile(fileName);
return LogManager.Configuration;
}
}
Expand Down