搭建Sentry异常捕获平台
简介
Sentry是一个实时事件的日志聚合平台,可以实时检测程序异常错误并发出报警通知,帮助开发人员快速定位问题。如果处理快速,在用户反馈前就可以将问题修复,缩小了影响范围,避免同样的错误影响更多用户。
环境搭建
sentry 依赖的东西比较多,有 postgres、redis、memcached、celery、exim4 ,建议使用 docker 安装和管理。
安装 docker
参考 https://www.runoob.com/docker/centos-docker-install.html 安装 Docker Engine-Community
安装 docker-compose
1、下载并安装最新 compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
2、赋予可执行权限
sudo chmod +x /usr/local/bin/docker-compose
使用 getsentry/onpremise 部署 sentry
1、clone github 上的代码的本地
git clone https://github.com/getsentry/onpremise.git
2、进入 onpremise,切换到 stable 分支(默认是master分支),master分支是开发分支,部署时可能有问题,容易采坑耗时。
git checkout stable
3、修改 config.yml,配置邮件发送参数,saas平台使用参数
mail.backend: 'django_smtp_ssl.SSLEmailBackend'
# Use dummy if you want to disable email entirely
mail.host: 'smtp.xxx.com'
mail.port: 465
mail.username: 'noreply@xxx.com'
mail.password: 'xxx' mail.use-tls: true
# The email address to send on behalf of
mail.from: 'noreply@xxx.com'
这里有个坑,如果Sentry部署服务器是阿里云,并且 mai.host 也是阿里云邮箱,那么只能使用 tls 来发送,否则无法连通邮箱服务器的25端口(非tls走25端口)。
4、修改 requirements.txt,添加如下插件,用于发邮件和钉钉通知
sentry-dingtalk-new django-smtp-ssl~=1.0 redis-py-cluster==1.3.4
5、修改 .env (没有可以创建),添加如下配置
SENTRY_EVENT_RETENTION_DAYS=90 SENTRY_IMAGE=sentry:9.1.2
6、执行 sh install.sh 进行安装,过程中会提示创建一个初始用户
7、上一步完成后执行 docker ps 查看容器是否启动,若没有,执行 docker-compose up -d 启动,默认 sentry 占用 9000 端口。
如果 9000 已被占用,有两个办法:
a、执行 docker-compose down 关闭已启动的容器,修改onpremise 的 docker-compose.yml 和 sentry.conf.py 里面的对应端口,然后执行 docker-compose build 重新编译。完成后 docker-compose up -d 重新启动。
b、修改占用 9000 端口的进程端口(使用此方法更简单)
8、执行 docker ps ,若正常可以看到有 7 个容器已启动。
image.png9、如果防火墙已开9000端口,使用浏览器访问 http://ip:9000/ 可以打开 sentry 登录界面
10、建议使用nginx代理 9000端口,对外使用https访问,nginx 配置如下:
server {
listen 80;
server_name sentry.mumway.com;
location / {
if ($request_method = GET) {
rewrite ^ https://$host$request_uri? permanent;
}
return 405;
}
}
server {
listen 443;
server_name sentry.mumway.com;
access_log /data/logs/sentry.mumway.com.access.log main;
error_log /data/logs/sentry.mumway.com.error.log;
ssl_certificate certs/3263894_sentry.mumway.com.pem;
ssl_certificate_key certs/3263894_sentry.mumway.com.key;
ssl_session_cache shared:SSL:1m;
ssl_session_timeout 5m;
ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
ssl_prefer_server_ciphers on;
proxy_set_header Host $http_host;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_redirect off;
# keepalive + raven.js is a disaster keepalive_timeout 0;
# use very aggressive timeouts proxy_read_timeout 5s;
proxy_send_timeout 5s;
send_timeout 10s;
resolver_timeout 5s;
client_body_timeout 5s;
# buffer larger messages
client_max_body_size 5m;
client_body_buffer_size 100k;
location / {
proxy_pass http://localhost:9000;
add_header Strict-Transport-Security "max-age=31536000";
}
}
10、使用初始用户登录 Sentry 后,可以测试下是否可以正常发邮件。左上角点击头像,下拉列表会出现 Admin 菜单,进入后选择左侧的 Mail,里面可以测试。
11、创建项目
创建对应的项目,例如 Django 项目,界面上会提示如果在项目中添加对应的配置来与Sentry交互。配置好之后故意制造一个异常让sentry来捕获,查看平台上是否会显示。
12、配置钉钉通知
使用电脑端登录,确定某个群,然后创建钉钉机器人,拿到webhook地址
在sentry的项目中选择 settings -> Legacy Integrations , 搜索 dingtalk 插件并添加,然后将钉钉机器人webhook地址添加入 dingtalk 保存。