Exceptionless - .Net Core開源日誌框架

Exceptionless - .Net Core開源日誌框架

做者：markjiang7m2
原文地址：http://www.javashuo.com/article/p-xgbwmwqk-kk.html
官網地址：http://letyouknow.net

今天要給你們介紹的Exceptionless是一個基於 .net core的開源日誌框架，Exceptionless的意思是：沒有異常。Exceptionless能夠爲ASP.NET, Web API, WebForms, WPF, 控制檯和MVC應用程序提供實時錯誤，功能和日誌報告。它將收集的信息組織成簡單的可操做數據，這將有助於您的應用程序變得無異常。最重要的是，它是開源的！

• Exceptionless官網：https://exceptionless.com/
  
• 說明文檔：https://github.com/exceptionless/Exceptionless/wiki/
  
• Github：https://github.com/exceptionless/Exceptionless/

快速入門

Exceptionless支持直接調用官網服務記錄日誌，這樣能夠很是快速地在咱們的應用中使用Exceptionless，下面咱們來看看具體的步驟。

1. 建立免費帳號

在https://be.exceptionless.io/signup中建立一個免費帳號，只須要提供用戶名、密碼以及郵箱便可，很是簡單。

2. 登陸並建立項目

3. 得到屬於這個項目的API密鑰

4. 配置應用

在咱們的應用中安裝Exceptionless，在Nuget中直接搜索Exceptionless.AspNetCore進行安裝，或者在VS內置Powershell中執行下面命令

Install-Package Exceptionless.AspNetCore

在Startup.cs的Configure方法中添加Exceptionless的使用
這裏就用到前面的API密鑰，固然能夠將這個密鑰添加到appsettings.json文件中，這樣用起來更靈活

using Exceptionless;

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseExceptionless("[你的API密鑰]");
        app.UseMvc();
    }

在代碼中捕獲並記錄異常。這裏我爲了立刻看出效果，本身主動拋了一個異常

// GET api/values/{id}
[HttpGet("{id}")]
public ActionResult<string> Get(int id)
{
    try
    {
        throw new Exception();
    }
    catch (Exception ex)
    {
        ex.ToExceptionless().Submit();
    }
    return $"value {id}";
}

5. 運行並查看日誌報告

我這裏是直接用Debug模式運行測試。這裏有個Dashboard顯示異常記錄的統計信息

點擊某一條具體的異常記錄，能夠查看具體的異常信息

這就是使用官網提供服務的流程。使用很是的簡單，但在使用上也會存在必定的問題。

• 實測發現，應用拋出異常後並不能馬上在Exceptionless網站中看到異常記錄，須要等待必定的時間
  
• 天下沒有免費的午飯，若是須要商用仍是要交錢升級服務，價目表以下。我測試使用的是免費版，只能建立一個項目，每月只能提交3000條記錄，並且這些記錄只能保存3天，這對於商用確定是不足夠的。

本地部署Exceptionless

Exceptionless是開源的，因此它也支持咱們進行本地化部署，官方文檔說明在這裏https://github.com/exceptionless/Exceptionless/wiki/Self-Hosting

前期準備

• .NET 4.6.1
  
• Java JDK 1.8+
  
• 設置JAVA_HOME環境變量
  
• IIS Express 8+
  
• Powersell 3+
  
• 更改Powershell腳本執行策略爲Unrestricted（以管理員身份運行CMD，執行命令行powershell Set-ExecutionPolicy Unrestricted）

由於Exceptionless是使用ElasticSearch進行實時搜索，而ElasticSearch是Java實現的，因此須要安裝Java JDK

1. 下載Exceptionless最新版Release

https://github.com/exceptionless/Exceptionless/releases

2. 快速啓動Exceptionless

解壓Exceptionless壓縮包，直接雙擊Start.bat批處理文件，它就會自動幫咱們安裝運行ElasticSearch、Kibana並啓動一個IIS Express運行Exceptionless Web項目

我這裏爲了能看到批處理文件的輸出信息，在bat文件中最後添加了一行@pause，就是讓它執行完以後不自動關閉窗口

文件夾wwwroot就是Exceptionless Web項目所包含的部署文件

不過，很不幸，我並無立刻成功。。CMD輸出如下錯誤信息

Invoke-WebRequest : 請求被停止: 未能建立 SSL/TLS 安全通道。

一頓搜索獲得的結論就是要在請求命令前面多加一行下面的命令

[System.Net.ServicePointManager]::SecurityProtocol=[System.Net.SecurityProtocolType]::Tls12

根源和解決辦法是在這裏找到的
https://blog.miniasp.com/post/2019/01/12/PowerShell-Invoke-WebRequest-use-TLS-v12

大概意思就是個人電腦同時安裝了.NET 4.0 和.NET 4.5或更高版本，這致使加密協議的默認值爲SSLv3和TLSv1，而Powershell須要使用Tls12才能正常使用Invoke-WebRequest。

因而，我打開Start-ElasticSearch.ps1文件，分別在兩處Invoke-WebRequest命令前添加了上面的命令，注意是兩處

(固然，這裏也能夠用另一個方法繞過這個問題，就是看看Powershell腳本中要下載的是什麼文件，本身單獨先把文件下載好放在它指定的位置就能夠了，我就是這麼幹的。。不過我是由於Powershell這個下載太慢了)

OK，從新執行Start.bat，能夠正常下載，也啓動了ElasticSearch和Kibana

看起來像是正常啓動了，而後，瀏覽器中打開http://localhost:50000/卻獲得了這個

這又是爲什麼呀？看了一下Start-Website.ps1文件，好像也沒什麼特別的，因此我第一反應是50000端口可能被佔用了

結果一查，還真的是，個人有道詞典。。

好吧，我換50001總該行了吧。固然這裏也要注意下，更換端口有3個地方須要改的，要是沒改好，即便網站運行起來了也沒辦法進行註冊等操做

首先是Start-Website.ps1文件中最後兩行

Start-Website $wwwroot 50001
Start-Process "http://localhost:50001"

而後是wwwroot文件夾中的Web.config

<add key="BaseURL" value="http://localhost:50001/#" />

還有很容易被忽略的app.config.77fc9ddd679d37dc.js

angular.module('app.config', [])
    .constant('BASE_URL', 'http://localhost:50001')

再一次執行Start.bat，滿心歡喜地在瀏覽器打開http://localhost:50001/。額，然而仍是失敗，查看50001端口，發現並無任何程序佔用，那也覺得着Exceptionless Web沒有正常啓動。

由於ElasticSearch和Kibana都正常啓動，並且請求也正常，意味着Start-ElasticSearch.ps1這個腳本的執行過程是正常的，那就把焦點專一在Start-Website.ps1上面了。

這文件上面核心的就是一句

cmd /c start cmd /k "$iisExpressExe" "/port:$port" "/path:$path"

根據個人環境，它最終運行的腳本應該是這樣的

cmd /c start cmd /k "C:\Program Files\IIS Express\iisexpress.exe" "/port:50001" "/path:D:\Program Files\Exceptionless.4.1.2861\wwwroot"

好吧，這個時候我才留意到有這麼一個窗口（回家換了個電腦繼續。。你們自動忽略截圖的不一致）

'C:\Program' 不是內部或外部命令，也不是可運行的程序
或批處理文件。

那我大概猜到是什麼問題了，這裏應該是路徑C:\Program Files\IIS Express\iisexpress.exe中含有空格致使的。
既然它是執行批處理命令，那我直接在CMD下面執行下面這個命令應該是沒有問題的

"C:\Program Files\IIS Express\iisexpress.exe" "/port:50001" "/path:D:\Program Files\Exceptionless.4.1.2861\wwwroot"

Bingo，就是它了

那若是非得要在Powershell來執行，有沒有辦法呢？其實，也是有的，但由於我對Powershell不太熟悉，因此只找了一種，可是感受這不是最優解

把前面的命令行改成下面這個

cmd /c start cmd /k "C:\Progra~1\IISExp~1\iisexpress.exe" "/port:50001" "/path:D:\Program Files\Exceptionless.4.1.2861\wwwroot"

這裏就是把Program Files改成Progra~1，IIS Express改成IISExp~1，基本語法是，去除空格後取得前面的六個字母，~表示省略後面的字符，而後1是表示第一個匹配的文件夾

這是我在Windows系統下部署Exceptionless過程當中遇到的問題，但由於在官網上的介紹是直接雙擊運行Start.bat就完成部署的，不知道其餘朋友有沒有遇到跟我同樣的問題。

我這裏就沒有繼續糾結怎麼修改Start-Website.ps1文件裏面的腳本了哈，各位有感興趣的朋友能夠研究後在留言區分享一下。

固然了，前面這麼麻煩只是爲了找出問題的緣由，但若是回到本質，這個腳本就是爲了用IIS Express部署Exceptionless Web站點，那其實咱們更廣泛的是直接用IIS管理器新建一個站點就能夠了。

從新整理這個啓動流程，就是下載並啓動ElasticSearch和Kibana服務，而後部署Exceptionless Web站點。

因此，咱們能夠按照下面這個步驟：

• 執行Start-ElasticSearch.ps1啓動ElasticSearch和Kibana服務
  
• IIS管理器部署Exceptionless Web站點，設置端口50001

3. Exceptionless註冊用戶

這裏跟前面使用官網服務時是同樣的，註冊用戶，新建項目，得到Api密鑰

4. 應用集成本地Exceptionless

在應用中使用本地服務跟官網服務也基本相同，只是須要將默認的Exceptionless服務地址改成本地的

Startup.cs中的Configure方法

ExceptionlessClient.Default.Configuration.ApiKey = Configuration.GetSection("Exceptionless:ApiKey").Value;
ExceptionlessClient.Default.Configuration.ServerUrl = Configuration.GetSection("Exceptionless:ServerUrl").Value;
app.UseExceptionless();

這裏我就將兩個配置項放到了appsettings.json文件裏

"Exceptionless": {
    "ApiKey": "4pyCA8KFr3YekuVStkIbaE7Hqq1YIZAR6vH8OrYh",
    "ServerUrl": "http://localhost:50001"
}

運行以後就能夠看到Exceptionless上有異常的記錄

並且，咱們也能夠看到異常記錄數量是沒有限制的

總結

本文主要是介紹瞭如何快速應用Exceptionless記錄異常，以及如何進行本地化部署，而後就是在我本身進行試驗的過程當中踩到的坑，固然了Exceptionless還有不少功能，以及本地化時的一些設置在本文中都是沒有涉及到的，目前我介紹的也就是一個能用的階段，哈哈，後面我有深刻的時候再給你們總結。今天就先跟你們介紹到這裏，但願你們能持續關注咱們。

參考文獻
本文在編寫過程當中引用或參考瞭如下文章中的部份內容，若有侵權，請聯繫修改或刪除。
https://www.cnblogs.com/edisonchou/p/exceptionless_deployment_on_production_env_introduction.html
https://blog.miniasp.com/post/2019/01/12/PowerShell-Invoke-WebRequest-use-TLS-v12