Golang gRPC Middlewares: interceptor chaining, auth, logging, retries and more.
Switch branches/tags
Nothing to show
Clone or download
johanbrandhorst and domgreen Add context functions to retry and recover (#172)
* retry: add new BackoffFuncContext type

BackoffFuncContext adds the context parameter, allowing
the retry function access to the contents of the parent
context.

Fixes #171

* recovery: add new RecoveryHandlerFuncContext type

Allows the user to configure a custom recovery handler
that has access to the request scoped values in the
context.

Fixes #168
Latest commit 3304cc8 Nov 12, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
auth fixing vet issues ... most relating to the Examples Feb 28, 2018
logging Delete .DS_Store (#141) May 2, 2018
recovery Add context functions to retry and recover (#172) Nov 12, 2018
retry Add context functions to retry and recover (#172) Nov 12, 2018
scripts Add check for docs (#138) Apr 17, 2018
tags fix misspelling in comment + lint (137) Apr 17, 2018
testing Added retry for connection errors on server stream call (#161) Aug 30, 2018
tracing/opentracing Added retry for connection errors on server stream call (#161) Aug 30, 2018
util Add exponential backoff functions (#152) Aug 24, 2018
validator Spelling/grammar corrections for validator docs Apr 8, 2018
.gitignore Remove vendor/ and gitignore (#109) Nov 22, 2017
.travis.yml Add check for docs (#138) Apr 17, 2018
CHANGELOG.md Adding CHANGELOG (#143) May 18, 2018
CONTRIBUTING.md Add check for docs (#138) Apr 17, 2018
DOC.md Update generated docs and tidy formatting Feb 27, 2018
Gopkg.lock Add option to suppress interceptor logs (#113) Nov 30, 2017
Gopkg.toml Add option to suppress interceptor logs (#113) Nov 30, 2017
LICENSE Init repo May 14, 2016
README.md adding a slack shield (#140) May 2, 2018
chain.go Support retrying gRPCs with chained interceptors Feb 27, 2018
chain_test.go add streaming client interceptor Sep 4, 2016
doc.go Update comments for chained retry interceptors Feb 27, 2018
makefile Add check for docs (#138) Apr 17, 2018
slack.png adding a slack shield (#140) May 2, 2018
wrappers.go implement grpc interceptor chaining May 14, 2016
wrappers_test.go add streaming client interceptor Sep 4, 2016

README.md

Go gRPC Middleware

Travis Build Go Report Card GoDoc SourceGraph codecov Apache 2.0 License quality: production Slack

gRPC Go Middleware: interceptors, helpers, utilities.

Important The repo recently moved to github.com/grpc-ecosystem/go-grpc-middleware, please update your import paths.

Middleware

gRPC Go recently acquired support for Interceptors, i.e. middleware that is executed either on the gRPC Server before the request is passed onto the user's application logic, or on the gRPC client either around the user call. It is a perfect way to implement common patterns: auth, logging, message, validation, retries or monitoring.

These are generic building blocks that make it easy to build multiple microservices easily. The purpose of this repository is to act as a go-to point for such reusable functionality. It contains some of them itself, but also will link to useful external repos.

grpc_middleware itself provides support for chaining interceptors. See Documentation, but here's an example:

import "github.com/grpc-ecosystem/go-grpc-middleware"

myServer := grpc.NewServer(
    grpc.StreamInterceptor(grpc_middleware.ChainStreamServer(
        grpc_ctxtags.StreamServerInterceptor(),
        grpc_opentracing.StreamServerInterceptor(),
        grpc_prometheus.StreamServerInterceptor,
        grpc_zap.StreamServerInterceptor(zapLogger),
        grpc_auth.StreamServerInterceptor(myAuthFunction),
        grpc_recovery.StreamServerInterceptor(),
    )),
    grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer(
        grpc_ctxtags.UnaryServerInterceptor(),
        grpc_opentracing.UnaryServerInterceptor(),
        grpc_prometheus.UnaryServerInterceptor,
        grpc_zap.UnaryServerInterceptor(zapLogger),
        grpc_auth.UnaryServerInterceptor(myAuthFunction),
        grpc_recovery.UnaryServerInterceptor(),
    )),
)

Interceptors

Please send a PR to add new interceptors or middleware to this list

Auth

  • grpc_auth - a customizable (via AuthFunc) piece of auth middleware

Logging

  • grpc_ctxtags - a library that adds a Tag map to context, with data populated from request body
  • grpc_zap - integration of zap logging library into gRPC handlers.
  • grpc_logrus - integration of logrus logging library into gRPC handlers.

Monitoring

Client

  • grpc_retry - a generic gRPC response code retry mechanism, client-side middleware

Server

Status

This code has been running in production since May 2016 as the basis of the gRPC micro services stack at Improbable.

Additional tooling will be added, and contributions are welcome.

License

go-grpc-middleware is released under the Apache 2.0 license. See the LICENSE file for details.