interceptors

package

v2.0.3 Latest Latest Go to latest Published: Apr 19, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

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 FullMethod(service, method string) string
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 ClientReportable
type GRPCType
- func StreamRPCType(info *grpc.StreamServerInfo) GRPCType
type NoopReporter
type Reporter
type ServerReportable
type Timer

Constants ¶

This section is empty.

Variables ¶

View Source

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,
	}
)

View Source

var EmptyTimer = &zeroTimer{}

Functions ¶

func FullMethod ¶

func FullMethod(service, method string) string

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 ClientReportable ¶

type ClientReportable interface {
	ClientReporter(ctx context.Context, reqProtoOrNil interface{}, typ GRPCType, service string, method string) (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(ctx context.Context, reqProtoOrNil interface{}, typ GRPCType, service string, method string) (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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
auth `auth` a generic server-side auth middleware for gRPC.	`auth` a generic server-side auth middleware for gRPC.
logging logging is a "parent" package for gRPC logging middlewares.	logging is a "parent" package for gRPC logging middlewares.
ratelimit `ratelimit` a generic server-side ratelimit middleware for gRPC.	`ratelimit` a generic server-side ratelimit middleware for gRPC.
recovery `recovery` are interceptors that recover from gRPC handler panics.	`recovery` are interceptors that recover from gRPC handler panics.
retry `retry` provides client-side request retry logic for gRPC.	`retry` provides client-side request retry logic for gRPC.
skip `skip` allow users to skip interceptors in certain condition.	`skip` allow users to skip interceptors in certain condition.
tags `tags` adds a Tag object to the context that can be used by other middleware to add context about a request.	`tags` adds a Tag object to the context that can be used by other middleware to add context about a request.
timeout `grpc_timeout` are interceptors that timeout for gRPC client calls.	`grpc_timeout` are interceptors that timeout for gRPC client calls.
tracing tracing is a "parent" package for gRPC logging middlewares.	tracing is a "parent" package for gRPC logging middlewares.
validator `validator` is a generic request contents validator server-side middleware for gRPC.	`validator` is a generic request contents validator server-side middleware for gRPC.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL