Net Core集成Exceptionless分布式日志功能以及全局異常過濾

相信很多朋友都看過我的上篇關於Exceptionless的簡單入門教程[asp.Net Core免費開源分布式異常日志收集框架Exceptionless安裝配置以及簡單使用圖文教程][https://www.cnblogs.com/yilezhu/p/9193723.html] 上篇文章只是簡單的介紹了Exceptionless是什么？能做什么呢？以及怎么進行本地部署和異常提交的簡單用法，而這篇文章將帶你探討一下Exceptionless的異常收集高級用法以及你熟悉的類似NLog的日志用法。

這篇文章有一部分內容翻譯自官方文檔，[點我閱讀][https://github.com/exceptionless/Exceptionless.Net/wiki/Sending-Events] 英語好的可以自行閱讀 。當然中間很多代碼我都進行了重構，還有參考周旭龍的代碼，進行了簡單地封裝，同時加入了為webapi加入異常全局過濾器進行異常日志的記錄。希望對大家有所幫助。

本文地址：https://www.cnblogs.com/yilezhu/p/9339017.html
作者：依樂祝

手動發送錯誤

上篇文章介紹了，導入命名空間后，並使用如下代碼就可以簡單地提交異常日志：

try {
    throw new ApplicationException(Guid.NewGuid().ToString());
} catch (Exception ex) {
    ex.ToExceptionless().Submit();
}

發送附加信息

當然你還可以為發送的事件添加額外的標記信息，比如坐標，標簽，以及其他的用戶相關的信息等等

try {
    throw new ApplicationException("Unable to create order from quote.");
} catch (Exception ex) {
    ex.ToExceptionless()
        // 設置一個ReferenceId方便查找
        .SetReferenceId(Guid.NewGuid().ToString("N"))
        // 添加一個不包含CreditCardNumber屬性的對象信息
        .AddObject(order, "Order", excludedPropertyNames: new [] { "CreditCardNumber" }, maxDepth: 2)
        // 設置一個名為"Quote"的編號
        .SetProperty("Quote", 123)
        // 添加一個名為“Order”的標簽
        .AddTags("Order")
        //  標記為關鍵異常
        .MarkAsCritical()
        // 設置一個位置坐標
        .SetGeo(43.595089, -88.444602)
        // 在你的系統中設置userid並提供一個有好的名字，俗稱昵稱
        .SetUserIdentity(user.Id, user.FullName)
        // 為異常信息添加一些用戶描述信息.
        .SetUserDescription(user.EmailAddress, "I tried creating an order from my saved quote.")
        // 提交.
        .Submit();
}

統一修改未處理的異常報告

你可以在通過SubmittingEvent 事件設置全局的忽略異常信息添加一些自定義信息等等

 #region Exceptionless配置
            ExceptionlessClient.Default.Configuration.ApiKey = exceptionlessOptions.Value.ApiKey;
            ExceptionlessClient.Default.Configuration.ServerUrl = exceptionlessOptions.Value.ServerUrl;
            ExceptionlessClient.Default.SubmittingEvent += OnSubmittingEvent;
            app.UseExceptionless();
#endregion

 /// <summary>
        /// 全局配置Exceptionless
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void OnSubmittingEvent(object sender, EventSubmittingEventArgs e)
        {
            // 只處理未處理的異常
            if (!e.IsUnhandledError)
                return;

            // 忽略404錯誤
            if (e.Event.IsNotFound())
            {
                e.Cancel = true;
                return;
            }

            // 忽略沒有錯誤體的錯誤
            var error = e.Event.GetError();
            if (error == null)
                return;
            // 忽略 401 (Unauthorized) 和 請求驗證的錯誤.
            if (error.Code == "401" || error.Type == "System.Web.HttpRequestValidationException")
            {
                e.Cancel = true;
                return;
            }
            // Ignore any exceptions that were not thrown by our code.
            var handledNamespaces = new List<string> { "Exceptionless" };
            if (!error.StackTrace.Select(s => s.DeclaringNamespace).Distinct().Any(ns => handledNamespaces.Any(ns.Contains)))
            {
                e.Cancel = true;
                return;
            }
            // 添加附加信息.
            //e.Event.AddObject(order, "Order", excludedPropertyNames: new[] { "CreditCardNumber" }, maxDepth: 2);
            e.Event.Tags.Add("MunicipalPublicCenter.BusinessApi");
            e.Event.MarkAsCritical();
            //e.Event.SetUserIdentity();
        }

配合使用 NLog 或 Log4Net

有時候，程序中需要對日志信息做非常詳細的記錄，比如在開發階段。這個時候可以配合 log4net 或者 nlog 來聯合使用 exceptionless，詳細可以查看這個官方的 [示例][https://github.com/exceptionless/Exceptionless.Net/tree/master/samples/Exceptionless.SampleConsole]。

如果你的程序中有在短時間內生成大量日志的情況，比如一分鍾產生上千的日志。這個時候你需要使用內存存儲（in-memory store）事件，這樣客戶端就不會將事件系列化的磁盤，所以會快很多。這樣就可以使用Log4net 或者 Nlog來將一些事件存儲到磁盤，另外 Exceptionless 事件存儲到內存當中。

Exceptionless 日志記錄的封裝

1. 首先簡單地封裝一個ILoggerHelper接口

   /// <summary>
       /// lzhu
       /// 2018.7.19
       /// 日志接口
       /// </summary>
       public interface ILoggerHelper
       {
           /// <summary>
           /// 記錄trace日志
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           void Trace(string source, string message, params string[] args);
           /// <summary>
           /// 記錄debug信息
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           void Debug(string source, string message, params string[] args);
           /// <summary>
           /// 記錄信息
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           void Info(string source, string message, params string[] args);
           /// <summary>
           /// 記錄警告日志
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           void Warn(string source, string message, params string[] args);
           /// <summary>
           /// 記錄錯誤日志
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           void Error(string source, string message, params string[] args);
       }
   

2. 既然有了接口，那么當然得實現它了

   /// <summary>
       /// lzhu
       /// 2018.7.19
       /// Exceptionless日志實現
       /// </summary>
       public class ExceptionlessLogger : ILoggerHelper
       {
           /// <summary>
           /// 記錄trace日志
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">添加標記</param>
           public void Trace(string source,string message, params string[] args)
           {
               if (args != null && args.Length > 0)
               {
                   ExceptionlessClient.Default.CreateLog(source, message, LogLevel.Trace).AddTags(args).Submit();
   
               }
               else
               {
                   ExceptionlessClient.Default.SubmitLog(source, message, LogLevel.Trace);
               }
           }
           /// <summary>
           /// 記錄debug信息
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           public void Debug(string source, string message, params string[] args)
           {
               if (args != null && args.Length > 0)
               {
                   ExceptionlessClient.Default.CreateLog(source, message, LogLevel.Debug).AddTags(args).Submit();
               }
               else
               {
                   ExceptionlessClient.Default.SubmitLog(source, message, LogLevel.Debug);
               }
           }
           /// <summary>
           /// 記錄信息
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           public void Info(string source, string message, params string[] args)
           {
               if (args != null && args.Length > 0)
               {
                   ExceptionlessClient.Default.CreateLog(source, message, LogLevel.Info).AddTags(args).Submit();
               }
               else
               {
                   ExceptionlessClient.Default.SubmitLog(source, message, LogLevel.Info);
               }
           }
           /// <summary>
           /// 記錄警告日志
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           public void Warn(string source, string message, params string[] args)
           {
               if (args != null && args.Length > 0)
               {
                   ExceptionlessClient.Default.CreateLog(source, message, LogLevel.Warn).AddTags(args).Submit();
               }
               else
               {
                   ExceptionlessClient.Default.SubmitLog(source, message, LogLevel.Warn);
               }
           }
           /// <summary>
           /// 記錄錯誤日志
           /// </summary>
           /// <param name="source">信息來源</param>
           /// <param name="message">日志內容</param>
           /// <param name="args">標記</param>
           public void Error(string source, string message, params string[] args)
           {
               if (args != null && args.Length > 0)
               {
                   ExceptionlessClient.Default.CreateLog(source, message, LogLevel.Error).AddTags(args).Submit();
               }
               else
               {
                   ExceptionlessClient.Default.SubmitLog(source, message, LogLevel.Error);
               }
           }
       }
   

3. 當然實現好了，可別忘了依賴注入哦

 //注入ExceptionlessLogger服務
            services.AddSingleton<ILoggerHelper, ExceptionlessLogger>();

4. 這時候該寫一個全局異常過濾器了

   /// <summary>
       /// lzhu
       /// 2018.7.19
       /// 定義全局過濾器
       /// </summary>
       public class GlobalExceptionFilter : IExceptionFilter
       {
           
           private readonly ILoggerHelper _loggerHelper;
           //構造函數注入ILoggerHelper
           public GlobalExceptionFilter(ILoggerHelper loggerHelper)
           {
               _loggerHelper = loggerHelper;
           }
   
           public void OnException(ExceptionContext filterContext)
           {
               _loggerHelper.Error(filterContext.Exception.TargetSite.GetType().FullName, filterContext.Exception.ToString(), MpcKeys.GlobalExceptionCommonTags, filterContext.Exception.GetType().FullName);
               var result = new BaseResult()
               {
                   errcode = ResultCodeAddMsgKeys.CommonExceptionCode,//系統異常代碼
                   errmsg= ResultCodeAddMsgKeys.CommonExceptionMsg,//系統異常信息
               };
               filterContext.Result = new ObjectResult(result);
               filterContext.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
               filterContext.ExceptionHandled = true;
           }
       }
   

5. 全局過濾器寫好了，怎么讓它生效呢，客觀別急啊，上正菜

     //添加驗證
               services.AddMvc(options=> {
                   options.Filters.Add<GlobalExceptionFilter>();
               }).AddFluentValidation();
   

6. 哈哈，沒什么說的了，代碼都已經寫好了，剩下的就是上代碼測試結果了。我這里只是簡單地api測試下，萬能的ValuesController登場：

    // GET api/values/5
           [HttpGet("{id}")]
           public ActionResult<string> Get(int id)
           {
               //try
               //{
               throw new Exception($"測試拋出的異常{id}");
               //}
               //catch (Exception ex)
               //{
               //    ex.ToExceptionless().Submit();
               //}
               //return "Unknown Error!";
   
           }
   

   這里是直接拋出異常，不進行trycatch,這時候異常會被全局過濾器捕獲，然后放到Exceptionless的Log里面，別問我為什么會在log里面，因為我全局過濾器代碼里面已經寫明了，不明白的回去看代碼，然后看接口調用的實現方法。下面上結果：

   

點進去，看看詳細信息：

7. 再測試下使用try catch捕獲的異常處理，這時候異常信息會被提交到Exception這個里面。直接上代碼吧

   // GET api/values/5
           [HttpGet("{id}")]
           public ActionResult<string> Get(int id)
           {
               try
               {
                   throw new Exception($"測試拋出的異常{id}");
               }
               catch (Exception ex)
               {
                   ex.ToExceptionless().Submit();
               }
               return "Unknown Error!";
   
           }
   

   到exceptionless里面看看不活的異常吧。打字很累直接上圖吧

   

   點進去看看詳細信息，有三個tab，下面之粘貼一個圖片了：

   

   最后，源碼就不上了，因為上面代碼很清楚了

   總結

   本文沒有對Exceptionless進行過多地介紹，因為博主的[上篇文章][https://www.cnblogs.com/yilezhu/p/9193723.html] 已經進行了詳細的介紹。直接切入正題，先對官方高級用法進行了簡單地翻譯。然后對Exceptionless Log這個eventtype進行了簡單地封裝，讓你可以像使用NLog一樣很爽的使用Exceptionless。最后通過一個asp.net core web api的項目進行了演示，在全局過濾器中利用封裝的Log方法進行全局異常的捕獲。希望對大家使用Exceptionless有所幫助。