1. 程式人生 > >ASP.NET Core使用Elasticsearch記錄NLog日誌

ASP.NET Core使用Elasticsearch記錄NLog日誌

ASP.NET Core使用Elasticsearch記錄NLog日誌

1、新建一個 ASP.NET Core專案

 

2、安裝Nuge包

執行:Install-Package NLog.Web.AspNetCore

執行:Install-Package NLog

執行:Install-package NLog.Targets.ElasticSearch

 

3、編寫NLog配置檔案(NLog.config)

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd
" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" internalLogToConsole="true"> <extensions> <add assembly="NLog.Targets.ElasticSearch"/> </extensions><targets> <target name="ElasticSearch" xsi:type="ElasticSearch" ConnectionStringName
="http://localhost:9200" index="Jon.NLog-${date:format=yyyy.MM.dd}" documentType="doc" includeAllProperties="true" layout="[${date:format=yyyy-MM-dd HH\:mm\:ss}][${level}] ${logger} ${message} ${exception:format=toString}"> <field name="MachineName
" layout="${machinename}" /> <field name="Time" layout="${longdate}" /> <field name="level" layout="${level:uppercase=true}" /> <field name="logger" layout=" ${logger}" /> <field name="message" layout=" ${message}" /> <field name="exception" layout=" ${exception:format=toString}" /> <field name="processid" layout=" ${processid}" /> <field name="threadname" layout=" ${threadname}" /> <field name="stacktrace" layout=" ${stacktrace}" /> <field name="Properties" layout=" ${machinename} ${longdate} ${level:uppercase=true} ${logger} ${message} ${exception}|${processid}|${stacktrace}|${threadname}" /> </target> </targets> <rules> <logger name="*" minlevel="INFO" writeTo="ElasticSearch" /> </rules> </nlog>

 

主要配置說明:

ConnectionStringName:連線字串

Index:ES索引

documentType:ES型別

layout:佈局

layout可配置變數如下:

$ {activityid} - 將一個System.Diagnostics跟蹤關聯ID放入日誌中。
$ {all-event-properties} - 記錄所有事件上下文資料。
$ {appdomain} - 當前的應用程式域。
$ {assembly-version} - 預設應用程式域中可執行檔案的版本。
$ {basedir} - 當前應用程式域的基本目錄。
$ {callsite} - 呼叫站點(類名稱,方法名稱和源資訊)。
$ {callsite-linenumber} - 呼叫站點源行號。
$ {counter} - 一個計數器值(每個佈局渲染都會增加)。
$ {currentdir} - 應用程式的當前工作目錄。
$ {date} - 當前日期和時間。
$ {document-uri} - 託管當前Silverlight應用程式的HTML頁面的URI。
$ {environment} - 環境變數。
$ {event-properties} - 記錄事件屬性資料 - 重新命名$ {event-context}。
$ {exception} - 通過呼叫其中一個Logger * Exception()方法提供的異常資訊。
$ {file-contents} - 渲染指定檔案的內容。
$ {gc} - 關於垃圾收集器的資訊。
$ {gdc} - 全域性診斷上下文專案。字典結構來儲存每個應用程式例項值。
$ {guid} - 全域性唯一識別符號(GUID)。
$ {identity} - 執行緒標識資訊(名稱和認證資訊)。
$ {install-context} - 安裝引數(傳遞給InstallNLogConfig)。
$ {level} - 日誌級別。
$ {literal} - 一個字串文字。
$ {log4jxmlevent} - 與log4j,Chainsaw和NLogViewer相容的XML事件描述。
$ {logger} - 記錄器名稱。
$ {longdate} - 日期和時間格式很長,可排序yyyy-MM-dd HH:mm:ss.ffff。
$ {machinename} - 程序正在執行的機器名稱。
$ {mdc} - 對映的診斷上下文 - 一個執行緒區域性結構。
$ {mdlc} - 非同步對映的診斷上下文 - 一個執行緒區域性結構。
$ {message} - 格式化的日誌訊息。
$ {ndc} - 巢狀的診斷上下文 - 一個執行緒區域性結構。
$ {ndlc} - 非同步巢狀診斷上下文 - 一個執行緒區域性結構。
$ {newline} - 換行符。
$ {nlogdir} - NLog.dll所在的目錄。
$ {performancecounter} - 效能計數器。
$ {processid} - 當前程序的識別符號。
$ {processinfo} - 關於正在執行的程序的資訊。
$ {processname} - 當前程序的名稱。
$ {processtime} - 格式為HH:mm:ss.mmm的處理時間。
$ {qpc} - 高精度計時器,基於從QueryPerformanceCounter()返回的值(可選地轉換為秒)。
$ {registry} - 來自注冊表的值。
$ {sequenceid} - 日誌序列標識
$ {shortdate} - 可排序格式的短日期yyyy-MM-dd。
$ {sl-appinfo} - 有關Silverlight應用程式的資訊。
$ {specialfolder} - 系統特殊資料夾路徑(包括我的文件,我的音樂,程式檔案,桌面等)。
$ {stacktrace} - 堆疊跟蹤渲染器。
$ {tempdir} - 一個臨時目錄。
$ {threadid} - 當前執行緒的識別符號。
$ {threadname} - 當前執行緒的名稱。
$ {ticks} - 當前日期和時間的Ticks值。
$ {time} - 以24小時可排序格式HH:mm:ss.mmm的時間。
$ {var} - 渲染變數(4.1中新增)
$ {windows-identity} - 執行緒Windows身份資訊(使用者名稱)。
包裝
$ {cached} - 將快取應用於另一個佈局輸出。
$ {filesystem-normalize} - 通過用安全字元替換檔名中不允許的字元。
$ {json-encode} - 使用JSON規則轉義另一個佈局的輸出。
$ {lowercase} - 將另一個佈局輸出的結果轉換為小寫。
$ {onexception} - 僅在為日誌訊息定義異常時才輸出內部佈局。
$ {pad} - 將填充應用於另一個佈局輸出。
$ {replace} - 用另一個字串替換另一個佈局輸出中的字串。
$ {replace-newlines} - 用另一個字串替換換行符。
$ {rot13} - 用ROT-13解碼“encrypted”文字。
$ {trim-whitespace} - 修剪另一個佈局渲染器的結果中的空白。
$ {uppercase} - 將另一個佈局輸出的結果轉換為大寫。
$ {url-encode} - 編碼另一個佈局輸出的結果以用於URL。
$ {when} - 只有在滿足指定條件時才輸出內部佈局。
$ {whenEmpty} - 當內部佈局產生空結果時輸出替代佈局。
$ {WrapLine} - 在指定的行長度處包裝另一個佈局輸出的結果。
$ {xml-encode} - 將另一個佈局輸出的結果轉換為XML相容。
NLog.Extended軟體包 
$ {appsetting} - 應用程式配置設定。
NLog.Web包 
$ {aspnet-MVC-Action} - ASP.NET MVC動作名稱
$ {aspnet-MVC-Controller} - ASP.NET MVC控制器名稱
$ {aspnet-Application} - ASP.NET應用程式變數。
$ {aspnet-Item} - ASP.NET HttpContext專案變數。
$ {aspnet-TraceIdentifier} - ASP.NET跟蹤識別符號
$ {aspnet-Request} - ASP.NET請求變數。
$ {aspnet-Request-Cookie} - ASP.NET請求cookie內容。
$ {aspnet-Request-Host} - ASP.NET請求主機。
$ {aspnet-Request-Method} - ASP.NET請求方法(GET,POST等)。
$ {aspnet-Request-IP} - 客戶端IP。
$ {aspnet-Request-QueryString} - ASP.NET請求查詢字串。
$ {aspnet-Request-Referrer} - ASP.NET請求引用者。
$ {aspnet-Request-UserAgent} - ASP.NET請求useragent。
$ {aspnet-Request-Url} - ASP.NET請求URL。
$ {aspnet-Session} - ASP.NET Session變數。
$ {aspnet-SessionId} - ASP.NET會話ID變數。
$ {aspnet-User-isAuthenticated} - ASP.NET使用者身份驗證?
$ {aspnet-User-AuthType} - ASP.NET使用者身份驗證。
$ {aspnet-User-Identity} - ASP.NET使用者變數。
$ {iis-site-name} - IIS站點名稱。

 

4、Program、Startup配置

4.1、Program配置NLog

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }
​
    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
        .UseNLog()
            .UseStartup<Startup>();
}

 

4.2、Startup新增NLog中介軟體

  
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
        }
​
        app.UseStaticFiles();
        app.UseCookiePolicy();
​
        loggerFactory.AddNLog();
        env.ConfigureNLog("NLog.config");
​
        app.UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
                template: "{controller=Home}/{action=Index}/{id?}");
        });
    }

 

5、正常執行如下

 

檢視kibana