mrkt 的程式學習筆記: ASP.NET Core 使用 NLog 將 Log 寫到 Elasticsearch

2018年7月8日星期日

ASP.NET Core 使用 NLog 將 Log 寫到 Elasticsearch

前一篇「Docker-Compose 建立 Elasticsearch 與 Kibana 服務」說明了使用 Docker-Compose 建立了 Elasticsearch 和 Kibana 以及相關的服務，這一篇接續說明在 ASP.NET Core 網站裡使用 NLog 將 Log 寫到 Elasticsearch。

建立專案

在 Visual Studio 2017 裡建立 ASP.NET Core MVC 網站服務（這邊是使用 .NET Core 2.1.1）

.NET Downloads for Windows – Download .NET Core 2.1 SDK

安裝 NuGet Packages

在專案裡安裝以下幾個 NuGet Packages

NLog.Web.AspNetCore
NLog.Extensions.Logging
NLog.Targets.ElasticSearch
Elasticsearch.Net

新增 NLog.config

這邊的設定會將系統執行時的 Log 寫到文字檔與 Elasticsearch 中，Log 寫到 Elasticsearch 是透過 NLog.targets.ElasticSearch 這個套件

<?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"
      autoReload="true"
      internalLogLevel="Warn"
      internalLogFile="internal-nlog.txt">

  <extensions>
    <add assembly="NLog.Web.AspNetCore"/>
    <add assembly="NLog.Targets.ElasticSearch"/>
  </extensions>

  <targets async="true">
    <!-- local log file -->
    <target xsi:type="File" name="File"
            fileName="${basedir}/logs/${date:format=yyyy-MM-dd}.log"
            archiveAboveSize="20000000"
            archiveNumbering="Rolling"
            encoding="UTF-8"
            enableFileDelete="true"
            maxArchiveFiles="5"
            layout="[${date:format=yyyy-MM-dd HH\:mm\:ss}][${level}] ${logger} ${message} ${exception:format=toString}" />

    <!-- ElasticSearch -->
    <target name="ElasticSearch"
            xsi:type="ElasticSearch"
            ConnectionStringName="ElasticSearchServerAddress"
            index="dotnetcore-nlog-elk-${date:format=yyyy.MM.dd}"
            documentType="logevent"
            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="Trace" writeTo="File" />
    <logger name="*" minlevel="Trace" writeTo="ElasticSearch" />
  </rules>
</nlog>

記得要修改 NLog.config 檔案屬性，將「複製到輸出目錄」修改為「永遠複製」

修改 appsettings.Development.json

在 NLog.config 的 ElasticSearch target 並不是將 elasticsearch 服務的位置寫在裡面，而是提供一個連接字串名稱，實際的 elasticsearch 服務位置則是寫在 appsettings 裡。這麼一來就可以依據執行環境切轉使用不同的環境的 elasticsearch 服務。