grpc-ecosystem/go-grpc-middleware
Go Grpc Middleware
go-grpc-middleware is a gRPC middleware framework for Go designed to handle cross-cutting concerns, reliability, and observability. It provides a collection of interceptors that can be used to modify inbound and outbound calls to enforce system-wide policies.
The framework distinguishes itself through specialized toolkits for service reliability, including automatic retry logic for failed client calls and panic recovery mechanisms that translate runtime crashes into standard error responses. It also features an observability suite for collecting performance metrics and recording request activity via adapter-based logging.
The project covers broad capability areas including traffic management through rate limiting and timeout enforcement, as well as API integration for inbound message validation and request authentication verification. It employs architectural patterns such as interceptor chaining and conditional execution logic to control how middleware is applied to specific service methods.
Features
- gRPC Interceptor Libraries - Provides a comprehensive collection of reusable interceptors to handle cross-cutting concerns for gRPC services in Go.
- Request Retries - Provides automatic retry logic for failed client calls based on retryable status codes to improve service reliability.
- Automatic Retry Clients - Provides automatic retry logic for failed client-side gRPC calls based on configurable status codes.
- Unary and Streaming Interceptors - Implements interceptors for both unary and streaming gRPC calls to enforce validation, timeouts, and rate limits.
- Ordered Interceptor Chains - Implements a pipeline of nested functions to process a sequence of gRPC unary and streaming interceptors.
- gRPC Server Reliability Toolkits - Provides a suite of reliability features including panic recovery and rate limiting to protect gRPC servers.
- gRPC Reliability Toolkits - Ships tools for improving gRPC service stability, specifically automatic retries and panic recovery handlers.
- gRPC Service Observability - Enables tracking of request volume and performance metrics to monitor the health of gRPC services.
- Observability Suites - Offers a series of middleware components for collecting metrics and logging activity across distributed gRPC architectures.
- Panic Recovery - Captures runtime panics and translates them into standard gRPC status codes to prevent server crashes.
- Request Rate Limiting - Ships middleware to restrict the number of incoming gRPC calls using a custom limiter to protect servers from overload.
- Request Validations - Ensures incoming gRPC messages meet specific requirements before they are processed by business logic.
- gRPC Implementations - Enhances gRPC client communication reliability through automatic retry mechanisms for failed calls.
- gRPC Access Control - Restricts access to protected gRPC services by validating client credentials through custom interceptors.
- Conditional Execution - Executes specific interceptors only when defined conditions, such as method name matching, are met.
- Middleware Execution Gating - Allows dynamic determination of whether an interceptor should run based on the gRPC method being called.
- Request Authentication - Validates the authenticity and integrity of incoming requests using custom authentication functions.
- Higher-Order Function Wrapping - Uses closures to generate specialized interceptor functions that inject custom configuration into the request flow.
- Inbound Message Validations - Provides interceptors to verify that incoming gRPC messages adhere to predefined constraints before business logic execution.
- Logging Adapter Layers - Implements adapter layers that decouple middleware from specific logging libraries using a common interface.
- Middleware Rate Limiters - Integrates rate limiting directly into the interceptor chain to reject excessive calls before they reach handlers.
- Metric Collection - Implements interceptors for gathering quantitative performance data and request volume metrics to be exported to monitoring systems.
- Request Logging - Provides a configurable adapter-based logging system to capture details of incoming and outgoing gRPC traffic for debugging and auditing.
- Request Timeouts - Implements timeout enforcement to cancel requests that exceed specified durations, preventing resource exhaustion from hanging calls.
- RPC Frameworks - Common middleware for gRPC services.
