--- name: grpc-development-7cfa351589ea description: "Best practices for building high-performance services with gRPC and Protocol Buffers. Use when designing RPC services, defining protobuf schemas, implementing streaming APIs, setting up gRPC interceptors, or building cross-language service communication." metadata: maintainer: Mindrally source: https://github.com/Mindrally/skills --- # gRPC Development This skill covers best practices for building gRPC-based services and APIs using Protocol Buffers, including service design, streaming patterns, interceptors, security, and observability. ## Workflow for Building a gRPC Service 1. **Define the service contract** — Write `.proto` files with service definitions, RPC methods, and message types following the style and naming conventions below. 2. **Generate language stubs** — Run `protoc` with the appropriate language plugin (e.g., `protoc-gen-go-grpc`, `grpcio-tools`) to produce server and client code. 3. **Implement the server** — Create handler functions for each RPC method, register them with a gRPC server, and configure TLS, interceptors, and health checks. 4. **Implement the client** — Create a channel to the server, instantiate the generated client stub, and call RPC methods with proper deadlines and error handling. 5. **Add interceptors** — Wire in server and client interceptors for logging, authentication, metrics, and tracing. 6. **Write tests** — Unit-test handlers with mocked dependencies; integration-test with a real gRPC connection. 7. **Deploy and observe** — Enable distributed tracing (OpenTelemetry), structured logging, and metrics dashboards before going to production. ## Core Principles - gRPC uses Protocol Buffers as both its Interface Definition Language (IDL) and message interchange format - Design services around the idea of defining methods that can be called remotely with their parameters and return types - Prioritize type safety, performance, and backward compatibility - Leave NO todos, placeholders, or missing pieces in the implementation ## Protocol Buffer Best Practices ### File Organization (1-1-1 Pattern) - Structure definitions with one top-level entity (message, enum, or extension) per .proto file - Correspond each .proto file to a single build rule - This promotes small, modular proto definitions - Benefits include simplified refactoring, improved build times, and smaller binary sizes ### Message Design - Use structured messages for extensibility - Protocol Buffers supports adding fields without breaking existing clients - Be careful to use structs in places you may want to add fields later - Don't re-use messages across RPCs - APIs may change over time, avoid coupling separate RPC calls tightly together - Fields should always be independent of each other - don't have one field influence the semantic meaning of another ### Field Guidelines - Use descriptive field names with underscore_separated_names - Reserve field numbers for deleted fields to prevent future conflicts - Use `optional` for fields that may not always be present - Consider using `oneof` when users need to choose between mutually exclusive options ### Enum Best Practices - Ensure the first value is always 0 - Use an "UNSPECIFIED" default value (e.g., `STATUS_UNSPECIFIED = 0`) - Use prefixes to avoid naming collisions (e.g., `ORDER_STATUS_CREATED` vs `STATUS_PENDING`) - Reserve enum values that are removed to prevent accidental reuse ## Style Guidelines - Keep line length to 80 characters - Prefer double quotes for strings - Package names should be in lowercase - Use CamelCase (with initial capital) for message names - Use underscore_separated_names for field names - Use CamelCase for service and RPC method names ## Service Design ### RPC Patterns - **Unary RPC**: Client sends single request, server responds with single response - **Server Streaming**: Client sends request, server responds with stream of messages - **Client Streaming**: Client sends stream of messages, server responds with single response - **Bidirectional Streaming**: Both sides send streams of messages ### Example: Proto Definition ```proto syntax = "proto3"; package order.v1; option go_package = "gen/order/v1;orderv1"; // OrderService manages customer orders. service OrderService { // Creates a new order and returns the created resource. rpc CreateOrder(CreateOrderRequest) returns (CreateOrderResponse); // Streams real-time status updates for an order. rpc WatchOrder(WatchOrderRequest) returns (stream OrderStatus); } message CreateOrderRequest { string customer_id = 1; repeated OrderItem items = 2; } message CreateOrderResponse { string order_id = 1; OrderStatus status = 2; } message WatchOrderRequest { string order_id = 1; } message OrderItem { string product_id = 1; int32 quantity = 2; } message OrderStatus { string order_id = 1; OrderState state = 2; string updated_at = 3; } enum OrderState { ORDER_STATE_UNSPECIFIED = 0; ORDER_STATE_CREATED = 1; ORDER_STATE_PROCESSING = 2; ORDER_STATE_SHIPPED = 3; ORDER_STATE_DELIVERED = 4; } ``` ### Example: Go Server Implementation ```go package main import ( "context" "log" "net" "time" "google.golang.org/grpc" "google.golang.org/grpc/codes" "google.golang.org/grpc/status" pb "example.com/gen/order/v1" ) type orderServer struct { pb.UnimplementedOrderServiceServer } func (s *orderServer) CreateOrder(ctx context.Context, req *pb.CreateOrderRequest) (*pb.CreateOrderResponse, error) { if req.GetCustomerId() == "" { return nil, status.Error(codes.InvalidArgument, "customer_id is required") } orderID := "ord-" + time.Now().Format("20060102150405") return &pb.CreateOrderResponse{ OrderId: orderID, Status: &pb.OrderStatus{ OrderId: orderID, State: pb.OrderState_ORDER_STATE_CREATED, }, }, nil } func (s *orderServer) WatchOrder(req *pb.WatchOrderRequest, stream pb.OrderService_WatchOrderServer) error { for i, state := range []pb.OrderState{ pb.OrderState_ORDER_STATE_PROCESSING, pb.OrderState_ORDER_STATE_SHIPPED, pb.OrderState_ORDER_STATE_DELIVERED, } { select { case <-stream.Context().Done(): return stream.Context().Err() case <-time.After(time.Duration(i) * time.Second): if err := stream.Send(&pb.OrderStatus{ OrderId: req.GetOrderId(), State: state, UpdatedAt: time.Now().Format(time.RFC3339), }); err != nil { return err } } } return nil } func main() { lis, err := net.Listen("tcp", ":50051") if err != nil { log.Fatalf("failed to listen: %v", err) } srv := grpc.NewServer( grpc.UnaryInterceptor(loggingUnaryInterceptor), ) pb.RegisterOrderServiceServer(srv, &orderServer{}) log.Println("serving on :50051") if err := srv.Serve(lis); err != nil { log.Fatalf("failed to serve: %v", err) } } // loggingUnaryInterceptor logs each unary RPC call. func loggingUnaryInterceptor( ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler, ) (any, error) { start := time.Now() resp, err := handler(ctx, req) log.Printf("method=%s duration=%s err=%v", info.FullMethod, time.Since(start), err) return resp, err } ``` ### API Design - Design clear, intuitive service interfaces - Group related methods in the same service - Use meaningful method names that describe the action - Document each RPC with comments describing behavior, parameters, and return values ## Performance Optimization ### Channel Management - Reuse channels when working with gRPC - Creating a gRPC channel is costly as it creates a new HTTP/2 connection - Implement connection pooling for high-throughput scenarios - Configure keepalive settings appropriately ### Message Optimization - Keep messages reasonably sized - large messages impact performance - Consider streaming for large data transfers - Use compression for bandwidth-constrained environments - Avoid deeply nested message structures ## Error Handling ### Status Codes - Use appropriate gRPC status codes (OK, INVALID_ARGUMENT, NOT_FOUND, etc.) - Include meaningful error messages in status details - Use rich error details for complex error scenarios - Document expected error conditions in service definitions ### Retry Logic - Implement retry with exponential backoff for transient failures - Use deadlines/timeouts for all RPC calls - Handle UNAVAILABLE and RESOURCE_EXHAUSTED with retries - Don't retry non-idempotent operations blindly ## Security ### Authentication - Use TLS for transport security in production - Implement per-RPC authentication using metadata/headers - Support multiple authentication mechanisms (JWT, OAuth2, mTLS) - Validate credentials on every request ### Authorization - Implement method-level access control - Use interceptors for centralized authorization logic - Validate all input data regardless of authentication status - Follow the principle of least privilege ## Interceptors and Middleware ### Server Interceptors - Use interceptors for cross-cutting concerns (logging, auth, metrics) - Order interceptors carefully - execution order matters - Keep interceptors focused on single responsibilities - Handle errors gracefully within interceptors ### Client Interceptors - Add metadata (headers) for tracing and authentication - Implement request/response logging - Add automatic retry logic - Collect client-side metrics ## Testing ### Unit Testing - Mock gRPC services for isolated testing - Test message serialization/deserialization - Verify error handling paths - Test interceptor logic independently ### Integration Testing - Test with real gRPC connections where possible - Verify streaming behavior end-to-end - Test timeout and cancellation scenarios - Load test with realistic traffic patterns ## Observability ### Distributed Tracing - Use OpenTelemetry for distributed tracing across service boundaries - Propagate trace context in metadata - Instrument both client and server sides - Start spans for each RPC call ### Metrics - Track RPC latency histograms - Monitor error rates by method and status code - Count active connections and streams - Alert on anomalies and SLA violations ### Logging - Use structured logging with consistent fields - Log RPC method, duration, and status - Include trace IDs for correlation - Avoid logging sensitive data ## Language-Specific Guidelines ### Go - Use the official `google.golang.org/grpc` package - Implement services as interface types - Use context for cancellation and deadlines - Leverage code generation with `protoc-gen-go-grpc` ### Python - Use `grpcio` and `grpcio-tools` packages - Implement async services with `grpcio-aio` for better concurrency - Use type hints with generated stubs - Handle blocking calls appropriately in async contexts ### Node.js/TypeScript - Use `@grpc/grpc-js` (pure JavaScript implementation) - Consider using `nice-grpc` for better TypeScript support - Leverage async/await patterns - Use static codegen for type safety --- Source attribution: Mindrally Original project: https://github.com/Mindrally/skills/blob/7682ca77710e0971eab4e0ae5dddfa281aea0ba5/grpc-development/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: Mindrally Original project: https://github.com/Mindrally/skills/blob/7682ca77710e0971eab4e0ae5dddfa281aea0ba5/grpc-development/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: Backend Developer, Data Engineer, DevOps / SRE Specialties: API, Backend, Design, DevOps, Word Documents, Frontend, Mobile, Playwright, Testing Tools: Grpc Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 16e7c6ecdbadb3b5e1a395f03bc74cd6c5f88c607446e569cdef5ab6b9028b62