一、Exceptionless極簡介紹

　　Exceptionless 是一個開源的實時的日誌收集框架，它可以應用在基於 ASP.NET，ASP.NET Core，Web API，Web Forms，WPF，Console，ASP.NET MVC 等技術開發的應用程式中，並且提供了REST介面可以應用在 Javascript，Node.js 中。它將日誌收集變得簡單易用並且不需要了解太多的相關技術細節及配置，對於微服務架構的應用程式來說，統一的日誌收集系統的建立更是有必要。

二、Quick Start

2.1 官方建立一個賬號

2.2 建立專案

2.3 得到ApiKey

2.4 安裝Exceptionless.AspNetCore並進行配置

NuGet>Install-Package Exceptionless.AspNetCore　　

　　*.目前最新版本是4.3.2004

　　在你要進行Logging的專案（MVC，WebAPI等）中註冊APIKey，這裡以ASP.NET Core WebAPI專案為例：

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, IApplicationLifetime lifetime)
    {
        ......
        app.UseMvc();
        
 
// exceptionless
        app.UseExceptionless(Configuration["Exceptionless:ApiKey"]);
        // swagger
        ......
    }

　　這裡我將ApiKey配置到了json配置檔案中：

  "Exceptionless": {
    "ApiKey": "Your Api Key from Exceptionless server"
  }

2.5 簡單地封裝一個ExceptionlessLogger

　　（1）自定義一個ILogger介面

    public
 
 interface ILogger
    {
        void Trace(string message, params string[] args);
        void Debug(string message, params string[] args);
        void Info(string message, params string[] args);
        void Warn(string message, params string[] args);
        void Error(string message, params string[] args);
    }

　　（2）實現ILogger介面：ExceptionlessLogger

    public class ExceptionLessLogger : ILogger
    {
        /// <summary>
        /// Trace
        /// </summary>
        public void Trace(string message, params string[] tags)
        {
            ExceptionlessClient.Default.CreateLog(message, LogLevel.Trace).AddTags(tags).Submit();
        }

        /// <summary>
        /// Debug
        /// </summary>
        public void Debug(string message, params string[] tags)
        {
            ExceptionlessClient.Default.CreateLog(message, LogLevel.Debug).AddTags(tags).Submit();
        }

        /// <summary>
        /// Info
        /// </summary>
        public void Info(string message, params string[] tags)
        {
            ExceptionlessClient.Default.CreateLog(message, LogLevel.Info).AddTags(tags).Submit();
        }

        /// <summary>
        /// Warn
        /// </summary>
        public void Warn(string message, params string[] tags)
        {
            ExceptionlessClient.Default.CreateLog(message, LogLevel.Warn).AddTags(tags).Submit();
        }

        /// <summary>
        /// Error
        /// </summary>
        public void Error(string message, params string[] tags)
        {
            ExceptionlessClient.Default.CreateLog(message, LogLevel.Error).AddTags(tags).Submit();
        }
    }

2.6 注入ExceptionlessLogger

    public IServiceProvider ConfigureServices(IServiceCollection services)
    {
        // IoC - Logger
        services.AddSingleton<ILogger, ExceptionLessLogger>();
        ......
    }

2.7 在你想要Logging的地方呼叫

　　比如我們要記錄一個User登入的日誌：

    public class LoginController : Controller
    {
        public ILogger Logger { get; }

        public LoginController(ILogger logger)
        {
            Logger = logger;
        }

        [HttpGet("{id}")]
        public string Get(int id)
        {
            Logger.Info($"User {id} Login Successfully. Time:{DateTime.Now.ToString()}", "Tag1", "Tag2");

            return "Login Success.";
        }
    }

　　測試結果：

2.8 記錄你程式中的各種Exception

　　這裡模擬一個空指標的異常，這裡藉助Exceptionless針對Exception類的擴充套件方法去進行寫異常資訊。

    [HttpGet]
    public string Get()
    {
        try
        {
            string str = null;
            str.ToString();
        }
        catch (Exception ex)
        {
            ex.ToExceptionless().Submit();
        }

        return "Unknown Error!";
    }

　　測試結果：

2.9 Check你的日誌與異常記錄

　　（1）Check 日誌

　　在Log Messages 或 AllEvents選單中選擇Dashboard，即可看到當前專案所有的Log Message了。（如果選擇的是AllEvents，可能還會包含其他型別的資訊，比如Exception）

　　在最近的Log中可以看到我們剛剛的測試中記錄的一跳日誌：

　　點選超連結，即可進入詳細頁面：

　　Overview：可以看到一些專案和日誌的基本資訊，比如Event Type，Level以及標籤Tags

　　Environment：可以看到記錄日誌所在的專案所處的一些軟硬體環境資訊

　　下面是一些額外的資訊，比如Framework Version以及Runtime Framework

　　通過對這些日誌的檢視和分析，我們可以方便地在一個地方對所有服務中的日誌進行檢視和分析。But，線上版本對專案和日誌數量有限制，建議在生產環境使用本地部署版本，它是開源的。

　　（2）Check 異常

　　在Exception選單下選擇Dashboard：

　　在最近的異常資訊中找到剛剛記錄的：

　　同樣，通過超連結檢視詳細資訊：

　　Overview：可以看到這個異常的基本資訊，比如Error Type以及Stack Trace，這些都是可以幫準我們快速定位錯誤的資訊

　　Exception：如果基本資訊不夠，那就檢視詳情，你可能需要看看載入了哪些Modules

　　最後是Environment，跟Log的Environment差不多，這裡就不再貼圖了。

三、本地部署

　　我們說到Exceptionless是一款強大的開源框架，那麼我們可以下載下來根據需要進行獨立部署，可以不受一些使用者、專案、Event數量的限制。這裡我暫時不會去做其獨立部署的實踐，但是園子裡已經有很多的獨立部署實踐的分享了，有興趣的朋友可以看看下面幾篇：

　　以下是測試環境的要求：

　　以下是Production環境的要求，我們可以看到在Production環境中，強烈推薦使用ELK的ElasticSearch，如果有不知道ELK的朋友也可以百度/Google一下，ELK也是我後續的學習計劃。

四、小結

　　本篇主要簡單的介紹了一下開源的分散式日誌框架Exceptionless，並通過兩個小例子介紹瞭如何快速的在ASP.NET Core中進行使用，最後通過在Exceptionless平臺中Check我們在程式中記錄的日誌/異常資訊瞭解Exceptionless的強大。此外，通過引入園友和官方的Wiki文件介紹了Exceptionless的另一種使用模式：本地部署，有興趣的朋友可以去看看，這裡我就不再去實踐了（對我現階段而言，去做獨立部署的優先順序不高）。本篇沒有過多的語言介紹，更多的是貼code以及貼圖片，因此不能算是很好的介紹文章，不過結合列出的參考資料應該可以對Exceptionless做個快速入門。

　　一些朋友問我後續的分享計劃，這裡小小透漏一下：Ocelot+IdentityServer的結合做統一驗證和授權，Ocelot+Butterfly的結合（目前Ocelot已整合Butterfly）做分散式追蹤，基於AppMetrics+InfluxDB+Grafana的效能監控，資料一致性（可能會使用幾個EventBus框架）初探，基於Apollo做配置中心，ASP.NET Core on Docker與K8S結合等等。等到POC初步研究後，可能還會去看看微軟的微服務架構官方高階版大Demo-eShopOnContainers（微軟有一本pdf大家可以去下載，點我下載）。這些計劃可能需要花費我很多時間，不過我相信這樣的學習和實踐是值得的，也是值得分享的，如果你也有這樣的計劃，那就一起加油吧！

參考資料

作者：周旭龍

本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段宣告，且在文章頁面明顯位置給出原文連結。