七叶笔记 » golang编程 » 应用异常监控利器 Sentry 搭建与学习笔记

应用异常监控利器 Sentry 搭建与学习笔记

分类: golang编程 | 浏览: 628

什么是Sentry？ 

 
Welcome to the Sentry documentation. Sentry is an open-source company, 
 
providing an application monitoring platform that helps you identify 
 
issues in real-time. Here we cover everything about the product, the platform integrations, and self-hosted Sentry. 
 
欢迎使用Sentry文档。Sentry是一家开源公司，提供了一个应用程序监视平台，可以帮助您实时识别问题。 
 
在这里，我们涵盖了有关产品，平台集成和自托管Sentry的所有内容。 
 
【通俗讲的讲】 
 
我们可以使用Sentry平台实时地监控我们的应用或服务、并且可以收集相关运行时错误或异常日志信息， 
 
在第一时间将错误信息推送至我们的后台或邮件组等。这样不仅能主动帮我们第一时间发现线上问题， 
 
而且很好的保留了异常发生时的“现场”，更有助于我们快速定位问题根源，提高解决问题的效率，逐步提高产品的稳定性和用户体验。

官网及文档

Sentry的原理

  • 在Sentry后台注册相关账号并使用关联Dsn-key。（该key是关联应用和后台平台的桥梁）

  • 在我们的应用中潜入对应语言的SDK埋点，并关联上述key；

简单到仅用一个 Init 方法就可以搞定。

  • 捕获异常并埋点，将异常信息第一时间推送至后台平台。

Sentry平台的优势

  • 支持各种主流语言或框架。

  • 跨平台性较好，并支持容器化安装搭建等。

  • 平台自建成本低、部署简单、集成方便。

Sentry-Golang版的支持

  • 官方文档

  • fasthttp框架支持 go /fasthttp/

平台搭建与实践

  • 虚拟机环境

  • CentOS Linux release 7.6.1810 (Core)

  • Sentry Docker 镜像获取

  • 安装部署 

 
1.docker run -d --name sentry-redis redis 
 
2.docker run -d --name sentry-postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=sentry postgres 
 
3.docker run --rm sentry config generate-secret-key 
 
这一步会生成一个密钥key，比如 *l%)ti9=v#!pt__!#hpz3g33tq3hy2afpv%sda6^^ghr24)k4q ，先记下来，后面步骤中多个容器会共享该key 
 
4.docker run -it --rm -e SENTRY_SECRET_KEY='*l%)ti9=v#!pt__!#hpz3g33tq3hy2afpv%sda6^^ghr24)k4q' --link sentry-postgres:postgres --link  sentry -redis:redis sentry upgrade 
 
5.docker run -d -p 9090:9000 --name my-sentry -e SENTRY_SECRET_KEY='*l%)ti9=v#!pt__!#hpz3g33tq3hy2afpv%sda6^^ghr24)k4q' --link sentry-redis:redis --link sentry-postgres:postgres sentry 
 
6.docker run -d --name sentry-cron -e SENTRY_SECRET_KEY='*l%)ti9=v#!pt__!#hpz3g33tq3hy2afpv%sda6^^ghr24)k4q' --link sentry-postgres:postgres --link sentry-redis:redis sentry run cron 
 
7.docker run -d --name sentry-worker-1 -e SENTRY_SECRET_KEY='*l%)ti9=v#!pt__!#hpz3g33tq3hy2afpv%sda6^^ghr24)k4q' --link sentry-postgres:postgres --link sentry-redis:redis sentry run worker 
 
上述几步完成后，查看下刚才创建的容器以及运行状态是否完好： 
 
➜ /tmp docker ps 
 
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 
 
7ed2439c527c sentry "/entrypoint.sh run …" 3 hours ago Up 3 hours 9000/tcp sentry-worker-1 
 
f3779877d102 sentry "/entrypoint.sh run …" 3 hours ago Up 3 hours 9000/tcp sentry-cron 
 
9c190bd613a6 sentry "/entrypoint.sh run …" 3 hours ago Up 3 hours 0.0.0.0:9090->9000/tcp my-sentry 
 
188c744c2f21 postgres "docker-entrypoint.s…" 4 hours ago Up 4 hours 5432/tcp sentry-postgres 
 
abad0564ca2b redis "docker-entrypoint.s…" 4 hours ago Up 4 hours 6379/tcp sentry-redis 
 
然后检查下宿主机防火墙或安全组策略，放行上述映射的9090端口；

  • 在浏览器中访问并测试

  • 访问成功后登陆

如果成功，您会看到如下页面

然后用上述第4步中填入第账户登陆并配置，成功后进入首页

  • 简体中文设置

打开左上角第个人中心，然后点击User settings->language-> 选择简体中文即可.

  • 然后可以创建一个团队，如名称为server

  • 然后创建一个项目，如go-sentry-test

  • 将sdk潜入Golang应用，如go-sentry-test.go 

 
 import ( 
 
"errors" 
 
"time" 
 
" github .com/getsentry/sentry-go" 
 
) 
 
 func  main  { 
 
sentry.Init(sentry.ClientOptions{ 
 
Dsn: "", 
 
}) 
 
sentry.CaptureException(errors.New("my error")) 
 
// Since sentry emits events in the background we need to make sure 
 
// they are sent before we shut down 
 
sentry.Flush(time.Second * 5 ) 
 
}

本地运行并模拟错误将日志上报

go run go-sentry-test.go

  • 刷新后台页面，看到刚刚咱们应用上传的error已经在issues列表中了，如图

  • 并且还支持直接潜入到web框架，如以fasthttp为例： 

 
 import ( 
 
"fmt" 
 
"net/http" 
 
"github.com/getsentry/sentry-go" 
 
sentryfasthttp "github.com/getsentry/sentry-go/fasthttp" 
 
) 
 
// To initialize Sentry's handler, you need to initialize Sentry itself beforehand 
 
 if err := sentry.Init(sentry.ClientOptions{ 
 
Dsn: "", 
 
}); err !=  nil { 
 
fmt.Printf("Sentry initialization failed: %v\n", err) 
 
} 
 
// Create an instance of sentryfasthttp 
 
sentryHandler := sentryfasthttp.New(sentryfasthttp.Options{}) 
 
// After creating the instance, you can attach the handler as one of your middleware 
 
fastHTTPHandler := sentryHandler.Handle( func (ctx *fasthttp.RequestCtx) { 
 
 panic ("y tho") 
 
}) 
 
fmt.Println("Listening and serving HTTP on :3000") 
 
// And run it 
 
 if err := fasthttp.ListenAndServe(":3000", fastHTTPHandler); err != nil { 
 
 panic (err) 
 
}

  • 直接使用官方提供的admin后台做测试或学习

上述是自己完整到搭建一下sentry，如果仅是为了学习或测试一下，并想节省时间，则可以直接在官方的后台

注册一个账号，然后将sdk潜入到自己的测试应用中看效果，如 

 
 package main 
 
 import ( 
 
"log" 
 
"time" 
 
"github.com/getsentry/sentry-go" 
 
) 
 
 func  main  { 
 
err := sentry.Init(sentry.ClientOptions{ 
 
// Either set your DSN here or set the SENTRY_DSN environment variable. 
 
Dsn: "",//这里需要替换为您自己的Dsn 
 
// Enable printing of SDK debug messages. 
 
// Useful when getting started or trying to figure something out. 
 
Debug:  true , 
 
}) 
 
 if err != nil { 
 
log.Fatalf("sentry.Init: %s", err) 
 
} 
 
// Flush buffered events before the program terminates. 
 
// Set the timeout to the maximum duration the program can afford to wait. 
 
 defer sentry.Flush( * time.Second) 
 
//sentry.CaptureException("自定义运行时错误1") 
 
sentry.CaptureMessage("自定义error") 
 
}

效果如下

相关文章