Zuverlässige gRPC-Dienste mit Fristen und Abbrüchen

Artikel
11/30/2023

Fristen und Abbrüche sind Features, die von gRPC-Clients zum Abbrechen von aktiven Aufrufen verwendet werden. In diesem Artikel werden die Bedeutung von Fristen und Abbrüchen sowie deren Verwendung in .NET-gRPC-Apps erläutert.

Fristen

Mit einer Frist kann ein gRPC-Client angeben, wie lange er bereit ist, auf den Abschluss eines Aufrufs zu warten. Bei Überschreiten der Frist wird der Aufruf abgebrochen. Das Festlegen einer Frist ist wichtig, da sie eine Obergrenze für den Zeitraum vorgibt, in dem ein Aufruf ausgeführt werden kann. Dadurch wird verhindert, dass fehlerhafte Dienste unbegrenzt lange ausgeführt werden und die Serverressourcen belasten. Fristen stellen einen wichtigen Aspekt bei der Erstellung zuverlässiger Apps dar und sollten daher konfiguriert werden.

Konfiguration von Fristen:

Die Konfiguration einer Frist für die Ausführung eines Aufrufs erfolgt mit CallOptions.Deadline.
Es gibt keinen Standardwert für Fristen. gRPC-Aufrufe sind zeitlich nicht begrenzt, es sei denn, es wird eine Frist festgelegt.
Fristen werden im UTC-Zeitformat angegeben. DateTime.UtcNow.AddSeconds(5) entspricht beispielsweise einer Frist von 5 Sekunden ab dem aktuellen Zeitpunkt.
Wenn ein früherer oder der aktuelle Zeitpunkt angegeben wird, führt dies sofort zur Fristüberschreitung des Aufrufs.
Die Frist wird mit dem gRPC-Aufruf an den Dienst gesendet und vom Client und Dienst unabhängig voneinander nachverfolgt. Es ist möglich, dass ein gRPC-Aufruf auf einem Computer abgeschlossen ist, die Frist jedoch überschritten ist, wenn die Antwort an den Client zurückgegeben wurde.

Bei Überschreiten der Frist verhalten sich Client und Dienst unterschiedlich:

Der Client bricht die zugrunde liegende HTTP-Anforderung sofort ab und löst den Fehler DeadlineExceeded aus. Die Client-App kann den Fehler abfangen und dem Benutzer eine Meldung mit dem Hinweis auf eine Zeitüberschreitung anzeigen.
Die ausgeführte HTTP-Anforderung wird auf dem Server abgebrochen, und der Fehler ServerCallContext.CancellationToken wird ausgelöst. Die HTTP-Anforderung wird zwar abgebrochen, der gRPC-Aufruf wird allerdings weiterhin auf dem Server ausgeführt, bis die Methode abgeschlossen ist. Es ist wichtig, dass das Abbruchtoken an asynchrone Methoden übergeben wird, damit sie zusammen mit dem Aufruf abgebrochen werden. Beispiel: Ein Abbruchtoken wird an asynchrone Datenbankabfragen und HTTP-Anforderungen übergeben. Mit Übergabe eines Abbruchtokens können abgebrochene Aufrufe schnell auf dem Server ausgeführt und Ressourcen für andere Aufrufe freigegeben werden.

Konfigurieren Sie CallOptions.Deadline, um eine Frist für einen gRPC-Aufruf festzulegen:

var client = new Greet.GreeterClient(channel);

try
{
    var response = await client.SayHelloAsync(
        new HelloRequest { Name = "World" },
        deadline: DateTime.UtcNow.AddSeconds(5));
    
    // Greeting: Hello World
    Console.WriteLine("Greeting: " + response.Message);
}
catch (RpcException ex) when (ex.StatusCode == StatusCode.DeadlineExceeded)
{
    Console.WriteLine("Greeting timeout.");
}

Verwenden von ServerCallContext.CancellationToken in einem gRPC-Dienst:

public override async Task<HelloReply> SayHello(HelloRequest request,
    ServerCallContext context)
{
    var user = await _databaseContext.GetUserAsync(request.Name,
        context.CancellationToken);

    return new HelloReply { Message = "Hello " + user.DisplayName };
}

Stichtage und Wiederholungen

Wenn ein gRPC-Aufruf für eine Fehlerbehandlung mit Wiederholungen und einer Frist konfiguriert ist, wird über die Frist die Zeit für alle Wiederholungen eines gRPC-Aufrufs nachverfolgt. Wenn die Frist überschritten wird, bricht ein gRPC-Aufruf die zugrunde liegende HTTP-Anforderung ab, überspringt alle verbleibenden Wiederholungsversuche und löst einen DeadlineExceeded-Fehler aus.

Übertragen von Fristen

Wenn ein gRPC-Aufruf von einem ausgeführten gRPC-Dienst verarbeitet wird, muss die Frist übertragen werden. Zum Beispiel:

Client-App ruft FrontendService.GetUser mit einer Frist auf.
FrontendService ruft UserService.GetUser auf. Die vom Client angegebene Frist muss mit dem neuen gRPC-Aufruf angegeben werden.
UserService.GetUser empfängt die Frist. Wenn die Frist für die Client-App überschritten wird, kommt es zu einer Zeitüberschreitung.

Im Aufrufkontext wird die Frist mit ServerCallContext.Deadline bereitgestellt:

public override async Task<UserResponse> GetUser(UserRequest request,
    ServerCallContext context)
{
    var client = new User.UserServiceClient(_channel);
    var response = await client.GetUserAsync(
        new UserRequest { Id = request.Id },
        deadline: context.Deadline);

    return response;
}

Das manuelle Übertragen von Fristen kann mühsam sein. Die Frist muss an jeden einzelnen Aufruf übermittelt werden. Dabei kann schnell einer übersehen werden. Die gRPC-Clientfactory stellt eine automatische Lösung bereit. Durch Angeben von EnableCallContextPropagation wird Folgendes sichergestellt:

Automatische Weitergabe des Frist- und Abbruchtokens an untergeordnete Aufrufe
Die Frist wird nicht propagiert, wenn der untergeordnete Aufruf eine kürzere Frist angibt. So wird beispielsweise eine propagierte Frist von 10 Sekunden nicht angewendet, wenn ein untergeordneter Aufruf mithilfe von CallOptions.Deadline eine neue Frist von 5 Sekunden angibt. Bei mehreren Fristen wird die kürzeste angewandt.
Zuverlässige Übertragung der Frist und des Abbruchs komplexer und verschachtelter gRPC-Szenarios

services
    .AddGrpcClient<User.UserServiceClient>(o =>
    {
        o.Address = new Uri("https://localhost:5001");
    })
    .EnableCallContextPropagation();

Weitere Informationen finden Sie unter gRPC-Clientfactoryintegration in .NET.

Abbruch

Mit Festlegen eines Abbruchs kann ein gRPC-Client nicht mehr benötigte Aufrufe mit langer Ausführungszeit abbrechen. So startet beispielsweise ein gRPC-Aufruf, mit dem Echtzeitupdates gestreamt werden, wenn der Benutzer eine Seite auf einer Website besucht. Der Streamingvorgang sollte abgebrochen werden, wenn der Benutzer von der Seite wieder verlässt.

Der gRPC-Aufruf kann im Client abgebrochen werden, indem ein Abbruchtoken mit CallOptions.CancellationToken oder durch Aufrufen von Dispose weitergegeben wird.

private AsyncServerStreamingCall<HelloReply> _call;

public void StartStream()
{
    _call = client.SayHellos(new HelloRequest { Name = "World" });

    // Read response in background task.
    _ = Task.Run(async () =>
    {
        await foreach (var response in _call.ResponseStream.ReadAllAsync())
        {
            Console.WriteLine("Greeting: " + response.Message);
        }
    });
}

public void StopStream()
{
    _call.Dispose();
}

gRPC-Dienste, die abgebrochen werden können, sollten folgende Aktionen ausführen:

Übergeben von ServerCallContext.CancellationToken an asynchrone Methoden. Durch Abbrechen von asynchronen Methoden kann ein Aufruf schnell auf dem Server ausgeführt werden.
Weitergabe des Abbruchtokens an untergeordnete Aufrufe. Mit der Weitergabe des Abbruchtokens wird sichergestellt, dass untergeordnete Aufrufe mit ihren übergeordneten Aufrufen abgebrochen werden. gRPC-Clientfactory und EnableCallContextPropagation() geben das Abbruchtoken automatisch weiter.