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.

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: handle panic #254

Merged
merged 3 commits into from
Dec 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 18 additions & 1 deletion cmd/goflow2/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import (
// core libraries
"github.com/netsampler/goflow2/v2/metrics"
"github.com/netsampler/goflow2/v2/utils"
"github.com/netsampler/goflow2/v2/utils/debug"

"github.com/prometheus/client_golang/prometheus/promhttp"
log "github.com/sirupsen/logrus"
Expand Down Expand Up @@ -128,6 +129,8 @@ func main() {
log.Fatalf("producer %s does not exist", *Produce)
}

// intercept panic and generate an error
flowProducer = debug.WrapPanicProducer(flowProducer)
// wrap producer with Prometheus metrics
flowProducer = metrics.WrapPromProducer(flowProducer)

Expand Down Expand Up @@ -273,7 +276,12 @@ func main() {
l.Errorf("scheme %s does not exist", listenAddrUrl.Scheme)
return
}
decodeFunc = metrics.PromDecoderWrapper(p.DecodeFlow, listenAddrUrl.Scheme)

decodeFunc = p.DecodeFlow
// intercept panic and generate error
decodeFunc = debug.PanicDecoderWrapper(decodeFunc)
// wrap decoder with Prometheus metrics
decodeFunc = metrics.PromDecoderWrapper(decodeFunc, listenAddrUrl.Scheme)
pipes = append(pipes, p)

// starts receivers
Expand All @@ -293,6 +301,15 @@ func main() {
l := l.WithError(err)
if errors.Is(err, netflow.ErrorTemplateNotFound) {
l.Warn("template error")
} else if errors.Is(err, debug.PanicError) {
var pErrMsg *debug.PanicErrorMessage
if errors.As(err, &pErrMsg) {
l = l.WithFields(log.Fields{
"message": pErrMsg.Msg,
"stacktrace": string(pErrMsg.Stacktrace),
})
}
l.Error("intercepted panic")
} else if errors.Is(err, net.ErrClosed) {
l.Info("closed receiver")
} else {
Expand Down
23 changes: 23 additions & 0 deletions utils/debug/debug.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package debug

import (
"fmt"
)

var (
PanicError = fmt.Errorf("panic")
)

type PanicErrorMessage struct {
Msg interface{}
Inner string
Stacktrace []byte
}

func (e *PanicErrorMessage) Error() string {
return fmt.Sprintf("%s", e.Inner)
}

func (e *PanicErrorMessage) Unwrap() []error {
return []error{PanicError}
}
22 changes: 22 additions & 0 deletions utils/debug/decoder.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package debug

import (
"runtime/debug"

"github.com/netsampler/goflow2/v2/utils"
)

func PanicDecoderWrapper(wrapped utils.DecoderFunc) utils.DecoderFunc {
return func(msg interface{}) (err error) {

defer func() {
if pErr := recover(); pErr != nil {

pErrC, _ := pErr.(string)
err = &PanicErrorMessage{Msg: msg, Inner: pErrC, Stacktrace: debug.Stack()}
}
}()
err = wrapped(msg)
return err
}
}
39 changes: 39 additions & 0 deletions utils/debug/producer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package debug

import (
"runtime/debug"

"github.com/netsampler/goflow2/v2/producer"
)

type PanicProducerWrapper struct {
wrapped producer.ProducerInterface
}

func (p *PanicProducerWrapper) Produce(msg interface{}, args *producer.ProduceArgs) (flowMessageSet []producer.ProducerMessage, err error) {

defer func() {
if pErr := recover(); pErr != nil {

pErrC, _ := pErr.(string)
err = &PanicErrorMessage{Msg: msg, Inner: pErrC, Stacktrace: debug.Stack()}
}
}()

flowMessageSet, err = p.wrapped.Produce(msg, args)
return flowMessageSet, err
}

func (p *PanicProducerWrapper) Close() {
p.wrapped.Close()
}

func (p *PanicProducerWrapper) Commit(flowMessageSet []producer.ProducerMessage) {
p.wrapped.Commit(flowMessageSet)
}

func WrapPanicProducer(wrapped producer.ProducerInterface) producer.ProducerInterface {
return &PanicProducerWrapper{
wrapped: wrapped,
}
}
Loading