grpc runtime_error ai_generated true

CANCELLED: grpc: client side streaming canceled by client

ID: grpc/client-side-streaming-cancel

Also available as: JSON · Markdown · 中文
80%Fix Rate
85%Confidence
1Evidence
2024-01-10First Seen

Version Compatibility

VersionStatusIntroducedDeprecatedNotes
gRPC Python 1.60+ active — — —
gRPC Java 1.60+ active — — —
gRPC Node 1.10+ active — — —

Root Cause

Client explicitly cancels a streaming RPC (e.g., via context cancel or stream.CloseSend) before server finishes processing, often due to timeout or early exit.

generic

中文

客户端显式取消了一个流式RPC（例如通过context取消或stream.CloseSend），在服务器完成处理之前，通常由于超时或提前退出。

Official Documentation

https://grpc.io/docs/guides/error-handling/

Workarounds

  1. 85% success Check server-side handling of client cancel: ensure server reads from stream until EOF and handles context cancellation gracefully. In Python: for request in stub.StreamingCall(...): try: process(request) except grpc.RpcError as e: if e.code() == grpc.StatusCode.CANCELLED: break 
    Check server-side handling of client cancel: ensure server reads from stream until EOF and handles context cancellation gracefully. In Python: for request in stub.StreamingCall(...): try: process(request) except grpc.RpcError as e: if e.code() == grpc.StatusCode.CANCELLED: break
  2. 80% success Use a graceful shutdown pattern: before canceling, call stream.CloseSend() and wait for server response. In Go: if err := stream.CloseSend(); err != nil { log.Fatal(err) } for { _, err := stream.Recv(); if err == io.EOF { break } } 
    Use a graceful shutdown pattern: before canceling, call stream.CloseSend() and wait for server response. In Go: if err := stream.CloseSend(); err != nil { log.Fatal(err) } for { _, err := stream.Recv(); if err == io.EOF { break } }

中文步骤

  1. Check server-side handling of client cancel: ensure server reads from stream until EOF and handles context cancellation gracefully. In Python: for request in stub.StreamingCall(...): try: process(request) except grpc.RpcError as e: if e.code() == grpc.StatusCode.CANCELLED: break
  2. Use a graceful shutdown pattern: before canceling, call stream.CloseSend() and wait for server response. In Go: if err := stream.CloseSend(); err != nil { log.Fatal(err) } for { _, err := stream.Recv(); if err == io.EOF { break } }

Dead Ends

Common approaches that don't work:

  1. Adding longer timeouts to all RPCs 50% fail

    The cancellation is intentional from client logic; longer timeouts only mask the symptom and may cause resource leaks.

  2. Ignoring the error and retrying immediately 60% fail

    Retrying without fixing the cancel logic may loop indefinitely or waste resources.