Net Core 使用NLog記錄日誌到文件和資料庫

2019-11-17   日行四善

NLog 記錄日誌是微軟官方推薦使用。

接下來,通過配置日誌記錄到文件和Sql Server資料庫。

第一步:首先添加包NLog.Config (可通過微軟添加包命令Install-Package 包名進行添加,也可以通過管理NuGet程序包進行添加),添加成功後會生成NLog.config配置文件。並對該配置文件進行配置。詳細配置可參考Git上 NLog說明。

一下是我個人配置。

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"

autoReload="true"

throwExceptions="false"

internalLogLevel="Warn"

internalLogFile="Logs/nlog-internal.log">

layout="${longdate}|${event-properties:item=EventId.Id}|${uppercase:${level}}|${logger} ${newline}${message} ${exception} ${newline}" />

layout="${longdate}|${event-properties:item=EventId.Id}|${uppercase:${level}}|${logger} ${newline}${message} ${exception} ${newline} --- |url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />

${var:connectionString}

insert into syslogs (Application,Levels,Operatingtime,Operatingaddress,Userid,Logger,Callsite,Requesturl,Referrerurl,Action,Message,Exception)

values (@application,@levels,@operatingtime,@operatingaddress,@userid,@logger,@callSite,@requesturl,@referrerurl,@action,@message,@exception);

NLog.config

說明:targets 中有一節點為Database,是配置將日誌寫入資料庫中,注意需要在資料庫中添加該記錄日誌表。

{

"ConnectionStrings": {

"DefaultConnection": "Data Source=192.168.30.133;Initial Catalog=Test;User ID=sa;Password=123456;Trusted_Connection=True;MultipleActiveResultSets=true;Integrated Security=false;"

},

"Logging": {

"LogLevel": {

"Default": "Warning"

}

},

"AllowedHosts": "*"

}

appsettings.json

第二步:添加包NLog.Web.AspNetCore,在Program.cs中的WebHost加入".UseNLog()"(該屬於程序集NLog.Web,需要添加引用using NLog.Web;),即為添加nlog.

using Microsoft.AspNetCore;

using Microsoft.AspNetCore.Hosting;

using NLog.Web;

namespace WebApi

{

public class Program

{

public static void Main(string[] args)

{

CreateWebHostBuilder(args).Build().Run();

}

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>

WebHost.CreateDefaultBuilder(args)

.UseStartup()

.UseNLog(); //加入nlog日誌

}

}

Program.cs

第三步:在Startup.cs中的Configure方法中添加記日誌代碼,即需要加載的配置文件和配置日誌寫入資料庫連接字符串代碼。注意:為避免中文亂碼問題需要添加System.Text.Encoding.CodePages包。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)

{

#region Nlog記日誌

//將日誌記錄到資料庫 config/NLog.config

NLog.LogManager.LoadConfiguration("nlog.config").GetCurrentClassLogger(); NLog.LogManager.Configuration.Variables["connectionString"] = Configuration.GetConnectionString("DefaultConnection"); Encoding.RegisterProvider(CodePagesEncodingProvider.Instance); //避免日誌中的中文輸出亂碼

#endregion

if (env.IsDevelopment())

app.UseDeveloperExceptionPage();

else

app.UseHsts();

app.UseHttpsRedirection();

app.UseMvc();

}

Configure方法

第四步:使用微軟推薦的方式在在構造方法中將將日誌對象注入。

public class UsersController : Controller

{

///

/// 日誌對象

///

private readonly ILogger logger;

public UsersController(ILoggerFactory loggerFactory)

{

this.logger = loggerFactory.CreateLogger();

#region 測試日誌

logger.LogTrace("開發階段調試,可能包含敏感程序數據", 1);

logger.LogDebug("開發階段短期內比較有用,對調試有益。");

logger.LogInformation("你訪問了首頁。跟蹤程序的一般流程。");

logger.LogWarning("警告信息!因程序出現故障或其他不會導致程序停止的流程異常或意外事件。");

logger.LogError("錯誤信息。因某些故障停止工作");

logger.LogCritical("程序或系統崩潰、遇到災難性故障!!!");

#endregion

}

構造方法中注入

所有工作完成,運行程序。在配置NLog路徑下生成日誌文件,同時,在資料庫中生成日誌。