grpctools

README

grpctools

Little helpers for grpc

Testing

Simply run:

make

Documentation

Index

• Variables
• func Dial(target string, opts *DialOptions, extra ...grpc.DialOption) (*grpc.ClientConn, error)
• func DialContext(ctx context.Context, target string, opts *DialOptions, ...) (*grpc.ClientConn, error)
• func HTTPStatus(c codes.Code) int
• func HTTPStatusFromError(err error) int
• func SetLogger(logger grpclog.LoggerV2)
• type DialOptions
• type Instrumenter
  • func NewInstrumenter(metric string) *Instrumenter
  • func (i *Instrumenter) StreamServerInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, ...) error
  • func (i *Instrumenter) UnaryServerInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (interface{}, error)
• type Options
• type Server
  • func NewServer(name string, addr string, opts *Options, extra ...grpc.ServerOption) *Server
  • func (s *Server) ListenAndServe() error
• type VErrors
  • func VErrorsConvert(err error) VErrors
  • func VErrorsFromStatus(sts *status.Status) VErrors
  • func (e VErrors) Append(field, message string) VErrors
  • func (e VErrors) InvalidArgument(message string) *status.Status
  • func (e VErrors) Len() int
  • func (e VErrors) Messages() []string
  • func (e VErrors) Reset() VErrors
  • func (e VErrors) Status(code codes.Code, message string) *status.Status

Variables

var DefaultInstrumenter = NewInstrumenter("rpc.request")

DefaultInstrumenter instruments via "rpc.request" metric

Functions

func Dial

func Dial(target string, opts *DialOptions, extra ...grpc.DialOption) (*grpc.ClientConn, error)

Dial creates a client connection.

func DialContext

func DialContext(ctx context.Context, target string, opts *DialOptions, extra ...grpc.DialOption) (*grpc.ClientConn, error)

DialContext creates a client connection with specified context.

func HTTPStatus

func HTTPStatus(c codes.Code) int

HTTPStatus returns a http stats from a grpc error code

func HTTPStatusFromError

func HTTPStatusFromError(err error) int

HTTPStatusFromError returns a http stats from a grpc error code

func SetLogger

func SetLogger(logger grpclog.LoggerV2)

SetLogger is a proxy to grpclog.SetLogger

Types

type DialOptions

type DialOptions struct {
	// Enables transport security.
	SkipInsecure bool

	// Makes Dial non-blocking (Dial won't wait for connection to be up before returning).
	SkipBlock bool

	// Unary client interceptors.
	UnaryInterceptors []grpc.UnaryClientInterceptor

	// Stream client interceptors.
	StreamInterceptors []grpc.StreamClientInterceptor
}

DialOptions represent dial options.

type Instrumenter

type Instrumenter struct {
	// contains filtered or unexported fields
}

Instrumenter instances instrument RPC requests via interceptors.

func NewInstrumenter

func NewInstrumenter(metric string) *Instrumenter

NewInstrumenter inits a new instrumenter with a metric

func (*Instrumenter) StreamServerInterceptor

func (i *Instrumenter) StreamServerInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error

StreamServerInterceptor implements an grpc.StreamServerInterceptor

func (*Instrumenter) UnaryServerInterceptor

func (i *Instrumenter) UnaryServerInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error)

UnaryServerInterceptor implements an grpc.UnaryServerInterceptor

type Options

type Options struct {
	MaxConcurrentStreams uint32
	SkipInstrumentation  bool

	UnaryInterceptors  []grpc.UnaryServerInterceptor
	StreamInterceptors []grpc.StreamServerInterceptor
}

Options represent server options

type Server

type Server struct {
	*grpc.Server
	// contains filtered or unexported fields
}

Server embeds a standard grpc Server with a healthcheck

func NewServer

func NewServer(name string, addr string, opts *Options, extra ...grpc.ServerOption) *Server

NewServer returns a new Server instance.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe starts the server (blocking).

type VErrors

type VErrors []*errdetails.BadRequest_FieldViolation

VErrors contains a set of field-violations.

func VErrorsConvert

func VErrorsConvert(err error) VErrors

VErrorsConvert extracts validation errors from an error. This function will return nil if no validation errors are attached.

func VErrorsFromStatus

func VErrorsFromStatus(sts *status.Status) VErrors

VErrorsFromStatus extracts validation errors from status.

func (VErrors) Append

func (e VErrors) Append(field, message string) VErrors

Append appends a field message.

func (VErrors) InvalidArgument

func (e VErrors) InvalidArgument(message string) *status.Status

InvalidArgument returns an InvalidArgument status.

func (VErrors) Len

func (e VErrors) Len() int

Len returns the error count.

func (VErrors) Messages

func (e VErrors) Messages() []string

Messages returns messages.

func (VErrors) Reset

func (e VErrors) Reset() VErrors

Reset resets the slice.

func (VErrors) Status

func (e VErrors) Status(code codes.Code, message string) *status.Status

Status returns a custom status.