interceptor

package
v1.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 6, 2024 License: MIT Imports: 23 Imported by: 17

README

interceptor

Commonly used grpc client-side and server-side interceptors.


Example of use

import "github.com/zhufuyi/sponge/pkg/grpc/interceptor"
logging

grpc server-side

// set unary server logging
func getServerOptions() []grpc.ServerOption {
	var options []grpc.ServerOption
	
	options = append(options, grpc_middleware.WithUnaryServerChain(
		// if you don't want to log reply data, you can use interceptor.StreamServerSimpleLog instead of interceptor.UnaryServerLog,
		interceptor.UnaryServerLog(
			logger.Get(),
			interceptor.WithReplaceGRPCLogger(),
			//interceptor.WithMarshalFn(fn), // customised marshal function, default is jsonpb.Marshal
			//interceptor.WithLogIgnoreMethods(fullMethodNames), // ignore methods logging
			//interceptor.WithMaxLen(400), // logging max length, default 300
		),
	))

	return options
}


// you can also set stream server logging

grpc client-side

// set unary client logging
func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			interceptor.UnaryClientLog(logger.Get()),
			interceptor.WithReplaceGRPCLogger(),
		),
	)
	options = append(options, option)

	return options
}

// you can also set stream client logging

recovery

grpc server-side

func getServerOptions() []grpc.ServerOption {
	var options []grpc.ServerOption

	recoveryOption := grpc_middleware.WithUnaryServerChain(
		interceptor.UnaryServerRecovery(),
	)
	options = append(options, recoveryOption)

	return options
}

grpc client-side

func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			interceptor.UnaryClientRecovery(),
		),
	)
	options = append(options, option)

	return options
}

retry

grpc client-side

func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	// use insecure transfer
	options = append(options, grpc.WithTransportCredentials(insecure.NewCredentials()))

	// retry
	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			interceptor.UnaryClientRetry(
				//middleware.WithRetryTimes(5), // modify the default number of retries to 3 by default
				//middleware.WithRetryInterval(100*time.Millisecond), // modify the default retry interval, default 50 milliseconds
				//middleware.WithRetryErrCodes(), // add trigger retry error code, default is codes.Internal, codes.DeadlineExceeded, codes.Unavailable
			),
		),
	)
	options = append(options, option)

	return options
}

rate limiter

grpc server-side

func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	// use insecure transfer
	options = append(options, grpc.WithTransportCredentials(insecure.NewCredentials()))

	// rate limiter
	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			interceptor.UnaryRateLimit(
				//interceptor.WithWindow(time.Second*5),
				//interceptor.WithBucket(200),
				//interceptor.WithCPUThreshold(600),
				//interceptor.WithCPUQuota(0), 
			),
		),
	)
	options = append(options, option)

	return options
}

Circuit Breaker

grpc server-side

func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	// use insecure transfer
	options = append(options, grpc.WithTransportCredentials(insecure.NewCredentials()))

	// circuit breaker
	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			interceptor.UnaryClientCircuitBreaker(
				//interceptor.WithValidCode(codes.DeadlineExceeded), // add error code 4 for circuit breaker
				//interceptor.WithUnaryServerDegradeHandler(handler), // add custom degrade handler
			),
		),
	)
	options = append(options, option)

	return options
}

timeout

grpc client-side

func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	// use insecure transfer
	options = append(options, grpc.WithTransportCredentials(insecure.NewCredentials()))

	// timeout
	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			middleware.ContextTimeout(time.Second), // set timeout
		),
	)
	options = append(options, option)

	return options
}

tracing

grpc server-side

// initialize tracing
func InitTrace(serviceName string) {
	exporter, err := tracer.NewJaegerAgentExporter("192.168.3.37", "6831")
	if err != nil {
		panic(err)
	}

	resource := tracer.NewResource(
		tracer.WithServiceName(serviceName),
		tracer.WithEnvironment("dev"),
		tracer.WithServiceVersion("demo"),
	)

	tracer.Init(exporter, resource) // collect all by default
}

// set up trace on the client side
func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	// use insecure transfer
	options = append(options, grpc.WithTransportCredentials(insecure.NewCredentials()))

	// use tracing
	options = append(options, grpc.WithUnaryInterceptor(
		interceptor.UnaryClientTracing(),
	))

	return options
}

// set up trace on the server side
func getServerOptions() []grpc.ServerOption {
	var options []grpc.ServerOption

	// use tracing
	options = append(options, grpc.UnaryInterceptor(
		interceptor.UnaryServerTracing(),
	))

	return options
}

// if necessary, you can create a span in the program
func SpanDemo(serviceName string, spanName string, ctx context.Context) {
	_, span := otel.Tracer(serviceName).Start(
		ctx, spanName,
		trace.WithAttributes(attribute.String(spanName, time.Now().String())), // customised attributes
	)
	defer span.End()

	// ......
}

metrics

example metrics.


Request id

grpc server-side

func getServerOptions() []grpc.ServerOption {
	var options []grpc.ServerOption

	recoveryOption := grpc_middleware.WithUnaryServerChain(
		interceptor.UnaryServerRequestID(),
	)
	options = append(options, recoveryOption)

	return options
}

grpc client-side

func getDialOptions() []grpc.DialOption {
	var options []grpc.DialOption

	// use insecure transfer
	options = append(options, grpc.WithTransportCredentials(insecure.NewCredentials()))

	option := grpc.WithUnaryInterceptor(
		grpc_middleware.ChainUnaryClient(
			interceptor.UnaryClientRequestID(),
		),
	)
	options = append(options, option)

	return options
}

jwt authentication

grpc client-side

package main

import (
	"context"
	"github.com/zhufuyi/sponge/pkg/jwt"
	"github.com/zhufuyi/sponge/pkg/grpc/interceptor"
	"github.com/zhufuyi/sponge/pkg/grpc/grpccli"
	userV1 "user/api/user/v1"
)

func main() {
	ctx := context.Background()
	conn, _ := grpccli.Dial(ctx, "127.0.0.1:8282")
	cli := userV1.NewUserClient(conn)

	token := "xxxxxx"
	ctx = interceptor.SetJwtTokenToCtx(ctx, token)

	req := &userV1.GetUserByIDRequest{Id: 100}
	cli.GetByID(ctx, req)
}

grpc server-side

package main

import (
	"context"
	"net"
	"github.com/zhufuyi/sponge/pkg/jwt"
	"github.com/zhufuyi/sponge/pkg/grpc/interceptor"
	"google.golang.org/grpc"
	userV1 "user/api/user/v1"
)

func standardVerifyFn(claims *jwt.Claims, tokenTail32 string) error {
	// you can check the claims and tokenTail32, and return an error if necessary
	// see example in jwtAuth_test.go line 23

	return nil
}

func customVerifyFn(claims *jwt.CustomClaims, tokenTail32 string) error {
	// you can check the claims and tokenTail32, and return an error if necessary
	// see example in jwtAuth_test.go line 34

	return nil
}

func getUnaryServerOptions() []grpc.ServerOption {
	var options []grpc.ServerOption

	// other interceptors ...

	options = append(options, grpc.UnaryInterceptor(
	    // jwt authorization interceptor
	    interceptor.UnaryServerJwtAuth(
			// // choose a verification method as needed
			//interceptor.WithStandardVerify(standardVerifyFn), // standard verify (default), standardVerifyFn is not mandatory, you can set nil if you don't need it
			//interceptor.WithCustomVerify(customVerifyFn), // custom verify

	        // specify the grpc API to ignore token verification(full path)
	        interceptor.WithAuthIgnoreMethods(
	            "/api.user.v1.User/Register",
	            "/api.user.v1.User/Login",
	        ),
	    ),
	))

	return options
}


type user struct {
	userV1.UnimplementedUserServer
}

// Login ...
func (s *user) Login(ctx context.Context, req *userV1.LoginRequest) (*userV1.LoginReply, error) {
	// check user and password success

	uid := 100
	name := "tom"
	token, err := jwt.GenerateToken(uid, name)

	return &userV1.LoginReply{Token: token},nil
}

// GetByID ...
func (s *user) GetByID(ctx context.Context, req *userV1.GetUserByIDRequest) (*userV1.GetUserByIDReply, error) {
	// if token is valid, won't get here, because the interceptor has returned an error message 

	// if you want get jwt claims, you can use the following code
	claims, err := interceptor.GetJwtClaims(ctx)

	return &userV1.GetUserByIDReply{},nil
}

func main()  {
	list, err := net.Listen("tcp", ":8282")
	server := grpc.NewServer(getUnaryServerOptions()...)
	userV1.RegisterUserServer(server, &user{})
	server.Serve(list)
	select{}
}

Documentation

Overview

Package interceptor provides commonly used grpc client-side and server-side interceptors.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextRequestIDKey request id key for context
	ContextRequestIDKey = "request_id"
)
View Source 
var ErrLimitExceed = rl.ErrLimitExceed

ErrLimitExceed is returned when the rate limiter is triggered and the request is rejected due to limit exceeded.

View Source 
var ErrNotAllowed = circuitbreaker.ErrNotAllowed

ErrNotAllowed error not allowed.

View Source 
var RequestIDKey = CtxKeyString(ContextRequestIDKey)

RequestIDKey request_id

Functions

func ClientCtxRequestID added in v1.3.2 

func ClientCtxRequestID(ctx context.Context) string

ClientCtxRequestID get request id from rpc client context.Context

func ClientCtxRequestIDField added in v1.3.2 

func ClientCtxRequestIDField(ctx context.Context) zap.Field

ClientCtxRequestIDField get request id field from rpc client context.Context

func ClientTokenOption added in v1.3.20 

func ClientTokenOption(appID string, appKey string, isSecure bool) grpc.DialOption

ClientTokenOption client token

func CtxRequestIDField added in v1.5.6 

func CtxRequestIDField(ctx context.Context) zap.Field

CtxRequestIDField get request id field from context.Context

func GetAuthCtxKey 

func GetAuthCtxKey() string

GetAuthCtxKey get the name of Claims

func GetAuthorization 

func GetAuthorization(token string) string

GetAuthorization combining tokens into authentication information

func GetJwtClaims added in v1.9.3 

func GetJwtClaims(ctx context.Context) (*jwt.Claims, bool)

GetJwtClaims get the jwt standard claims from context, contains fixed fields uid and name

func GetJwtCustomClaims added in v1.9.3 

func GetJwtCustomClaims(ctx context.Context) (*jwt.CustomClaims, bool)

GetJwtCustomClaims get the jwt custom claims from context, contains custom fields

func ServerCtxRequestID added in v1.3.2 

func ServerCtxRequestID(ctx context.Context) string

ServerCtxRequestID get request id from rpc server context.Context

func ServerCtxRequestIDField added in v1.3.2 

func ServerCtxRequestIDField(ctx context.Context) zap.Field

ServerCtxRequestIDField get request id field from rpc server context.Context

func SetAuthToCtx added in v1.9.3 

func SetAuthToCtx(ctx context.Context, authorization string) context.Context

SetAuthToCtx set the authorization (including prefix Bearer) to the context in grpc client side Example: 

ctx := SetAuthToCtx(ctx, authorization)
cli.GetByID(ctx, req)

func SetContextRequestIDKey added in v1.5.6 

func SetContextRequestIDKey(key string)

SetContextRequestIDKey set context request id key

func SetJwtTokenToCtx added in v1.4.3 

func SetJwtTokenToCtx(ctx context.Context, token string) context.Context

SetJwtTokenToCtx set the token (excluding prefix Bearer) to the context in grpc client side Example:

authorization := "Bearer jwt-token" 

ctx := SetJwtTokenToCtx(ctx, authorization)
cli.GetByID(ctx, req)

func StreamClientCircuitBreaker added in v1.3.20 

func StreamClientCircuitBreaker(opts ...CircuitBreakerOption) grpc.StreamClientInterceptor

StreamClientCircuitBreaker client-side stream circuit breaker interceptor

func StreamClientLog 

func StreamClientLog(logger *zap.Logger, opts ...LogOption) grpc.StreamClientInterceptor

StreamClientLog client log stream interceptor

func StreamClientMetrics 

func StreamClientMetrics() grpc.StreamClientInterceptor

StreamClientMetrics client-side metrics stream interceptor

func StreamClientRecovery added in v1.3.20 

func StreamClientRecovery() grpc.StreamClientInterceptor

StreamClientRecovery client-side recovery stream interceptor

func StreamClientRequestID added in v1.3.2 

func StreamClientRequestID() grpc.StreamClientInterceptor

StreamClientRequestID client request id stream interceptor

func StreamClientRetry 

func StreamClientRetry(opts ...RetryOption) grpc.StreamClientInterceptor

StreamClientRetry client-side retry stream interceptor

func StreamClientTimeout added in v1.2.0 

func StreamClientTimeout(d time.Duration) grpc.StreamClientInterceptor

StreamClientTimeout server-side timeout interceptor

func StreamClientTracing 

func StreamClientTracing() grpc.StreamClientInterceptor

StreamClientTracing client-side tracing stream interceptor

func StreamServerCircuitBreaker added in v1.3.20 

func StreamServerCircuitBreaker(opts ...CircuitBreakerOption) grpc.StreamServerInterceptor

StreamServerCircuitBreaker server-side stream circuit breaker interceptor

func StreamServerJwtAuth 

func StreamServerJwtAuth(opts ...AuthOption) grpc.StreamServerInterceptor

StreamServerJwtAuth jwt stream interceptor

func StreamServerLog 

func StreamServerLog(logger *zap.Logger, opts ...LogOption) grpc.StreamServerInterceptor

StreamServerLog Server-side log stream interceptor

func StreamServerMetrics 

func StreamServerMetrics(opts ...metrics.Option) grpc.StreamServerInterceptor

StreamServerMetrics server-side metrics stream interceptor

func StreamServerRateLimit 

func StreamServerRateLimit(opts ...RatelimitOption) grpc.StreamServerInterceptor

StreamServerRateLimit server-side stream circuit breaker interceptor

func StreamServerRecovery 

func StreamServerRecovery() grpc.StreamServerInterceptor

StreamServerRecovery recovery stream interceptor

func StreamServerRequestID added in v1.3.2 

func StreamServerRequestID() grpc.StreamServerInterceptor

StreamServerRequestID server-side request id stream interceptor

func StreamServerSimpleLog added in v1.8.0 

func StreamServerSimpleLog(logger *zap.Logger, opts ...LogOption) grpc.StreamServerInterceptor

StreamServerSimpleLog Server-side log stream interceptor, only print response

func StreamServerToken added in v1.3.20 

func StreamServerToken(f CheckToken) grpc.StreamServerInterceptor

StreamServerToken recovery stream token

func StreamServerTracing 

func StreamServerTracing() grpc.StreamServerInterceptor

StreamServerTracing server-side tracing stream interceptor

func UnaryClientCircuitBreaker 

func UnaryClientCircuitBreaker(opts ...CircuitBreakerOption) grpc.UnaryClientInterceptor

UnaryClientCircuitBreaker client-side unary circuit breaker interceptor

func UnaryClientLog 

func UnaryClientLog(logger *zap.Logger, opts ...LogOption) grpc.UnaryClientInterceptor

UnaryClientLog client log unary interceptor

func UnaryClientMetrics 

func UnaryClientMetrics() grpc.UnaryClientInterceptor

UnaryClientMetrics client-side metrics unary interceptor

func UnaryClientRecovery added in v1.3.20 

func UnaryClientRecovery() grpc.UnaryClientInterceptor

UnaryClientRecovery client-side unary recovery

func UnaryClientRequestID added in v1.3.2 

func UnaryClientRequestID() grpc.UnaryClientInterceptor

UnaryClientRequestID client-side request_id unary interceptor

func UnaryClientRetry 

func UnaryClientRetry(opts ...RetryOption) grpc.UnaryClientInterceptor

UnaryClientRetry client-side retry unary interceptor

func UnaryClientTimeout added in v1.2.0 

func UnaryClientTimeout(d time.Duration) grpc.UnaryClientInterceptor

UnaryClientTimeout client-side timeout unary interceptor

func UnaryClientTracing 

func UnaryClientTracing() grpc.UnaryClientInterceptor

UnaryClientTracing client-side tracing unary interceptor

func UnaryServerCircuitBreaker 

func UnaryServerCircuitBreaker(opts ...CircuitBreakerOption) grpc.UnaryServerInterceptor

UnaryServerCircuitBreaker server-side unary circuit breaker interceptor

func UnaryServerJwtAuth 

func UnaryServerJwtAuth(opts ...AuthOption) grpc.UnaryServerInterceptor

UnaryServerJwtAuth jwt unary interceptor

func UnaryServerLog 

func UnaryServerLog(logger *zap.Logger, opts ...LogOption) grpc.UnaryServerInterceptor

UnaryServerLog server-side log unary interceptor

func UnaryServerMetrics 

func UnaryServerMetrics(opts ...metrics.Option) grpc.UnaryServerInterceptor

UnaryServerMetrics server-side metrics unary interceptor

func UnaryServerRateLimit 

func UnaryServerRateLimit(opts ...RatelimitOption) grpc.UnaryServerInterceptor

UnaryServerRateLimit server-side unary circuit breaker interceptor

func UnaryServerRecovery 

func UnaryServerRecovery() grpc.UnaryServerInterceptor

UnaryServerRecovery recovery unary interceptor

func UnaryServerRequestID added in v1.3.2 

func UnaryServerRequestID() grpc.UnaryServerInterceptor

UnaryServerRequestID server-side request_id unary interceptor

func UnaryServerSimpleLog added in v1.8.0 

func UnaryServerSimpleLog(logger *zap.Logger, opts ...LogOption) grpc.UnaryServerInterceptor

UnaryServerSimpleLog server-side log unary interceptor, only print response

func UnaryServerToken added in v1.3.20 

func UnaryServerToken(f CheckToken) grpc.UnaryServerInterceptor

UnaryServerToken recovery unary token

func UnaryServerTracing 

func UnaryServerTracing() grpc.UnaryServerInterceptor

UnaryServerTracing server-side tracing unary interceptor

func WrapServerCtx added in v1.5.7 

func WrapServerCtx(ctx context.Context, kvs ...KV) context.Context

WrapServerCtx wrap context, used in grpc server-side

Types

type AuthOption 

type AuthOption func(*authOptions)

AuthOption setting the Authentication Field

func WithAuthClaimsName 

func WithAuthClaimsName(claimsName string) AuthOption

WithAuthClaimsName set the key name of the information in ctx for authentication

func WithAuthIgnoreMethods 

func WithAuthIgnoreMethods(fullMethodNames ...string) AuthOption

WithAuthIgnoreMethods ways to ignore forensics fullMethodName format: /packageName.serviceName/methodName, example /api.userExample.v1.userExampleService/GetByID

func WithAuthScheme 

func WithAuthScheme(scheme string) AuthOption

WithAuthScheme set the message prefix for authentication

func WithCustomVerify added in v1.9.3 

func WithCustomVerify(verify CustomVerifyFn) AuthOption

WithCustomVerify set the custom verify function for authentication

func WithStandardVerify added in v1.9.3 

func WithStandardVerify(verify StandardVerifyFn) AuthOption

WithStandardVerify set the standard verify function for authentication

type CheckToken added in v1.3.20 

type CheckToken func(appID string, appKey string) error

CheckToken check app id and app key Example: 

var f CheckToken=func(appID string, appKey string) error{
	if appID != targetAppID || appKey != targetAppKey {
		return status.Errorf(codes.Unauthenticated, "app id or app key checksum failure")
	}
	return nil
}

type CircuitBreakerOption 

type CircuitBreakerOption func(*circuitBreakerOptions)

CircuitBreakerOption set the circuit breaker circuitBreakerOptions.

func WithGroup 

func WithGroup(g *group.Group) CircuitBreakerOption

WithGroup with circuit breaker group. NOTE: implements generics circuitbreaker.CircuitBreaker

func WithUnaryServerDegradeHandler added in v1.9.0 

func WithUnaryServerDegradeHandler(handler func(ctx context.Context, req interface{}) (reply interface{}, error error)) CircuitBreakerOption

WithUnaryServerDegradeHandler unary server degrade handler function

func WithValidCode added in v1.4.2 

func WithValidCode(code ...codes.Code) CircuitBreakerOption

WithValidCode rpc code to mark failed

type CtxKeyString added in v1.5.3 

type CtxKeyString string

CtxKeyString for context.WithValue key type

type CustomVerifyFn added in v1.9.3 

type CustomVerifyFn = func(claims *jwt.CustomClaims, tokenTail32 string) error

CustomVerifyFn verify custom function, tokenTail32 is the last 32 characters of the token.

type KV added in v1.5.7 

type KV struct {
	Key string
	Val interface{}
}

KV key value

type LogOption 

type LogOption func(*logOptions)

LogOption log settings

func WithLogFields 

func WithLogFields(kvs map[string]interface{}) LogOption

WithLogFields adding a custom print field

func WithLogIgnoreMethods 

func WithLogIgnoreMethods(fullMethodNames ...string) LogOption

WithLogIgnoreMethods ignore printing methods fullMethodName format: /packageName.serviceName/methodName, example /api.userExample.v1.userExampleService/GetByID

func WithMarshalFn added in v1.9.2 

func WithMarshalFn(fn func(reply interface{}) []byte) LogOption

WithMarshalFn custom response data marshal function

func WithMaxLen added in v1.9.2 

func WithMaxLen(maxLen int) LogOption

WithMaxLen logger content max length

func WithReplaceGRPCLogger added in v1.4.5 

func WithReplaceGRPCLogger() LogOption

WithReplaceGRPCLogger replace grpc logger v2

type RatelimitOption 

type RatelimitOption func(*ratelimitOptions)

RatelimitOption set the rate limits ratelimitOptions.

func WithBucket 

func WithBucket(b int) RatelimitOption

WithBucket with bucket size.

func WithCPUQuota 

func WithCPUQuota(quota float64) RatelimitOption

WithCPUQuota with real cpu quota(if it can not collect from process correct);

func WithCPUThreshold 

func WithCPUThreshold(threshold int64) RatelimitOption

WithCPUThreshold with cpu threshold

func WithWindow 

func WithWindow(d time.Duration) RatelimitOption

WithWindow with window size.

type RetryOption 

type RetryOption func(*retryOptions)

RetryOption set the retry retryOptions.

func WithRetryErrCodes 

func WithRetryErrCodes(errCodes ...codes.Code) RetryOption

WithRetryErrCodes set the trigger retry error code

func WithRetryInterval 

func WithRetryInterval(t time.Duration) RetryOption

WithRetryInterval set the retry interval from 1 ms to 10 seconds

func WithRetryTimes 

func WithRetryTimes(n uint) RetryOption

WithRetryTimes set number of retries, max 10

type StandardVerifyFn added in v1.9.3 

type StandardVerifyFn = func(claims *jwt.Claims, tokenTail32 string) error

StandardVerifyFn verify function, tokenTail32 is the last 32 characters of the token.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.