Exceptionless

<div id="cnblogs\_post\_body" class="blogpost-body cnblogs-markdown"><h1 id="exceptionless---.net-core开源日志框架">Exceptionless - .Net Core开源日志框架</h1> <blockquote> 作者：markjiang7m2 原文地址：<a href="http://letyouknow.net/exceptionless/exceptionless-tutorial-1.html" class="uri">http://letyouknow.net/exceptionless/exceptionless-tutorial-1.html</a> 官网地址：<a href="http://letyouknow.net/" class="uri">http://letyouknow.net</a> </blockquote> 今天要给大家介绍的Exceptionless是一个基于 .net core的开源日志框架，Exceptionless的意思是：没有异常。Exceptionless可以为ASP.NET, Web API, WebForms, WPF, 控制台和MVC应用程序提供实时错误，功能和日志报告。它将收集的信息组织成简单的可操作数据，这将有助于您的应用程序变得无异常。最重要的是，它是开源的！ <ul> <li>Exceptionless官网：<a href="https://exceptionless.com/" class="uri">https://exceptionless.com/</a> </li> <li>说明文档：<a href="https://github.com/exceptionless/Exceptionless/wiki/" class="uri">https://github.com/exceptionless/Exceptionless/wiki/</a> </li> <li>Github：<a href="https://github.com/exceptionless/Exceptionless/" class="uri">https://github.com/exceptionless/Exceptionless/</a></li> </ul> <h3 id="快速入门">快速入门</h3> Exceptionless支持直接调用官网服务记录日志，这样可以非常快速地在我们的应用中使用Exceptionless，下面我们来看看具体的步骤。 <h4 id="创建免费账号">1. 创建免费账号</h4> 在<a href="https://be.exceptionless.io/signup" target="\_blank">https://be.exceptionless.io/signup</a>中创建一个免费账号，只需要提供用户名、密码以及邮箱即可，非常简单。 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_01\_signup.png" alt="less\_01\_signup.png"> <h4 id="登录并创建项目">2. 登录并创建项目</h4> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_02\_Demo.png" alt="less\_02\_Demo.png"> <h4 id="获得属于这个项目的api密钥">3. 获得属于这个项目的API密钥</h4> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_03\_apikey.png" alt="less\_03\_apikey.png"> <h4 id="配置应用">4. 配置应用</h4> 在我们的应用中安装Exceptionless，在Nuget中直接搜索<code>Exceptionless.AspNetCore</code>进行安装，或者在VS内置Powershell中执行下面命令 <pre class="shell"><code class="hljs">Install-Package Exceptionless.AspNetCore</code></pre> 在Startup.cs的<code>Configure</code>方法中添加Exceptionless的使用 这里就用到前面的API密钥，当然可以将这个密钥添加到<code>appsettings.json</code>文件中，这样用起来更灵活 <pre class="c#"><code class="hljs nginx">using Exceptionless;</code></pre> <pre class="c#"><code class="hljs less">public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); }

1    <span class="hljs-selector-tag">app</span><span class="hljs-selector-class">.UseExceptionless</span>(<span class="hljs-string">"[你的API密钥]"</span>);
2    <span class="hljs-selector-tag">app</span><span class="hljs-selector-class">.UseMvc</span>();
3}</code></pre>

在代码中捕获并记录异常。这里我为了马上看出效果，自己主动抛了一个异常 <pre class="c#"><code class="hljs cs">// 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}"; }</code></pre> <h4 id="运行并查看日志报告">5. 运行并查看日志报告</h4> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_04\_apitest.png" alt="less\_04\_apitest.png"> 我这里是直接用Debug模式运行测试。这里有个Dashboard显示异常记录的统计信息 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_05\_exceptionbashboard.png" alt="less\_05\_exceptionbashboard.png"> 点击某一条具体的异常记录，可以查看具体的异常信息 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_06\_exceptionoverview.png" alt="less\_06\_exceptionoverview.png"> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_07\_exceptionenvironment.png" alt="less\_07\_exceptionenvironment.png"> 这就是使用官网提供服务的流程。使用非常的简单，但在使用上也会存在一定的问题。 <ul> <li>实测发现，应用抛出异常后并不能立刻在Exceptionless网站中看到异常记录，需要等待一定的时间 </li> <li>天下没有免费的午餐，如果需要商用还是要交钱升级服务，价目表如下。我测试使用的是免费版，只能创建一个项目，每个月只能提交3000条记录，而且这些记录只能保存3天，这对于商用肯定是不足够的。</li> </ul> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_08\_price.png" alt="less\_08\_price.png"> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_09\_projectmanagement.png" alt="less\_09\_projectmanagement.png"> <h3 id="本地部署exceptionless">本地部署Exceptionless</h3> Exceptionless是开源的，所以它也支持我们进行本地化部署，官方文档说明在这里<a href="https://github.com/exceptionless/Exceptionless/wiki/Self-Hosting" target="\_blank">https://github.com/exceptionless/Exceptionless/wiki/Self-Hosting</a> 前期准备 <ul> <li>.NET 4.6.1 </li> <li>Java JDK 1.8+ </li> <li>设置JAVA\_HOME环境变量 </li> <li>IIS Express 8+ </li> <li>Powersell 3+ </li> <li>更改Powershell脚本执行策略为Unrestricted（以管理员身份运行CMD，执行命令行<code>powershell Set-ExecutionPolicy Unrestricted</code>）</li> </ul> <blockquote> 因为Exceptionless是使用ElasticSearch进行实时搜索，而ElasticSearch是Java实现的，所以需要安装Java JDK </blockquote> <h4 id="下载exceptionless最新版release">1. 下载Exceptionless最新版Release</h4> <a href="https://github.com/exceptionless/Exceptionless/releases" target="\_blank">https://github.com/exceptionless/Exceptionless/releases</a> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_10\_release.png" alt="less\_10\_release.png"> <h4 id="快速启动exceptionless">2. 快速启动Exceptionless</h4> 解压Exceptionless压缩包，直接双击<code>Start.bat</code>批处理文件，它就会自动帮我们安装运行<code>ElasticSearch</code>、<code>Kibana</code>并启动一个IIS Express运行Exceptionless Web项目 <blockquote> 我这里为了能看到批处理文件的输出信息，在bat文件中最后添加了一行<code>@pause</code>，就是让它执行完之后不自动关闭窗口 </blockquote> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_11\_startbat.png" alt="less\_11\_startbat.png"> 文件夹<code>wwwroot</code>就是Exceptionless Web项目所包含的部署文件 不过，很不幸，我并没有马上成功。。CMD输出以下错误信息 <pre class="shell"><code class="hljs">Invoke-WebRequest : 请求被中止: 未能创建 SSL/TLS 安全通道。</code></pre> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_12\_elasticsearch\_error.png" alt="less\_12\_elasticsearch\_error.png"> 一顿搜索得到的结论就是要在请求命令前面多加一行下面的命令 <pre class="shell"><code class="hljs">\[System.Net.ServicePointManager\]::SecurityProtocol=\[System.Net.SecurityProtocolType\]::Tls12</code></pre> 根源和解决办法是在这里找到的 <a href="https://blog.miniasp.com/post/2019/01/12/PowerShell-Invoke-WebRequest-use-TLS-v12" target="\_blank">https://blog.miniasp.com/post/2019/01/12/PowerShell-Invoke-WebRequest-use-TLS-v12</a> 大概意思就是我的电脑同时安装了.NET 4.0 和.NET 4.5或更高版本，这导致加密协议的默认值为<code>SSLv3</code>和<code>TLSv1</code>，而Powershell需要使用<code>Tls12</code>才能正常使用<code>Invoke-WebRequest</code>。 于是，我打开<code>Start-ElasticSearch.ps1</code>文件，分别在两处<code>Invoke-WebRequest</code>命令前添加了上面的命令，注意是两处 (当然，这里也可以用另外一个方法绕过这个问题，就是看看Powershell脚本中要下载的是什么文件，自己单独先把文件下载好放在它指定的位置就可以了，我就是这么干的。。不过我是因为Powershell这个下载太慢了) OK，重新执行<code>Start.bat</code>，可以正常下载，也启动了ElasticSearch和Kibana <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_13\_exceptionless\_start.png" alt="less\_13\_exceptionless\_start.png"> 看起来像是正常启动了，然后，浏览器中打开<code>http://localhost:50000/</code>却得到了这个 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_14\_500.png" alt="less\_14\_500.png"> 这又是为何呀？看了一下<code>Start-Website.ps1</code>文件，好像也没什么特别的，所以我第一反应是<code>50000</code>端口可能被占用了 结果一查，还真的是，我的有道词典。。 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_15\_50000.png" alt="less\_15\_50000.png"> 好吧，我换<code>50001</code>总该行了吧。当然这里也要注意下，更换端口有3个地方需要改的，要是没改好，即使网站运行起来了也没办法进行注册等操作 首先是<code>Start-Website.ps1</code>文件中最后两行 <pre class="shell"><code class="hljs">Start-Website $wwwroot 50001 Start-Process "http://localhost:50001"</code></pre> 然后是<code>wwwroot</code>文件夹中的<code>Web.config</code> <pre class="shell"><code class="hljs"><add key="BaseURL" value="http://localhost:50001/#" /></code></pre> 还有很容易被忽略的<code>app.config.77fc9ddd679d37dc.js</code> <pre class="js"><code class="hljs javascript">angular.module('app.config', \[\]) .constant('BASE\_URL', 'http://localhost:50001')</code></pre> 再一次执行<code>Start.bat</code>，满心欢喜地在浏览器打开<code>http://localhost:50001/</code>。额，然而还是失败，查看50001端口，发现并没有任何程序占用，那也以为着Exceptionless Web没有正常启动。 因为ElasticSearch和Kibana都正常启动，而且请求也正常，意味着<code>Start-ElasticSearch.ps1</code>这个脚本的执行过程是正常的，那就把焦点专注在<code>Start-Website.ps1</code>上面了。 这文件上面核心的就是一句 <pre class="shell"><code class="hljs">cmd /c start cmd /k "$iisExpressExe" "/port:$port" "/path:$path"</code></pre> 根据我的环境，它最终运行的脚本应该是这样的 <pre class="shell"><code class="hljs">cmd /c start cmd /k "C:\\Program Files\\IIS Express\\iisexpress.exe" "/port:50001" "/path:D:\\Program Files\\Exceptionless.4.1.2861\\wwwroot"</code></pre> 好吧，这个时候我才留意到有这么一个窗口（回家换了个电脑继续。。大家自动忽略截图的不一致） <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_16\_cprogram.png" alt="less\_16\_cprogram.png"> <pre class="shell"><code class="hljs">'C:\\Program' 不是内部或外部命令，也不是可运行的程序或批处理文件。</code></pre> 那我大概猜到是什么问题了，这里应该是路径<code>C:\\Program Files\\IIS Express\\iisexpress.exe</code>中含有空格导致的。 既然它是执行批处理命令，那我直接在CMD下面执行下面这个命令应该是没有问题的 <pre class="shell"><code class="hljs">"C:\\Program Files\\IIS Express\\iisexpress.exe" "/port:50001" "/path:D:\\Program Files\\Exceptionless.4.1.2861\\wwwroot"</code></pre> Bingo，就是它了 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_17\_webstart.png" alt="less\_17\_webstart.png"> <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_18\_50001.png" alt="less\_18\_50001.png"> 那如果非得要在Powershell来执行，有没有办法呢？其实，也是有的，但因为我对Powershell不太熟悉，所以只找了一种，但是感觉这不是最优解 把前面的命令行改为下面这个 <pre class="shell"><code class="hljs">cmd /c start cmd /k "C:\\Progra~1\\IISExp~1\\iisexpress.exe" "/port:50001" "/path:D:\\Program Files\\Exceptionless.4.1.2861\\wwwroot"</code></pre> 这里就是把<code>Program Files</code>改为<code>Progra~1</code>，<code>IIS Express</code>改为<code>IISExp~1</code>，基本语法是，去除空格后取得前面的六个字母，<code>~</code>表示省略后面的字符，然后<code>1</code>是表示第一个匹配的文件夹 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_19\_powershell.png" alt="less\_19\_powershell.png"> 这是我在Windows系统下部署Exceptionless过程中遇到的问题，但因为在官网上的介绍是直接双击运行<code>Start.bat</code>就完成部署的，不知道其他朋友有没有遇到跟我一样的问题。 我这里就没有继续纠结怎么修改<code>Start-Website.ps1</code>文件里面的脚本了哈，各位有感兴趣的朋友可以研究后在留言区分享一下。 当然了，前面这么麻烦只是为了找出问题的原因，但如果回到本质，这个脚本就是为了用IIS Express部署Exceptionless Web站点，那其实我们更普遍的是直接用IIS管理器新建一个站点就可以了。 重新整理这个启动流程，就是下载并启动ElasticSearch和Kibana服务，然后部署Exceptionless Web站点。 所以，我们可以按照下面这个步骤： <ul> <li>执行<code>Start-ElasticSearch.ps1</code>启动ElasticSearch和Kibana服务 </li> <li>IIS管理器部署Exceptionless Web站点，设置端口50001</li> </ul> <h4 id="exceptionless注册用户">3. Exceptionless注册用户</h4> 这里跟前面使用官网服务时是一样的，注册用户，新建项目，获得Api密钥 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_20\_localproject.png" alt="less\_20\_localproject.png"> <h4 id="应用集成本地exceptionless">4. 应用集成本地Exceptionless</h4> 在应用中使用本地服务跟官网服务也基本相同，只是需要将默认的Exceptionless服务地址改为本地的 <code>Startup.cs</code>中的<code>Configure</code>方法 <pre class="c#"><code class="hljs vhdl">ExceptionlessClient.Default.Configuration.ApiKey = Configuration.GetSection("Exceptionless:ApiKey").Value; ExceptionlessClient.Default.Configuration.ServerUrl = Configuration.GetSection("Exceptionless:ServerUrl").Value; app.UseExceptionless();</code></pre> 这里我就将两个配置项放到了<code>appsettings.json</code>文件里 <pre class="js"><code class="hljs javascript">"Exceptionless": { "ApiKey": "4pyCA8KFr3YekuVStkIbaE7Hqq1YIZAR6vH8OrYh", "ServerUrl": "http://localhost:50001" }</code></pre> 运行之后就可以看到Exceptionless上有异常的记录 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_21\_localbashboard.png" alt="less\_21\_localbashboard.png"> 而且，我们也可以看到异常记录数量是没有限制的 <img src="https://gitee.com/Sevenm2/cnblogsPic/raw/master/Exceptionless/less\_22\_localplan.png" alt="less\_22\_localplan.png"> <h3 id="总结">总结</h3> 本文主要是介绍了如何快速应用Exceptionless记录异常，以及如何进行本地化部署，然后就是在我自己进行试验的过程中踩到的坑，当然了Exceptionless还有很多功能，以及本地化时的一些设置在本文中都是没有涉及到的，目前我介绍的也就是一个能用的阶段，哈哈，后面我有深入的时候再给大家总结。今天就先跟大家介绍到这里，希望大家能持续关注我们。 <blockquote> 参考文献 本文在编写过程中引用或参考了以下文章中的部分内容，如有侵权，请联系修改或删除。 <a href="https://www.cnblogs.com/edisonchou/p/exceptionless\_deployment\_on\_production\_env\_introduction.html" target="\_blank">https://www.cnblogs.com/edisonchou/p/exceptionless\_deployment\_on\_production\_env\_introduction.html</a> <a href="https://blog.miniasp.com/post/2019/01/12/PowerShell-Invoke-WebRequest-use-TLS-v12" target="\_blank">https://blog.miniasp.com/post/2019/01/12/PowerShell-Invoke-WebRequest-use-TLS-v12</a> </blockquote> </div>

评论区

相关推荐