Как закрыть все потоки сервера grpc с помощью gracefulStop? - PullRequest
Новая
       23

Как закрыть все потоки сервера grpc с помощью gracefulStop?

3 голосов
/ 21 октября 2019

Я пытаюсь остановить всех клиентов, подключенных к потоковому серверу со стороны сервера. На самом деле я использую метод GracefulStop для изящной обработки.

Я жду сигнала os.Interrupt на канале, чтобы выполнить постепенную остановку для gRPC. но он застревает на server.GracefulStop(), когда клиент подключен. 

func (s *Service) Subscribe(_ *empty.Empty, srv clientapi.ClientApi_SubscribeServer) error {
    ctx := srv.Context()

    updateCh := make(chan *clientapi.Update, 100)
    stopCh := make(chan bool)
    defer func() {
        stopCh<-true
        close(updateCh)
    }

    go func() {
        ticker := time.NewTicker(1 * time.Second)
        defer func() {
            ticker.Stop()
            close(stopCh)
        }
        for {
            select {
            case <-stopCh:
                return
            case <-ticker.C:
                updateCh<- &clientapi.Update{Name: "notification": Payload: "sample notification every 1 second"}
            }
        }
    }()

    for {
        select {
        case <-ctx.Done():
            return ctx.Err()

        case notif := <-updateCh:
            err := srv.Send(notif)
            if err == io.EOF {
                return nil
            }

            if err != nil {
                s.logger.Named("Subscribe").Error("error", zap.Error(err))
                continue
            }
        }
    }
}

Я ожидал, что context в методе ctx.Done() может обработать его и разорвать цикл for. Как закрыть все потоки ответов, как этот?

Ответы [ 2 ]

1 голос
/ 24 октября 2019

Обычно клиенты должны предполагать, что RPC могут завершиться (например, из-за ошибок соединения или сбоя питания сервера) в любой момент. Итак, что мы делаем - GracefulStop, спим в течение короткого периода времени, чтобы позволить RPC в полете получить возможность естественного завершения, а затем - Stop сервера. Если вам нужно использовать этот сигнал завершения для завершения RPC, то ответ @colminator, вероятно, является лучшим выбором. Но эта ситуация должна быть необычной, и вы можете потратить некоторое время на анализ вашего проекта, если вы обнаружите, что необходимо вручную завершить потоковые RPC при завершении работы сервера.

1 голос
/ 21 октября 2019

Создайте global context для вашей службы gRPC. Итак, пройдясь по различным частям:

  • Каждый запрос на обслуживание gRPC будет использовать этот контекст (вместе с контекстом клиента) для выполнения этого запроса, обработчик
  • os.Interrupt отменяет глобальный контекст;таким образом отменяя любые выполняющиеся в данный момент запросы
  • наконец, выдайте server.GracefulStop() - что должно ждать завершения всех активных вызовов gRPC (если они не увидели отмену немедленно)

Например, при настройке службы gRPC: обработчик 

pctx := context.Background()
globalCtx, globalCancel := context.WithCancel(pctx)

mysrv := MyService{
    gctx: globalCtx
}

s := grpc.NewServer()
pb.RegisterMyService(s, mysrv)

os.Interrupt инициирует и ожидает выключения: 

globalCancel()
server.GracefulStop()

Методы gRPC: 

func(s *MyService) SomeRpcMethod(ctx context.Context, req *pb.Request) error {

    // merge client and server contexts into one `mctx`
    // (client context will cancel if client disconnects)
    // (server context will cancel if service Ctrl-C'ed)

    mctx, mcancel := mergeContext(ctx, s.gctx)

    defer mcancel() // so we don't leak, if neither client or server context cancels

    // RPC WORK GOES HERE
    // RPC WORK GOES HERE
    // RPC WORK GOES HERE

    // pass mctx to any blocking calls:
    // - http REST calls
    // - SQL queries etc.
    // - or if running a long loop; status check the context occasionally like so:

    // Example long request (10s)
    for i:=0; i<10*1000; i++ {
        time.Sleep(1*time.Milliscond)

        // poll merged context
        select {
            case <-mctx.Done():
                return fmt.Errorf("request canceled: %s", mctx.Err())
            default:
        }
    }
}

А: 

func mergeContext(a, b context.Context) (context.Context, context.CancelFunc) {
    mctx, mcancel := context.WithCancel(a) // will cancel if `a` cancels

    go func() {
        select {
        case <-mctx.Done(): // don't leak go-routine on clean gRPC run
        case <-b.Done():
            mcancel() // b canceled, so cancel mctx 
        }
    }()

    return mctx, mcancel
}
...