打造适合你的ABP（1）---- 完善日志系统

 

最近使用Abp开发了一个项目，对abp有一个大概的了解，第一个小项目接近尾声，新的项目马上开始，针对开发第一个项目中发现的问题及不方便的地方，本人做一些修改，特此记录，请大家多多指正！

本人的开发环境vs2017 ，vs code，使用abp版本为abp3.5 + angular开发，安装过程就免了，另外本人使用的aspnetzero。请大家自觉支持正版，技术支持很给力。
首先，完善下Abp的日志，apb 的日志系统使用Castle Windsor的日志记录工具，它可以和不同的logginh（日志）类库协作：Log4Net、NLog、Serilog等。Castle为所有Logger库提供一个公共接口，所以它独立于logging库，也可以在有需要的时候很容易地替换logging。

ABP模板 默认采用采用Log4Net，进行了简单的配置，主要是文件日志，查看下log4net的配置方法，尝试了其他的配置，例如数据库等，有些可以成功，有些不行：

  <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender" >
    <file type="log4net.Util.PatternString" value="App_Data/Logs/Log.txt"/>
    <appendToFile value="true" />
    <rollingStyle value="Size" />
    <maxSizeRollBackups value="10" />
    <maximumFileSize value="10000KB" />
    <staticLogFileName value="true" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%-5level %date [%-5.5thread] %-40.40logger - %message%newline" />
    </layout>
  </appender>

abp默认不在控制台输出日志内容，因此有时候错误没办法找，必须打开日志文件（App_Data/Logs/Log.txt）查找最新的错误，这个有点低端，每次打开文本效率有点低，不符合我一贯能装的性格，有没有其他查看日志的方法:web signalr方式，我能想到的大神们估计都想到了，我这里配置了两个能装逼的：log2console和exceptionless；完成这个瞬间牛逼了许多。

先说第一个问题，abp日志配置有个问题就是有的配置节点中的layout type不能采用其他格式，主要是xml格式的貌似不支持；

xml配置方式是log2console的默认配置方式

<appender name="FileAppender" type="log4net.Appender.FileAppender">
    <file value="log-file.txt" />
    <appendToFile value="true" />
    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    <layout type="log4net.Layout.XmlLayoutSchemaLog4j" />
</appender>

这个配置在abp中是没效果的，是不是我漏掉什么了，大神们给个提示，非常感谢！

exceptionless也是这样，无敌了，叔可忍婶不可忍！

1、log2console

修改log2console源码，添加一个receiver，要做的很简单，复制原来的udp receiver，修改解析方法，首先做一个PatternLayout：

    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value='{"date":"%date","thread":"%-5.5thread","level":"%-5level","logger":"%-40.40logger"} %message' />
    </layout>

这个很简单，就是把消息包装成json字符串加上message。

在log2console，Log2Console.Receiver.ReceiverUtils类中添加解析函数：

        public static LogMessage ParsePatternLayoutLogEvent(string logEvent, string defaultLogger)
        {
            var logMsg = new LogMessage();
            var sl = logEvent.Split('}');
            if (sl.Length < 2)
                logMsg.Message = logEvent;
            else
            {
                var jo = Newtonsoft.Json.JsonConvert.DeserializeObject<msgObj>(sl[0]  + "}");
                logMsg.TimeStamp = DateTime.Parse(jo.date.Trim().Replace(',','.'));
                logMsg.Level = LogLevels.Instance[jo.level.Trim()];
                logMsg.LoggerName = jo.logger.Trim();
                logMsg.ThreadName = jo.thread.Trim();
                logMsg.Message = sl[1];
            }
            return logMsg;

        }

在receiver中添加新的解析类UdpPatternLayoutReceiver，简单复制udpReceiver，修改几行代码即可，start函数中，修改解析方法：

                    LogMessage logMsg = ReceiverUtils.ParsePatternLayoutLogEvent(loggingEvent, "UdpLogger");

另外修改SampleClientConfig，可以给用户提供个配置提示。

编译生成log2console。

最终生成的log2console界面。

最后一步，在abp项目中添加udp配置：

  <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
    <param name="Encoding" value="utf-8" />
    <remoteAddress value="10.1.12.188" />
    <remotePort value="7071" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value='{"date":"%date","thread":"%-5.5thread","level":"%-5level","logger":"%-40.40logger"} %message' />
    </layout>
  </appender>



  <root>
  
........
    <appender-ref ref="UdpAppender" />
    <level value="ALL" />
  </root>

现在，解决了看日志的问题了。

 2、exceptionless配置

 解决了看日志的问题保存日志的问题还是保存在文件里，查看历史不方便，exceptionless很好。

exceptionless的安装按照官方说明安装即可，我是在iis上安装的，安装过程中要注意两点，一是版本es版本要按照说明的版本安装，最新版本不支持。二是，es安装完成后，折腾了好长时间，我安装了head这个插件，进行配置没问题了，觉得安装过程中主要是配置了这个参数：

action.auto_creat_index:true  但没有测试不安装head插件仅配置这个参数是否可用。

es的head插件安装成功界面。

安装完成打开exceptionless，注册一个账号后，配置exceptionless，不允许新用户注册即可：

webconfig中添加或修改：<add key="EnableAccountCreation" value="true" />

exceptionless 安装成功。

配置abp中log 的exceptionless：

  <appender name="exceptionless" type="Exceptionless.Log4net.ExceptionlessAppender,Exceptionless.Log4net">
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%-4timestamp [%thread] %-5level %logger %ndc - %message%newline"/>
    </layout>
  </appender>




  <root>
//其他配置
    <appender-ref ref="exceptionless" />
    <level value="ALL" />
  </root>

 

安装nuget exceptionless的包：exceptionless.aspnetcore

在app.config中配置： 

 "Exceptionless": {
    "ApiKey": "你的apkkey",
    "ServerUrl": "http://你的地址",
    "DefaultData": {
      "JSON_OBJECT": "{ \"Name\": \"Blake\" }",
      "Boolean": true,
      "Number": 1,
      "Array": "1,2,3"
    },
    "DefaultTags": [ "xplat" ],
    "Settings": {
      "FeatureXYZEnabled": false
    }
  },

 

最后在host项目的startup的Configure函数中添加：app.UseExceptionless(_appConfiguration);

后续主要有这些方面的完善，敬请期待：

 

大功告成，谢谢你的打赏！