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

Panic Recovery Interceptors #96

Merged
merged 5 commits into from
Jun 15, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 4 additions & 0 deletions cmd/rvasp/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,10 @@ func initdb(c *cli.Context) (err error) {
conf.Database.DSN = dsn
}

if conf.Database.DSN == "" {
return cli.NewExitError("rvasp database dsn required", 1)
}

if fixtures := c.String("fixtures"); fixtures != "" {
conf.FixturesPath = fixtures
}
Expand Down
72 changes: 72 additions & 0 deletions pkg/rvasp/interceptor.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
package rvasp

import (
"context"
"fmt"
"runtime/debug"
"time"

"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)

// This unary interceptor traces gRPC requests, adds zerolog logging and panic recovery.
func UnaryTraceInterceptor(ctx context.Context, in interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (out interface{}, err error) {
// Track how long the method takes to execute.
start := time.Now()
panicked := true

// Recover from panics in the handler.
defer func() {
if r := recover(); r != nil || panicked {
log.WithLevel(zerolog.PanicLevel).
Err(fmt.Errorf("%v", r)).
Str("stack_trace", string(debug.Stack())).
Msg("grpc server has recovered from a panic")
err = status.Error(codes.Internal, "an unhandled exception occurred")
}
}()

// Call the handler to finalize the request and get the response.
out, err = handler(ctx, in)
panicked = false

// Log with zerolog - checkout grpclog.LoggerV2 for default logging.
log.Debug().
Err(err).
Str("method", info.FullMethod).
Str("latency", time.Since(start).String()).
Msg("gRPC request complete")
return out, err
}

// This streaming interceptor traces gRPC requests, adds zerolog logging and panic recovery.
func StreamTraceInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) (err error) {
// Track how long the method takes to execute.
start := time.Now()
panicked := true

defer func() {
if r := recover(); r != nil || panicked {
log.WithLevel(zerolog.PanicLevel).
Err(fmt.Errorf("%v", r)).
Str("stack_trace", string(debug.Stack())).
Msg("grpc server has recovered from a panic")
err = status.Error(codes.Internal, "an unhandled exception occurred")
}
}()

err = handler(srv, stream)
panicked = false

// Log with zerolog - checkout grpclog.LoggerV2 for default logging.
log.Debug().
Err(err).
Str("method", info.FullMethod).
Str("duration", time.Since(start).String()).
Msg("gRPC stream closed")
return err
}
4 changes: 2 additions & 2 deletions pkg/rvasp/rvasp.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ type Server struct {

// Serve GRPC requests on the specified address.
func (s *Server) Serve() (err error) {
// Initialize the gRPC server
s.srv = grpc.NewServer()
// Initialize the gRPC server with panic recovery and tracing
s.srv = grpc.NewServer(grpc.UnaryInterceptor(UnaryTraceInterceptor), grpc.StreamInterceptor(StreamTraceInterceptor))
pb.RegisterTRISADemoServer(s.srv, s)
pb.RegisterTRISAIntegrationServer(s.srv, s)

Expand Down
3 changes: 2 additions & 1 deletion pkg/rvasp/trisa.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ func (s *TRISA) Serve() (err error) {
return err
}

s.srv = grpc.NewServer(creds)
// Create a new gRPC server with panic recovery and tracing middleware
s.srv = grpc.NewServer(creds, grpc.UnaryInterceptor(UnaryTraceInterceptor), grpc.StreamInterceptor(StreamTraceInterceptor))
protocol.RegisterTRISANetworkServer(s.srv, s)
protocol.RegisterTRISAHealthServer(s.srv, s)

Expand Down