NLog使用和日志上传指定服务器

背景

• 之前使用的log4net进行日志的记录，但是找过相关资料之后发现log4net不支持根据指定的配置将不同类的日志写入到不同的文件中
• 为了后续的运维需要需要将日志上传至上层平台的接口，方便后续的日志查看

解决问题

• 将日志进行分类存放，防止日志都在同一个文件中，难以针对性的进行日志查看
• NLog无法按照指定方式进行异常信息的堆栈记录
• 将日志上传至指定服务器
• 开启内部调试的方法

解决步骤

基础配置

• 通过参考链接中的1进行默认配置的获取
  • 获取之后发现无法记录异常的堆栈信息
• 通过参考链接中的2修改配置文件中的target中的layout为 ${exception:format=ToString}解决此问题
• 此时配置文件如下（此时已经能够根据不同的命名空间进行日志的记录、能够进行异常堆栈信息记录）

<?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"
	 >

  <targets>
    <!--此部分中的所有目标将自动异步-->
    <target name="asyncFile" xsi:type="AsyncWrapper">
      <!--项目日志保存文件路径说明fileName="${basedir}/保存目录，以年月日的格式创建/${shortdate}/${记录器名称}-${单级记录}-${shortdate}.txt"-->
      <!--${exception:format=ToString} 保证能够记录堆栈信息-->
      <target name="log_file" xsi:type="File"
              fileName="${basedir}/ProjectLogs/${shortdate}/${logger}-${level}.txt"
              layout="${longdate} | ${message} ${exception:format=ToString} ${newline}"
              archiveFileName="${basedir}/archives/${logger}-${level}-${shortdate}-{#####}.txt"
              archiveAboveSize="102400"
              archiveNumbering="Sequence"
              concurrentWrites="true"
              keepFileOpen="false" />
    </target>
    <!--使用可自定义的着色将日志消息写入控制台-->
    <target name="colorConsole" xsi:type="ColoredConsole" layout="[${date:format=HH\:mm\:ss}]:${message} ${exception:format=message}" />
    />  

  </targets>

  <!--规则配置,final - 最终规则匹配后不处理任何规则-->
  <rules>
    <logger name="Microsoft.*" minlevel="Info" writeTo="" final="true" />
    <logger name="*" minlevel="Info" writeTo="asyncFile" />
    <logger name="*" minlevel="Warn" writeTo="colorConsole" />
  </rules>
</nlog>

开启NLog自带的内部日志

• 在nlog节点上，增加以下代码

internalLogLevel="Debug"
  internalLogFile="C:temp\nlog-internal.txt"
  internalLogToConsole="true"
  throwConfigExceptions="true"

• throwConfigExceptions 在部署到正式环境的时候一定要删掉，或者设置为false。
  • 否则会因为nlog的配置问题导致程序直接退出

错误信息上传到指定服务器

• 在targets下面增加

 <target name="network" xsi:type="Network" address="tcp://localhost:8080" ayout="${longdate} | ${message} ${exception:format=ToString} ${newline}"/>  

• 在rules下增加

 <logger name="*" minlevel="Error" writeTo="network" />

完整配置

<?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"
	internalLogLevel="Debug"
      internalLogFile="c:\temp\nlog-internal.txt"
      internalLogToConsole="true"
      throwConfigExceptions="true">

  <targets>
    <!--此部分中的所有目标将自动异步-->
    <target name="asyncFile" xsi:type="AsyncWrapper">
      <!--项目日志保存文件路径说明fileName="${basedir}/保存目录，以年月日的格式创建/${shortdate}/${记录器名称}-${单级记录}-${shortdate}.txt"-->
      <target name="log_file" xsi:type="File"
              fileName="${basedir}/ProjectLogs/${shortdate}/${logger}-${level}.txt"
              layout="${longdate} | ${message} ${exception:format=ToString} ${newline}"
              archiveFileName="${basedir}/archives/${logger}-${level}-${shortdate}-{#####}.txt"
              archiveAboveSize="102400"
              archiveNumbering="Sequence"
              concurrentWrites="true"
              keepFileOpen="false" />
    </target>
    <!--使用可自定义的着色将日志消息写入控制台-->
    <target name="colorConsole" xsi:type="ColoredConsole" layout="[${date:format=HH\:mm\:ss}]:${message} ${exception:format=message}" />
    <!--日志上传指定接口-->
    <target name="network" xsi:type="Network" address="tcp://localhost:8080" ayout="${longdate} | ${message} ${exception:format=ToString} ${newline}"/>  

  </targets>

  <!--规则配置,final - 最终规则匹配后不处理任何规则-->
  <rules>
    <logger name="Microsoft.*" minlevel="Info" writeTo="" final="true" />
    <logger name="*" minlevel="Info" writeTo="asyncFile" />
    <logger name="*" minlevel="Warn" writeTo="colorConsole" />
    <logger name="*" minlevel="Error" writeTo="network" />
  </rules>
</nlog>

参考链接

1、默认配置来源
2、异常堆栈解决
3、NLog 官方文档
4、更多配置参考官方文档，如自动重载配置文件配置不需要重新启动程序