interceptors

Documentation

Overview

interceptor is an internal package used by higher level middlewares. It allows injecting custom code in various places of the gRPC lifecycle.

This particular package is intended for use by other middleware, metric, logging or otherwise. This allows code to be shared between different implementations.

Index

• Variables
• func SplitMethodName(fullMethod string) (string, string)
• func StreamClientInterceptor(reportable ClientReportable) grpc.StreamClientInterceptor
• func StreamServerInterceptor(reportable ServerReportable) grpc.StreamServerInterceptor
• func UnaryClientInterceptor(reportable ClientReportable) grpc.UnaryClientInterceptor
• func UnaryServerInterceptor(reportable ServerReportable) grpc.UnaryServerInterceptor
• type CallMeta
  • func (c CallMeta) FullMethod() string
• type ClientReportable
• type CommonReportableFunc
  • func (f CommonReportableFunc) ClientReporter(ctx context.Context, c CallMeta) (Reporter, context.Context)
  • func (f CommonReportableFunc) ServerReporter(ctx context.Context, c CallMeta) (Reporter, context.Context)
• type GRPCType
  • func StreamRPCType(info *grpc.StreamServerInfo) GRPCType
• type NoopReporter
  • func (NoopReporter) PostCall(error, time.Duration)
  • func (NoopReporter) PostMsgReceive(interface{}, error, time.Duration)
  • func (NoopReporter) PostMsgSend(interface{}, error, time.Duration)
• type Reporter
• type ServerReportable
• type Timer

Variables

var (
	AllCodes = []codes.Code{
		codes.OK, codes.Canceled, codes.Unknown, codes.InvalidArgument, codes.DeadlineExceeded, codes.NotFound,
		codes.AlreadyExists, codes.PermissionDenied, codes.Unauthenticated, codes.ResourceExhausted,
		codes.FailedPrecondition, codes.Aborted, codes.OutOfRange, codes.Unimplemented, codes.Internal,
		codes.Unavailable, codes.DataLoss,
	}
)

var EmptyTimer = &zeroTimer{}

Functions

func SplitMethodName

func SplitMethodName(fullMethod string) (string, string)

func StreamClientInterceptor

func StreamClientInterceptor(reportable ClientReportable) grpc.StreamClientInterceptor

StreamClientInterceptor is a gRPC client-side interceptor that provides reporting for Stream RPCs.

func StreamServerInterceptor

func StreamServerInterceptor(reportable ServerReportable) grpc.StreamServerInterceptor

StreamServerInterceptor is a gRPC server-side interceptor that provides reporting for Streaming RPCs.

func UnaryClientInterceptor

func UnaryClientInterceptor(reportable ClientReportable) grpc.UnaryClientInterceptor

UnaryClientInterceptor is a gRPC client-side interceptor that provides reporting for Unary RPCs.

func UnaryServerInterceptor

func UnaryServerInterceptor(reportable ServerReportable) grpc.UnaryServerInterceptor

UnaryServerInterceptor is a gRPC server-side interceptor that provides reporting for Unary RPCs.

Types

type CallMeta

type CallMeta struct {
	ReqProtoOrNil interface{}
	Typ           GRPCType
	Service       string
	Method        string
}

func (CallMeta) FullMethod

func (c CallMeta) FullMethod() string

type ClientReportable

type ClientReportable interface {
	ClientReporter(context.Context, CallMeta) (Reporter, context.Context)
}

type CommonReportableFunc

type CommonReportableFunc func(ctx context.Context, c CallMeta, isClient bool) (Reporter, context.Context)

CommonReportableFunc helper allows an easy way to implement reporter with common client and server logic.

func (CommonReportableFunc) ClientReporter

func (f CommonReportableFunc) ClientReporter(ctx context.Context, c CallMeta) (Reporter, context.Context)

func (CommonReportableFunc) ServerReporter

func (f CommonReportableFunc) ServerReporter(ctx context.Context, c CallMeta) (Reporter, context.Context)

type GRPCType

type GRPCType string

const (
	Unary        GRPCType = "unary"
	ClientStream GRPCType = "client_stream"
	ServerStream GRPCType = "server_stream"
	BidiStream   GRPCType = "bidi_stream"
)

func StreamRPCType

func StreamRPCType(info *grpc.StreamServerInfo) GRPCType

type NoopReporter

type NoopReporter struct{}

func (NoopReporter) PostCall

func (NoopReporter) PostCall(error, time.Duration)

func (NoopReporter) PostMsgReceive

func (NoopReporter) PostMsgReceive(interface{}, error, time.Duration)

func (NoopReporter) PostMsgSend

func (NoopReporter) PostMsgSend(interface{}, error, time.Duration)

type Reporter

type Reporter interface {
	PostCall(err error, rpcDuration time.Duration)
	PostMsgSend(reqProto interface{}, err error, sendDuration time.Duration)
	PostMsgReceive(replyProto interface{}, err error, recvDuration time.Duration)
}

type ServerReportable

type ServerReportable interface {
	ServerReporter(context.Context, CallMeta) (Reporter, context.Context)
}

type Timer

type Timer interface {
	ObserveDuration() time.Duration
}

Timer is a helper interface to time functions. Useful for interceptors to record the total time elapsed since completion of a call.