Sentry异常捕获平台

女爷i 2023-01-22 08:56 25阅读 0赞

# 一、概述 #

Sentry是一个实时事件的日志聚合平台。它专门监测错误并提取所有有用信息用于分析，不再麻烦地依赖用户反馈来定位问题。

Sentry发展多年，几乎没有同类产品可与其媲美。它能**覆盖大部分的主流编程语言与框架**，很适合应用到实际生产环境中采集异常日志。

最近我在设计持续交付流程过程时，公司一位前辈提到这个工具与用法。简单搭建并使用之后，基本确定在CD的灰度发布环节应用Sentry：若在灰度过程中获取到异常则触发灰度结束，将可能出现的异常由  
“上线-客户发现问题- 反馈问题-运维手动回滚”  
变为  
“灰度-Sentry捕获异常-自动停止灰度”，杜绝了回滚带来的不好形象，同时也能缩短问题发现的周期。

# 二、环境搭建 #

Sentry可以使用Python2.7搭建，也可以利用Docker直接部署。考虑到目前大部分用户已经使用Python3，直接安装Sentry可能弄乱Python环境，因此**强烈推荐使用Docker搭建Sentry环境**！

以下是Docker搭建Sentry平台的步骤，请保证每一步执行完成：

## 环境说明 ##

ip地址：192.168.31.145

docker版本：19.03.12

配置：2核4g

**注意：推荐内存不能低于3g**

## 部署 ##

1. 启动一个 Redis 容器：

docker run -d --name sentry-redis redis

2. 启动一个 Postgres 容器

docker run -d --name sentry-postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=sentry postgres

3. 生成一个密钥，用于在后面所有sentry容器之间握手。

docker run --rm sentry config generate-secret-key

输出：

^th-r%5nts5a9@eiyjgbxbb0_=n6(oefl!jt+8j8cg_%0r@k@t

**请记住这串密钥**，在后面的docker命令中，密钥需要以环境变量形式传入。

4. 连接Redis、Postgres和Sentry，运行后会自动执行初始化操作：

docker run -it --rm -e SENTRY_SECRET_KEY='^th-r%5nts5a9@eiyjgbxbb0_=n6(oefl!jt+8j8cg_%0r@k@t' --link sentry-postgres:postgres --link sentry-redis:redis sentry upgrade

注意：根据实际情况修改SENTRY\_SECRET\_KEY的值。

输出：

...
    Would you like to create a user account now? [Y/n]: y
    Email: 12345678@qq.com
    Password: 
    Repeat for confirmation: 
    User created: 12345678@qq.com

**注意：这里一定要创建一个默认账号，否则无法登陆后台。账号名必须是一个邮箱地址，方便以后密码找回。**

5. 启动 Sentry Server，同时添加端口映射。Sentry的端口为9000，可以使用 -p 9000:9000 参数，在启动后可以通过访问http://localhost:9000或http://host-ip:9000进入Sentry的web管理页面：

docker run -d --name my-sentry -p 9000:9000 -e SENTRY_SECRET_KEY='^th-r%5nts5a9@eiyjgbxbb0_=n6(oefl!jt+8j8cg_%0r@k@t' --link sentry-redis:redis --link sentry-postgres:postgres sentry

注意：根据实际情况修改SENTRY\_SECRET\_KEY的值。

6. 默认配置中需要Celery，因此启动一个Celery 主节点与执行节点(worker节点可按需多启几个)：

docker run -d --name sentry-cron -e SENTRY_SECRET_KEY='^th-r%5nts5a9@eiyjgbxbb0_=n6(oefl!jt+8j8cg_%0r@k@t' --link sentry-postgres:postgres --link sentry-redis:redis sentry run cron
    
    docker run -d --name sentry-worker-1 -e SENTRY_SECRET_KEY='^th-r%5nts5a9@eiyjgbxbb0_=n6(oefl!jt+8j8cg_%0r@k@t' --link sentry-postgres:postgres --link sentry-redis:redis sentry run worker

注意：根据实际情况修改SENTRY\_SECRET\_KEY的值。

# 三、Sentry配置 #

进入Web管理页面后，按照提示配置管理员账号密码与其他信息。注意：URL填写你所访问的地址，如`http://host-ip:9000`。

![62f878356bdcec4946abff17cc20ddde.png][]

## 切换语言为中文 ##

点击用户设置

![e89b640a178fc18eb4fbdb007f928143.png][]

选择简体中文

![13a005669eb42655d02709225fad9fc3.png][]

点击保存，然后刷新页面，效果如下：

![d9fd8f16a472c3aab66e734554f0fca5.png][]

## 创建项目 ##

以python为例

![006bb963270535ba58303d1d15ad96bd.png][]

效果如下：

![5a2e48628c7ee66f904142363a6c3723.png][]

根据提示，需要安装模块

pip install --upgrade sentry-sdk==0.10.2

新建一个test.py，内容如下：

# ！/usr/bin/python3
    # -*- coding: utf-8 -*-
    import sentry_sdk
    sentry_sdk.init("http://bbda9844af0a4359b77c364576dfdef4@192.168.31.145:9000/1")
    division_by_zero = 1 / 0

执行输出：

Traceback (most recent call last):
      File "E:/python_script/demo/test.py", line 5, in <module>
        division_by_zero = 1 / 0
    ZeroDivisionError: division by zero

返回主页，查看信息

![86edc18653d6b7017f46f71ab0eec01c.png][]

查看详情

![8884812dff8d4bdd56e47f74c40db1b7.png][]

注意：这里可以看到是具体哪一行报错了，感觉很不错的样子。

本文参考链接：

[https://www.jianshu.com/p/ca4ad23a2dd6][https_www.jianshu.com_p_ca4ad23a2dd6]

[http://sinhub.cn/2019/07/getting-started-guide-of-sentry/][http_sinhub.cn_2019_07_getting-started-guide-of-sentry]

[https://blog.csdn.net/socct\_yj/article/details/105506710][https_blog.csdn.net_socct_yj_article_details_105506710]

[62f878356bdcec4946abff17cc20ddde.png]: /images/20221020/772221d75d0443cebebccb95d5a109e3.png
[e89b640a178fc18eb4fbdb007f928143.png]: /images/20221020/f72f36c3eca34a8db480db94a7eae03c.png
[13a005669eb42655d02709225fad9fc3.png]: /images/20221020/f26cf4dc70314a9fadce6bba4279845a.png
[d9fd8f16a472c3aab66e734554f0fca5.png]: /images/20221020/3d4277793b484c18a0e2e6baff2b637e.png
[006bb963270535ba58303d1d15ad96bd.png]: /images/20221020/30f81b144e8243538ae1a19ed27a38a5.png
[5a2e48628c7ee66f904142363a6c3723.png]: /images/20221020/00bb04dce9a641be841bfe0c35d19a22.png
[86edc18653d6b7017f46f71ab0eec01c.png]: /images/20221020/fc6eedd8e13b42efbdbadd84f84da4ef.png
[8884812dff8d4bdd56e47f74c40db1b7.png]: /images/20221020/b1edb96650b34fea9b070db49989cc5d.png
[https_www.jianshu.com_p_ca4ad23a2dd6]: https://www.jianshu.com/p/ca4ad23a2dd6
[http_sinhub.cn_2019_07_getting-started-guide-of-sentry]: http://sinhub.cn/2019/07/getting-started-guide-of-sentry/
[https_blog.csdn.net_socct_yj_article_details_105506710]: https://blog.csdn.net/socct_yj/article/details/105506710