NLog | Effective

.net6の情報が出ていたので、nlogのサンプルを書き直しました。
xUnitと併せてのサンプルです

.NET 6.0 C# Razor
NLog4.7.15
NLog.Web.AspNetCore4.14.0
xunit2.4.1

公式がgithubに記載している以外では
https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-6

[5. Write logs]でControllerから取得しているのですが、
ここでは、Razorを使いたいので、PageModelをつかってます

        private readonly ILogger<IndexModel> _logger;
        public IndexModel(ILogger<IndexModel> logger)
        {
            _logger = logger;
        }

private readonly ILogger<IndexModel> _logger;

public IndexModel(ILogger<IndexModel> logger)

{

_logger = logger;

}

共通で使用するクラスとかでログ出力するとき

中規模以上のシステムになると、共通でつかうクラスが出てきますが、
ログを出力したいとなると、Modelで取得したLoggerを引っ張りまわすか、その場で生成するという手法が考えられます

Loggerを引っ張りまわすときに呼び出し元のModel名だと都合が悪いので、一回PageModelに型変換すると予備先で楽になります

    public class ThirdModel : PageModel
    {
        // PageModelで定義
        private readonly ILogger<PageModel> _logger;

        // ILoggerにはThirdModelを指定
        public ThirdModel(ILogger<ThirdModel> logger)
        {
            // ThirdModelからPageModelに変換
            _logger = (ILogger<PageModel>)logger;
        }
        public void OnGet()
        {
            var m = new Logic.Sample3Class(_logger);
            m.SafeCase();

            _logger.LogInformation(1, "PageModelでのログ書き出し");
        }
    }

public class ThirdModel : PageModel

{

// PageModelで定義

private readonly ILogger<PageModel> _logger;

// ILoggerにはThirdModelを指定

public ThirdModel(ILogger<ThirdModel> logger)

{

// ThirdModelからPageModelに変換

_logger = (ILogger<PageModel>)logger;

}

public void OnGet()

{

var m = new Logic.Sample3Class(_logger);

m.SafeCase();

_logger.LogInformation(1, "PageModelでのログ書き出し");

}

    public class Sample3Class
    {
        private readonly ILogger<PageModel> _logger;

        public Sample3Class(ILogger<PageModel> logger)
        {
            _logger = logger;
        }

        public Boolean SafeCase()
        {
            _logger.LogInformation("PageModelをつかってログ出力");
            
            return true;
        }
    }

public class Sample3Class

{

private readonly ILogger<PageModel> _logger;

public Sample3Class(ILogger<PageModel> logger)

{

_logger = logger;

}

public Boolean SafeCase()

{

_logger.LogInformation("PageModelをつかってログ出力");

return true;

}

xUnitで単体テストするときに

xUnitから呼び出す時に、下記の問題がありまして
Razor Pageで、nlogを使うと、コンテキストからloggerをもらうので、
xUnitでログを出力するところがテストできてないです。
ものすごく頑張ればモデルを作れるハズみたいです（下の方のソースにindexModelをつくってる）
https://docs.microsoft.com/en-us/aspnet/core/test/razor-pages-tests?view=aspnetcore-3.1

解決策としては、
ログはエラーハンドリング系にだけに入れておき、xUnitで生成時にILoggerなどにはnullを設定して
どうしてもログ出力を通過する個所については、コンパイル時にシンボル指定して回避する

        [Fact]
        public void UhyoTest1()
        {
            ILogger<SecondModel> _logger = null;
            var a = new SecondModel(_logger);
            a.OnGet();
            Assert.True(a.Uhyo == "hoge");
        }

[Fact]

public void UhyoTest1()

{

ILogger<SecondModel> _logger = null;

var a = new SecondModel(_logger);

a.OnGet();

Assert.True(a.Uhyo == "hoge");

}

        public void OnGet()
        {
            Uhyo = "hoge";

#if !UNITTEST
            _logger.LogDebug(1, "OnGet");
#endif

        }

public void OnGet()

{

Uhyo = "hoge";

#if !UNITTEST

_logger.LogDebug(1, "OnGet");

#endif

}

共通処理等でまとめPageModelから遠いクラスでのエラーハンドリングとかでは、
個別にlogerを生成したほうがコーディング量は減るかもしれないです
ログファイルへの出力の場合はファイルへの書き込み待ちが発生するので推奨できないですが、
ログ専用にsyslogサーバーなどを別途立ててxml,jsonもしくはキュー、クエリでログを投げる場合は良いと思います

    public class SampleClass
    {
        private readonly Logger _logger;

        public SampleClass()
        {
            // loggerの生成
            // ログファイルに出力する場合は非推奨：
            _logger = NLog.LogManager.Setup().LoadConfigurationFromAppSettings().GetCurrentClassLogger();
        }

        public void LogOut()
        {
            _logger.Info("インフォメーションレベル");
            _logger.Warn("ワーニングレベル");
            _logger.Error("エラーレベル");
        }
    }

public class SampleClass

{

private readonly Logger _logger;

public SampleClass()

{

// loggerの生成

// ログファイルに出力する場合は非推奨：

_logger = NLog.LogManager.Setup().LoadConfigurationFromAppSettings().GetCurrentClassLogger();

}

public void LogOut()

{

_logger.Info("インフォメーションレベル");

_logger.Warn("ワーニングレベル");

_logger.Error("エラーレベル");

}

今回作成したプロジェクト

https://www.6sense.co.jp/dl/nlog_test_net60_v2.zip

.net6になってから、start.csが廃止されて、program.csも中身が変わったこともあって、
サイトを調べても情報がないので、2時間ほど、挑戦して出るようになったので、ここにメモっておく

環境
visual studio2022
razor
.net6
Nlog 4.7.13
Nlog.Web.AspNetCore 4.14.0

1.NuGetでNLogをインストール
visual studio2022のツールからNlogとNlog.Web.AspNetCoreの最新をインストールする

2.nlog.configを用意する

とりあえず、転がってたのをそのまま使います。

参考はこれ

https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-2

3.Program.csを変更する

.net6でプロジェクトを新規作成すると、デフォルトでbuilderが定義されているので、追加で、builderに設定を加えます。

var app = builder.Build();よりも前に記載しないと実行時エラーになります

cs0618で警告が出ますが、新しい書き方だと、.net6じゃない気がします


using NLog;
using NLog.Web;
using Microsoft.Extensions.Logging;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Logging.ClearProviders();
builder.Logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);

// cs0618 ;_;
builder.Logging.ConfigureNLog("nlog.config");

var logger = NLog.LogManager.Setup().RegisterNLogWeb().GetCurrentClassLogger();
var app = builder.Build();

...

using NLog;

using NLog.Web;

using Microsoft.Extensions.Logging;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddRazorPages();

builder.Logging.ClearProviders();

builder.Logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);

// cs0618 ;_;

builder.Logging.ConfigureNLog("nlog.config");

var logger = NLog.LogManager.Setup().RegisterNLogWeb().GetCurrentClassLogger();

var app = builder.Build();

...

4.appsettings.jsonを少し変更する

これもとりあえず、転がってたのをそのまま使います。

参考は上記記載と同じgithub

https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-2

5.Index.cshtml.csに出力するコードを試しに記載する

namespace nlog_test.Pages
{
    public class IndexModel : PageModel
    {
        private readonly ILogger&amp;lt;IndexModel&amp;gt; _logger;

        public IndexModel(ILogger&amp;lt;IndexModel&amp;gt; logger)
        {
            _logger = logger;
        }

        public void OnGet()
        {
            _logger.LogInformation("Enter HomeController.Index Method");
            _logger.LogError("Its test error log!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
        }
    }
}

namespace nlog_test.Pages

{

public class IndexModel : PageModel

{

private readonly ILogger&lt;IndexModel&gt; _logger;

public IndexModel(ILogger&lt;IndexModel&gt; logger)

{

_logger = logger;

}

public void OnGet()

{

_logger.LogInformation("Enter HomeController.Index Method");

_logger.LogError("Its test error log!!!!!!!!!!!!!!!!!!!!!!!!!!!!");

}

6.実際に動かして、出力されるのかを確認

info-2022-02-03.logの中身

2022-02-03 14:42:12.4892||INFO|nlog_test.Pages.IndexModel|Enter HomeController.Index Method |url: 
2022-02-03 14:42:12.5432||ERROR|nlog_test.Pages.IndexModel|Its test error log!!!!!!!!!!!!!!!!!!!!!!!!!!!! |url:

2022-02-03 14:42:12.4892||INFO|nlog_test.Pages.IndexModel|Enter HomeController.Index Method |url:

2022-02-03 14:42:12.5432||ERROR|nlog_test.Pages.IndexModel|Its test error log!!!!!!!!!!!!!!!!!!!!!!!!!!!! |url:

infoレベルの中に、infoとerrorの両方出るのですね。errorしか使わないと思いますが。

azure上で動かしたときに、どうなるのかも見てみたいです

今回作成したプロジェクト一式

https://www.6sense.co.jp/dl/nlog_test.zip

2022/4/1追記　追加修正情報があったので、別途公開

RazorページでのNLogとxunitの使用

日	月	火	水	木	金	土
	1	2	3	4	5	6
7	8	9	10	11	12	13
14	15	16	17	18	19	20
21	22	23	24	25	26	27
28	29	30	31

Effective

photo and computer

「NLog」タグアーカイブ

RazorページでのNLogとxunitの使用

c# Razor .net6にて、NLogでのログ出力

1.NuGetでNLogをインストール
visual studio2022のツールからNlogとNlog.Web.AspNetCoreの最新をインストールする

2.nlog.configを用意する

3.Program.csを変更する

4.appsettings.jsonを少し変更する

5.Index.cshtml.csに出力するコードを試しに記載する

6.実際に動かして、出力されるのかを確認

今回作成したプロジェクト一式

1.NuGetでNLogをインストールvisual studio2022のツールからNlogとNlog.Web.AspNetCoreの最新をインストールする

2.nlog.configを用意する

3.Program.csを変更する

4.appsettings.jsonを少し変更する

5.Index.cshtml.csに出力するコードを試しに記載する

6.実際に動かして、出力されるのかを確認

今回作成したプロジェクト一式

1.NuGetでNLogをインストール
visual studio2022のツールからNlogとNlog.Web.AspNetCoreの最新をインストールする