Golang实时错误监控与性能追踪插件库sentry-go的使用

Sentry Go SDK简介

sentry-go是Sentry官方提供的Go语言客户端SDK，用于实时错误监控和性能追踪。它是raven-go包的下一代替代品。

安装

使用go get命令安装最新版本的sentry-go：

go get github.com/getsentry/sentry-go@latest

基本配置与使用

初始化Sentry

package main

import (
	"log"
	"github.com/getsentry/sentry-go"
)

func main() {
	// 初始化Sentry SDK
	err := sentry.Init(sentry.ClientOptions{
		Dsn: "your-dsn-here", // 替换为你的Sentry DSN
		// 设置环境
		Environment: "production",
		// 设置发布版本
		Release: "my-project@1.0.0",
		// 启用性能监控
		EnableTracing: true,
		// 设置采样率 (0.0 - 1.0)
		TracesSampleRate: 1.0,
	})
	
	if err != nil {
		log.Fatalf("sentry.Init: %s", err)
	}
	
	// 确保所有事件在程序退出前发送
	defer sentry.Flush(2 * time.Second)
	
	// 你的应用代码...
}

基本错误监控示例

package main

import (
	"errors"
	"log"
	"github.com/getsentry/sentry-go"
)

func main() {
	err := sentry.Init(sentry.ClientOptions{
		Dsn: "your-dsn-here",
	})
	if err != nil {
		log.Fatalf("sentry.Init: %s", err)
	}
	defer sentry.Flush(2 * time.Second)

	// 捕获普通错误
	sentry.CaptureException(errors.New("something went wrong"))

	// 捕获带额外信息的错误
	eventID := sentry.CaptureException(errors.New("something went wrong with context"))
	log.Printf("Event ID: %s", eventID)

	// 手动发送消息
	sentry.CaptureMessage("This is a test message")
}

HTTP服务器监控示例

package main

import (
	"fmt"
	"net/http"
	"time"
	
	"github.com/getsentry/sentry-go"
	sentryhttp "github.com/getsentry/sentry-go/http"
)

func main() {
	// 初始化Sentry
	err := sentry.Init(sentry.ClientOptions{
		Dsn: "your-dsn-here",
		EnableTracing: true,
		TracesSampleRate: 1.0,
	})
	if err != nil {
		panic(err)
	}
	defer sentry.Flush(2 * time.Second)

	// 创建Sentry HTTP中间件
	sentryHandler := sentryhttp.New(sentryhttp.Options{})

	// 创建HTTP处理程序
	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		// 从请求上下文中获取span
		span := sentry.TransactionFromContext(r.Context())
		if span != nil {
			defer span.Finish()
		}

		// 模拟业务逻辑
		_, err := fmt.Fprintf(w, "Hello, World!")
		if err != nil {
			sentry.CaptureException(err)
			http.Error(w, "Internal Server Error", http.StatusInternalServerError)
			return
		}
	})

	// 使用Sentry中间件包装处理程序
	http.Handle("/", sentryHandler.Handle(handler))

	// 启动服务器
	fmt.Println("Server listening on port 3000")
	http.ListenAndServe(":3000", nil)
}

性能追踪

package main

import (
	"context"
	"time"
	
	"github.com/getsentry/sentry-go"
)

func performTask(ctx context.Context) {
	// 创建子span
	span := sentry.StartSpan(ctx, "task", sentry.WithTransactionName("Perform Task"))
	defer span.Finish()

	// 模拟工作
	time.Sleep(100 * time.Millisecond)
	
	// 记录额外数据
	span.SetTag("task.type", "background")
	span.SetData("attempt", 1)
}

func main() {
	err := sentry.Init(sentry.ClientOptions{
		Dsn: "your-dsn-here",
		EnableTracing: true,
		TracesSampleRate: 1.0,
	})
	if err != nil {
		panic(err)
	}
	defer sentry.Flush(2 * time.Second)

	// 创建事务
	ctx := context.Background()
	transaction := sentry.StartTransaction(ctx, "main")
	defer transaction.Finish()

	// 将事务放入上下文
	ctx = transaction.Context()

	// 执行任务
	performTask(ctx)
}

支持的框架

sentry-go支持多种流行的Go框架，包括：

• net/http
• echo
• fasthttp
• fiber
• gin
• iris
• logrus
• negroni
• slog
• zerolog

资源

• 官方文档
• API参考
• GitHub仓库

注意事项

1. 确保在生产环境中设置合理的TracesSampleRate值，通常小于1.0
2. 使用defer sentry.Flush()确保所有事件在程序退出前发送
3. 可以通过环境变量SENTRY_DSN、SENTRY_RELEASE和SENTRY_ENVIRONMENT配置SDK