Exceptionless - .Net Core开源日志框架

原文:Exceptionless - .Net Core开源日志框架

Exceptionless - .Net Core开源日志框架

作者：markjiang7m2

原文地址：https://www.cnblogs.com/markjiang7m2/p/11020140.html

官网地址：http://letyouknow.net

今天要给大家介绍的Exceptionless是一个基于 .net core的开源日志框架，Exceptionless的意思是：没有异常。Exceptionless可以为ASP.NET, Web API, WebForms, WPF, 控制台和MVC应用程序提供实时错误，功能和日志报告。它将收集的信息组织成简单的可操作数据，这将有助于您的应用程序变得无异常。最重要的是，它是开源的！

快速入门

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

原文地址：https://www.cnblogs.com/lonelyxmas/p/11108246.html

时间： 2024-08-29 03:01:07

Exceptionless - .Net Core开源日志框架的相关文章

开源日志框架Exceptionless使用教程

原文:开源日志框架Exceptionless使用教程 Exceptionless是一款日志记录框架,它开源.免费.提供管理界面.易于安装和使用.ExceptionLess底层采用ElasticSearch作为日志存储,提供了快速.丰富的查询API,方便我们进行系统集成.本文将介绍ExceptionLess的常见用法. 安装ExceptionLess 在ExceptionLess官网提供了基于Docker的私有化部署方式,我们可以按照官网的方式进行测试环境的安装. 在官网github中下载最新的r

Apache开源日志框架Log4j配置指南

Log4j是Apache的一个开源项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台.文件.GUI组件,甚至是套接口服务器.NT的事件记录器.UNIX Syslog守护进程等:我们也可以控制每一条日志的输出格式:通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程.最方便的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码.本篇指南主要介绍Log4j 1.x版本的配置与使用Log4j最新版下载地址:http://www.apache.org/dy

.NET开源分布式日志框架ExceptionLess实战演练(公开版)

一.课程介绍 在以前,我们做日志收集大多使用 Log4net,Nlog 等框架,在应用程序变得复杂并且集群的时候,可能传统的方式已经不是很好的适用了,因为收集各个日志并且分析他们将变得麻烦而且浪费时间.相信大家的项目中日志功能已经做为基础设施里必不可少的一部分了,日志记录不仅可以更好的记录用户行为,还可以记录系统运行日志,从而看到判断系统运行的健壮性.了解决实时日志监控问题,ELK提供的一套的解决方案就应运而生了 ,作为NET技术的我们,开源的轻量级分布式ExceptionLess 日志框架或许

iOS开源项目之日志框架CocoaLumberjack

iOS开源项目之日志框架CocoaLumberjack CocoaLumberjack是Mac和iOS上一个集快捷.简单.强大和灵活于一身的日志框架.CocoaLumberjack类似于流行的日志框架(如log4j),但它是专为Objective-C设计的,利用了多线程.GCD(如果可用).无锁原 CocoaLumberjack是Mac和iOS上一个集快捷.简单.强大和灵活于一身的日志框架.CocoaLumberjack类似于流行的日志框架(如log4j),但它是专为Objective-C设计的

.NET Core第三方开源Web框架YOYOFx

YOYOFx框架 YOYOFx是一个轻量级用于构建基于 HTTP 的 Web 服务,基于 .NET 和 Mono 平台. 本着学习的态度,造了这个轮子,也是为了更好的了解各个框架的原理和有点,还希望可以和大家多交流 . GitHub:https://github.com/maxzhang1985/YOYOFx YOYOFx是支持Owin协议的MVC框架,基于NETStandard1.6和NET451编译,完美支持在Core和full framework(如.net framework 4.5x或

Magicodes.Admin.Core开源框架总体介绍

框架说明 Magicodes.Admin.Core框架在ABP以及ASP.NET ZERO的基础上进行了封装和完善,目前基于.NET Core 2.0+(Framework版本),由于部分组件在.NET Core没有找到替代组件,所以真正意义上跨平台版本会在后续推出. 目前本框架已经应用于团队的所有项目,在实际开发过程中还在不断地打磨. 由于本人和团队成员都是利用自己的时间来打磨本框架,因此在大部分情况下,并不会在相关群内进行解答,如果确实是疑难问题,请提交Issue.如果觉得本框架对您有所帮助

asp.net core 集成 log4net 日志框架

原文:asp.net core 集成 log4net 日志框架 asp.net core 集成 log4net 日志框架 Intro 在 asp.net core 中有些日志我们可能想输出到数据库或文件或elasticsearch等,如果不自己去实现一个 LoggerProvider 的话就需要借助第三方日志框架实现了,而一些第三方框架的实现大多比较完善和成熟,不失为一个好办法. 自己写了一个 log4net 的扩展 WeihanLi.Common.Logging.Log4Net,提供了在 .n

开源日志收集Exceptionless简单使用

原文:开源日志收集Exceptionless简单使用 这两天在研究一个开源的日志收集工具Exceptionless 官网地址:https://exceptionless.com/GitHub地址:https://github.com/exceptionless/Exceptionless 官网为我们提供了两种使用方式. 一.在官网注册账号后即可快速使用(不用关心日志收集环境的搭建,专注自己代码逻辑就好),唯一不好的地方就是你系统中的所有日志信息都会被上传至官网服务中了. 二.下载官网为我们提供的

tomcat日志及logback相关日志框架

一.重点问题整理 1.1 关于logback.xml中的路径设置问题 准备金系统的logback.xml中设置的路径是: <!-- 定义日志文件 输出位置 --> <property name="log_dir" value="E:\logs" /> 在Windows环境下,会识别E:为系统的E盘,默认在E盘下创建logs文件夹.但是正在Linux环境下,不存在E盘,会将E:\logs识别为E:logs文件夹.此时为相对路径,而tomcat在