搭建私有Sentry日志收集系统并集成到springboot

Posted by 2020年12月16日 in 开源软件配置

Sentry是一种由Python编写的跨平台程序监控应用， 可以帮助你实时监控和修复崩溃，主要关注错误报告。 Sentry包含一个完整的API，用于在任何应用程序中从任何语言发送事件。

  • JavaScript
  • React-Native
  • Python
  • Ruby
  • PHP
  • Go
  • Rust
  • Java
  • Objective-C/Swift
  • C#
  • Perl
  • Elixir
  • Laravel
  • …

一、安装Sentry

官网的安装入门指南介绍

官网的安装入门指南

大概意思是先去最新发布版本仓库下载安装文件，将安装文件传到服务器上，在安装文件目录执行 ./install.sh 命令安装文件，最后执行docker-compose up -d启动Sentry。Sentry默认绑定9000端口，启动后可以在浏览器访问http://ip:9000登录Sentry可视化页面。

服务器配置要求

  • Docker 19.03.6+ （若不知道怎么安装我看我的另一篇文章centos7安装docker ）
  • Docker Compose 1.24.1+ （若不知道怎么安装我看我的另一篇文章docker-compose安装 ）
  • 内存空余4G以上（官方是2400MB,根据我实际安装情况建议空闲4G左右）

介绍下具体安装步骤

1.下载安装包

去github搜索getsentry/onpremise（不方便贴链接），打开Releases界面下载安装压缩包

getsentry/onpremise

Releases位置

Releases页面下载入口

下面一个tar,gz格式的文件代表是Linux系统的安装文件，我们下载这个文件。

2.上传文件后在上传目录解压

tar -zxvf onpremise-20.9.0.tar.gz

安装包解压目录

3.安装Sentry

先进入进入解压后的目录。9000端口确保没有被占用,如果占用的话修改docker-compose.yml文件中nginx部分的映射端口，比如我这里修改成了19000端口

搭建私有Sentry日志收集系统并集成到springboot

安装期间会提示输入邮箱和密码，随便填比如admin@localhost.com和密码123456

cd onpremise-20.9.0
./install.sh

安装成功后启动使用docker-compose命令启动服务（可以看到当前目录有一个docker-compose.yml文件,若不知道怎么安装我看我的另一篇文章centos7安装docker docker-compose安装 ）

docker-compose up -d

启动成功后通过docker命令docker ps可以看到一堆sentry的服务容器启动了

sentry服务容器

4.浏览器打开 ip:9000，输入命令行填写的邮箱密码登录

搭建私有Sentry日志收集系统并集成到springboot

默认界面是英文的，如果想改成中文可以在登录后点击左侧用户信息的下拉按钮设置语言。有个简体中文的选项。

搭建私有Sentry日志收集系统并集成到springboot

二、创建Sentry项目

1.点击右上角创建项目的按钮

创建项目的按钮

2.选择语言，填写项目名称，点击创建项目按钮会跳转到安装项目的引导界面，里面有一串DSN的地址需要记下来

选择语言，填写项目名称

dsn地址

如果不小心关了找不到这个页面的话可以通过左侧Issues问题菜单找到

Issues问题菜单

3.拷贝下DSN，后面项目接入时需要配置该地址。

三、springboot接入Sentry

Sentry支持非常多的平台， 要向Sentry报告，需要使用特定语言的SDK。Sentry团队为最流行的语言构建和维护这些系统。

Sentry支持非常多的平台

1.引入依赖

官方推荐结合日志框架一起使用,我们结合springboot自带的logback，所以要多引入一个sentry-logback包。

<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-spring-boot-starter</artifactId>
    <version>3.1.0</version>
</dependency>
<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-logback</artifactId>
    <version>3.1.0</version>
</dependency>
<!--我们用@Slf4j注解来打印logback日志（非必须）-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>

2.项目中配置Sentry的dsn地址

springboot的application.yml配置文件配置sentry的dsn地址，dsn地址从上面sentry创建项目时可以看到,因为我们使用springboot自带的logback结合，所以我们也配置下logback文件的路径。

logging:
  config: classpath:logback-spring.xml

sentry:
  dsn: http://ac5a2918ec064472a861066a5c3ddcdc@10.10.4.23:19000/4

3.配置logback

在resources目录下创建logback-spring.xml。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    
    <appender name="SENTRY" class="io.sentry.logback.SentryAppender" />

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="SENTRY" />
    </root>
</configuration>

4.编写测试接口

我们建个controller类，写个测试接口打印出五种不同级别的日志测试下

@RequestMapping("/sentry")
public String sentry(){
    log.info("测试sentry打印info日志");
    log.debug("测试sentry打印debug日志");
    log.warn("测试sentry打印warn日志");
    log.trace("测试sentry打印trace日志");
    log.error("测试sentry打印error日志");
    return "ok";
}

访问下测试接口地址如 http://localhost:8093/sentry ，可以在Sentry的问题菜单下看到一条error的日志。

测试sentry日志展示

5.调整推送日志级别

按上面的配置默认只推送了error级别的日志，我们可以在logback配置文件里调整推送级别，比如我们调整下logback-spring.xml内容使得WARN日志级别就触发推送到Sentry。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />

    <appender name="SENTRY" class="io.sentry.logback.SentryAppender" >
        <minimumEventLevel>WARN</minimumEventLevel>
    </appender>

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="SENTRY" />
    </root>
</configuration>

注意了：在logback文件中配置了日志级别<minimumEventLevel>WARN</minimumEventLevel>后，项目启动的时候日志也会推送到Sentry,比如以下是我启动时的三条warn日志

启动日志

在Sentry上也能看到这三个日志（注意：有的日志会被Sentry聚合在一起，通过EVENTS列可以看到聚合了几个事件），点击问题里面可以看到具体的堆栈日志。

聚合的启动日志

再调用下测试接口，可以看到Sentry接收到了error和warn级别的两条日志（之前测试的我们清空了重新测试）

error和warn级别的两条日志

扩展以下另一种方式，直接引入一个sentry-logback的包，然后在logback配置文件里配置即可

1.引入maven依赖

<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-logback</artifactId>
    <version>3.1.0</version>
</dependency>

2.配置logback-spring.xml，还包含了很多配置项

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />

    <appender name="SENTRY" class="io.sentry.logback.SentryAppender" >
        <options>
            <dsn>http://ac5a2918ec064472a861066a5c3ddcdc@10.10.4.23:19000/4</dsn>
            <shutdownTimeout>2000</shutdownTimeout>
            <flushTimeoutMillis>15000</flushTimeoutMillis>
            <debug>false</debug>
            <maxBreadcrumbs>100</maxBreadcrumbs>
            <release>1.0.0</release>
            <environment>production</environment>
            <sampleRate>1.0</sampleRate>
            <attachThreads>false</attachThreads>
            <attachStacktrace>false</attachStacktrace>
            <serverName>host-4</serverName>
            <connectionTimeoutMillis>5000</connectionTimeoutMillis>
            <readTimeoutMillis>5000</readTimeoutMillis>
        </options>
        <!--推送日志最小级别-->
        <minimumEventLevel>WARN</minimumEventLevel> 
        <!--成为面包屑最小级别，minimumEventLevel需要小与minimumBreadcrumbLevel的级别才会推送-->
				<minimumBreadcrumbLevel>DEBUG</minimumBreadcrumbLevel>
    </appender>

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="SENTRY" />
    </root>
</configuration>

以上就是Sentry的全部内容了，还有许多高级的功能可以自己去了解，本文做个入门介绍。

You May Also Like

No Picture

npm 报错digital envelope routines::unsupported

No Picture

腾讯地图地图选点组件的使用