Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add panic propagation option to gin middleware #1314

Merged
merged 1 commit into from
Sep 20, 2022
Merged

feat: add panic propagation option to gin middleware #1314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions module/apmgin/middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ func init() {
// Use WithTracer to specify an alternative tracer.
func Middleware(engine *gin.Engine, o ...Option) gin.HandlerFunc {
m := &middleware{
engine: engine,
tracer: apm.DefaultTracer(),
engine: engine,
tracer: apm.DefaultTracer(),
panicPropagation: false,
}
for _, o := range o {
o(m)
Expand All @@ -57,9 +58,10 @@ func Middleware(engine *gin.Engine, o ...Option) gin.HandlerFunc {
}

type middleware struct {
engine *gin.Engine
tracer *apm.Tracer
requestIgnorer apmhttp.RequestIgnorerFunc
engine *gin.Engine
tracer *apm.Tracer
requestIgnorer apmhttp.RequestIgnorerFunc
panicPropagation bool
}

func (m *middleware) handle(c *gin.Context) {
Expand All @@ -75,17 +77,20 @@ func (m *middleware) handle(c *gin.Context) {

defer func() {
if v := recover(); v != nil {
if !c.Writer.Written() {
c.AbortWithStatus(http.StatusInternalServerError)
if m.panicPropagation {
defer panic(v)
} else {
c.Abort()
if !c.Writer.Written() {
c.AbortWithStatus(http.StatusInternalServerError)
} else {
c.Abort()
}
}
e := m.tracer.Recovered(v)
e.SetTransaction(tx)
setContext(&e.Context, c, body)
e.Send()
}
c.Writer.WriteHeaderNow()
tx.Result = apmhttp.StatusCodeResult(c.Writer.Status())

if tx.Sampled() {
Expand Down Expand Up @@ -144,3 +149,12 @@ func WithRequestIgnorer(r apmhttp.RequestIgnorerFunc) Option {
m.requestIgnorer = r
}
}

// WithPanicPropagation returns an Option which enable panic propagation.
// Any panic will be recovered and recorded as an error in a transaction, then
// panic will be caused again.
func WithPanicPropagation() Option {
return func(m *middleware) {
m.panicPropagation = true
}
}
19 changes: 19 additions & 0 deletions module/apmgin/middleware_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,25 @@ func TestMiddlewarePanicHeadersSent(t *testing.T) {
assert.NotContains(t, debugOutput.String(), "[WARNING] Headers were already written")
}

func TestMiddlewarePanicPropagation(t *testing.T) {
debugOutput.Reset()
tracer, transport := transporttest.NewRecorderTracer()
defer tracer.Close()

e := gin.New()
e.Use(
gin.CustomRecovery(func(c *gin.Context, err interface{}) {
c.AbortWithStatus(http.StatusNotImplemented)
}),
apmgin.Middleware(e, apmgin.WithTracer(tracer), apmgin.WithPanicPropagation()))
e.GET("/panic", handlePanic)

w := doRequest(e, "GET", "http://server.testing/panic")
assert.Equal(t, http.StatusNotImplemented, w.Code)
tracer.Flush(nil)
assertError(t, transport.Payloads(), "handlePanic", "boom", false)
}

func TestMiddlewareError(t *testing.T) {
debugOutput.Reset()
tracer, transport := transporttest.NewRecorderTracer()
Expand Down