diff --git a/pkg/srv/grpc/grpc.go b/pkg/srv/grpc/grpc.go index 25637cf..8243237 100644 --- a/pkg/srv/grpc/grpc.go +++ b/pkg/srv/grpc/grpc.go @@ -31,8 +31,9 @@ type appGRPCServer struct { doneChan chan error } -// Returns a shutdown func, a channel indicating done / error, -// and an up-front error if server fails to start +// InitGRPCServer initializes and starts a gRPC server. +// It returns a shutdown function, a channel to signal completion or error, +// and an error if the server fails to start. func InitGRPCServer(ctx context.Context, opts *opts.GRPCOpts) ( func(context.Context) error, <-chan error, error, ) { diff --git a/pkg/srv/grpc/logger.go b/pkg/srv/grpc/logger.go index ef9d304..07103f2 100644 --- a/pkg/srv/grpc/logger.go +++ b/pkg/srv/grpc/logger.go @@ -8,19 +8,19 @@ import ( "github.com/rs/zerolog/log" ) -// A grpc logging middleware compatible logger +// GRPCLogger is a grpc logging middleware compatible logger // implementation using a zerolog logger, either from -// the global logger or a context logger +// the global logger or a context logger. type GRPCLogger struct { logger zerolog.Logger } -// Returns a grpcLogger using the global zerolog Logger +// NewGRPCLogger returns a grpcLogger using the global zerolog Logger. func NewGRPCLogger() *GRPCLogger { return &GRPCLogger{logger: log.Logger} } -// Returns a grpcLogger using the zerolog logger in the provided context +// NewGRPCContextLogger returns a grpcLogger using the zerolog logger in the provided context. func NewGRPCContextLogger(ctx context.Context) *GRPCLogger { logger := log.Ctx(ctx) return &GRPCLogger{logger: *logger}