Strategia di ripetizione

Questa pagina descrive in che modo gli strumenti Cloud Storage riprovano le richieste non riuscite e come personalizzare il comportamento dei nuovi tentativi. Inoltre, descrive i fattori da prendere in considerazione per riprovare a inviare le richieste.

Panoramica

Esistono due fattori che determinano se è possibile o meno riprovare a inviare una richiesta:

  1. La risposta che ricevi dalla richiesta.
  2. L'idempotenza della richiesta.

Risposta

La risposta che ricevi dalla richiesta indica se è utile riprovare o meno. Le risposte relative a problemi temporanei sono generalmente ripetibili. D'altra parte, la risposta relativa agli errori permanenti indica che devi apportare modifiche, ad esempio di autorizzazione o configurazione, prima di riprovare a inviare la richiesta. Le seguenti risposte indicano problemi temporanei che sono utili per riprovare:

  • Codici di risposta HTTP 408, 429 e 5xx.
  • Timeout della socket e disconnessioni TCP.

Per ulteriori informazioni, consulta i codici di stato e di errore per JSON e XML.

Identità

Una richiesta idempotente può essere eseguita ripetutamente e lascia sempre la risorsa di destinazione nello stesso stato finale. Ad esempio, le richieste di scheda sono sempre idempotenti, perché non modificano le risorse. La creazione di una nuova notifica Pub/Sub, invece, non è mai idempotente, perché viene creato un nuovo ID notifica ogni volta che la richiesta va a buon fine.

Di seguito sono riportati alcuni esempi di condizioni che rendono un'operazione idempotente:

  • L'operazione ha lo stesso effetto osservabile sulla risorsa di destinazione anche se viene richiesta continuamente.

  • L'operazione riesce una sola volta.

  • L'operazione non ha alcun effetto osservabile sullo stato della risorsa di destinazione.

Quando ricevi una risposta ripetibile, devi considerare l'idempotenza della richiesta, perché la ripetizione delle richieste non idempotenti può portare a condizioni di gara e altri conflitti.

Identità condizionale

Un sottoinsieme di richieste è condizionatamente idempotente, il che significa che sono idempotenti solo se includono argomenti facoltativi specifici. Per impostazione predefinita, le operazioni per le quali è possibile eseguire nuovamente il tentativo in modo condizionatamente sicuro devono essere ripetute solo se la condizione della casella viene soddisfatta. Cloud Storage accetta precondizioni ed ETag come condizioni per le richieste.

Identità delle operazioni

La tabella seguente elenca le operazioni di Cloud Storage che rientrano in ogni categoria di iridempicità.

Identità Operazioni
Sempre idempotente
  • Tutte le richieste GET e LIST
  • Inserire o eliminare bucket
  • Testare i criteri e le autorizzazioni IAM del bucket
  • Bloccare i criteri di conservazione
  • Eliminare una chiave HMAC o una notifica Pub/Sub
Condizionalmente idempotente
  • Richieste di aggiornamento/patch per i bucket con IfMetagenerationMatch1 o etag1 come precondizione HTTP
  • Richieste di aggiornamento/patch per oggetti con IfMetagenerationMatch1 o etag1 come precondizione HTTP
  • Imposta un criterio IAM del bucket con etag1 come precondizione HTTP o nel corpo della risorsa
  • Aggiornare una chiave HMAC con etag1 come precondizione HTTP o nel corpo della risorsa
  • Inserire, copiare, comporre o riscrivere oggetti con ifGenerationMatch1
  • Elimina un oggetto con ifGenerationMatch1 (o con un numero di generazione per le versioni dell'oggetto)
Mai idempotente
  • Creare una chiave HMAC
  • Creare una notifica Pub/Sub
  • Crea, elimina o invia richieste di patch/aggiornamento per gli ACL dei bucket e degli oggetti o per gli ACL degli oggetti predefiniti

1Questo campo è disponibile per l'utilizzo nell'API JSON. Per i campi disponibili per l'utilizzo nelle librerie client, consulta la documentazione della libreria client pertinente.

Come gli strumenti di Cloud Storage implementano le strategie di ripetizione

Console

La console Google Cloud invia richieste a Cloud Storage per tuo conto e gestisce eventuali ritardi necessari.

Riga di comando

I comandi gcloud storage riprovano a correggere gli errori elencati nella sezione Risposta senza che tu debba intraprendere ulteriori azioni. Potresti dover intervenire per altri errori, ad esempio:

  • Credenziali non valide o autorizzazioni insufficienti.

  • La rete non è raggiungibile a causa di un problema di configurazione del proxy.

Per gli errori ripetibili, l'interfaccia a riga della gcloud CLI riprova le richieste utilizzando una strategia di backoff esponenziale binario troncata. Il numero predefinito di nuovi tentativi massimi è 32 per gcloud CLI.

Librerie client

C++

Per impostazione predefinita, le operazioni supportano i tentativi di nuovo per i seguenti codici di errore HTTP, nonché eventuali errori di socket che indicano che la connessione è andata persa o non è mai stata stabilita correttamente.

  • 408 Request Timeout
  • 429 Too Many Requests
  • 500 Internal Server Error
  • 502 Bad Gateway
  • 503 Service Unavailable
  • 504 Gateway Timeout

Tutte le impostazioni di backoff esponenziale e di nuovo tentativo nella libreria C++ sono configurabili. Se gli algoritmi implementati nella libreria non supportano le tue esigenze, puoi fornire codice personalizzato per implementare le tue strategie.

Impostazione Valore predefinito
Nuovo tentativo automatico Vero
Tempo massimo per il nuovo tentativo di invio di una richiesta 15 minuti
Tempo di attesa iniziale (backoff) 1 secondo
Moltiplicatore del tempo di attesa per iterazione 2
Tempo di attesa massimo 5 minuti

Per impostazione predefinita, la libreria C++ riprova tutte le operazioni con errori ripetibili, anche quelle che non sono mai idempotenti e possono eliminare o creare più risorse se andate a buon fine ripetutamente. Per riprovare solo le operazioni idempotenti, utilizza la classe google::cloud::storage::StrictIdempotencyPolicy.

C#

Per impostazione predefinita, la libreria client C# utilizza il backoff esponenziale.

Vai

Per impostazione predefinita, le operazioni supportano i tentativi di nuovo invio per i seguenti errori:

  • Errori di connessione:
    • io.ErrUnexpectedEOF: questo può verificarsi a causa di problemi temporanei della rete.
    • url.Error contenente connection refused: questo potrebbe verificarsi a causa di problemi di rete temporanei.
    • url.Error contenente connection reset by peer: significa che Google Cloud ha reimpostato la connessione.
    • net.ErrClosed: significa che Google Cloud ha chiuso la connessione.
  • Codici HTTP:
    • 408 Request Timeout
    • 429 Too Many Requests
    • 500 Internal Server Error
    • 502 Bad Gateway
    • 503 Service Unavailable
    • 504 Gateway Timeout
  • Errori che implementano l'interfaccia Temporary() e forniscono un valore err.Temporary() == true
  • Eventuali errori sopra indicati che sono stati racchiusi utilizzando il contenimento degli errori di Go 1.13

Tutte le impostazioni di backoff esponenziale nella libreria Go sono configurabili. Per impostazione predefinita, le operazioni in Go utilizzano le seguenti impostazioni per il backoff esponenziale (quelle predefinite sono prese da gax):

Impostazione Valore predefinito (in secondi)
Nuovo tentativo automatico True se idempotente
Numero massimo di tentativi Nessun limite
Ritardo nuovo tentativo iniziale 1 secondo
Moltiplicatore del ritardo del nuovo tentativo 2.0
Ritardo massimo nuovo tentativo 30 secondi
Tempo di attesa totale (chunk di caricamento ripristinabile) 32 secondi
Timeout totale (tutte le altre operazioni) Nessun limite

In genere, i tentativi di nuovo avvengono indefinitamente, a meno che il contesto di controllo non venga annullato, il client non venga chiuso o non venga ricevuto un errore non transitorio. Per interrompere la continuazione dei tentativi, utilizza i timeout o l'annullamento del contesto. L'unica eccezione a questo comportamento si verifica quando esegui caricamenti riavviabili utilizzando Writer, se i dati sono sufficientemente grandi da richiedere più richieste. In questo scenario, per impostazione predefinita ogni frammento scade e smette di riprovare dopo 32 secondi. Puoi aggiustare il timeout predefinito modificando Writer.ChunkRetryDeadline.

Esiste un sottoinsieme di operazioni Go che sono condizionatamente idempotenti (è possibile riprovare in sicurezza). Queste operazioni vengono riprovate solo sesoddisfano condizioni specifiche:

  • GenerationMatch o Generation

    • È possibile riprovare se alla chiamata è stato applicato un prerequisito GenerationMatch o se è stato impostato ObjectHandle.Generation.

  • MetagenerationMatch

    • È possibile riprovare se alla chiamata è stata applicata una precondizione MetagenerationMatch.

  • Etag

    • È possibile riprovare se il metodo inserisce un etag nel corpo della richiesta JSON. Viene utilizzato solo in HMACKeyHandle.Update se è stato impostato HmacKeyMetadata.Etag.

RetryPolicy è impostato su RetryPolicy.RetryIdempotent per impostazione predefinita. Consulta Personalizzare i tentativi di nuovo invio per esempi su come modificare il comportamento predefinito dei tentativi di nuovo invio.

Java

Per impostazione predefinita, le operazioni supportano i tentativi di nuovo invio per i seguenti errori:

  • Errori di connessione:
    • Connection reset by peer: significa che Google Cloud ha reimpostato la connessione.
    • Unexpected connection closure: significa che Google Cloud ha chiuso la connessione.
  • Codici HTTP:
    • 408 Request Timeout
    • 429 Too Many Requests
    • 500 Internal Server Error
    • 502 Bad Gateway
    • 503 Service Unavailable
    • 504 Gateway Timeout

Tutte le impostazioni di backoff esponenziale nella libreria Java sono configurabili. Per impostazione predefinita, le operazioni tramite Java utilizzano le seguenti impostazioni per il backoff esponenziale:

Impostazione Valore predefinito (in secondi)
Nuovo tentativo automatico True se idempotente
Numero massimo di tentativi 6
Ritardo nuovo tentativo iniziale 1 secondo
Moltiplicatore del ritardo del nuovo tentativo 2.0
Ritardo massimo nuovo tentativo 32 secondi
Timeout totale 50 secondi
Tempo di attesa RPC iniziale 50 secondi
Multiplicatore del tempo di attesa RPC 1,0
Tempo di attesa RPC massimo 50 secondi
Timeout connessione 20 secondi
Timeout di lettura 20 secondi

Per ulteriori informazioni sulle impostazioni, consulta la documentazione di riferimento Java per RetrySettings.Builder e HttpTransportOptions.Builder.

Esiste un sottoinsieme di operazioni Java che sono condizionesamente idempotenti (condizionesamente sicure per i tentativi di nuovo invio). Queste operazioni ritentano solo se includono argomenti specifici:

  • ifGenerationMatch o generation

    • È possibile riprovare se ifGenerationMatch o generation è stato passato come opzione al metodo.

  • ifMetagenerationMatch

    • È possibile riprovare se ifMetagenerationMatch è stato passato come opzione.

StorageOptions.setStorageRetryStrategy è impostato su StorageRetryStrategy#getDefaultStorageRetryStrategy per impostazione predefinita. Consulta Personalizzare i tentativi ripetuti per esempi su come modificare il comportamento predefinito dei tentativi ripetuti.

Node.js

Per impostazione predefinita, le operazioni supportano i tentativi di nuovo invio per i seguenti codici di errore:

  • Errori di connessione:
    • EAI_again: si tratta di un errore di ricerca DNS. Per ulteriori informazioni, consulta la documentazione di getaddrinfo.
    • Connection reset by peer: significa che Google Cloud ha reimpostato la connessione.
    • Unexpected connection closure: significa che Google Cloud ha chiuso la connessione.
  • Codici HTTP:
    • 408 Request Timeout
    • 429 Too Many Requests
    • 500 Internal Server Error
    • 502 Bad Gateway
    • 503 Service Unavailable
    • 504 Gateway Timeout

Tutte le impostazioni di backoff esponenziale nella libreria Node.js sono configurabili. Per impostazione predefinita, le operazioni tramite Node.js utilizzano le seguenti impostazioni per il backoff esponenziale:

Impostazione Valore predefinito (in secondi)
Nuovo tentativo automatico True se idempotente
Numero massimo di nuovi tentativi 3
Tempo di attesa iniziale 1 secondo
Moltiplicatore del tempo di attesa per iterazione 2
Tempo di attesa massimo 64 secondi
Scadenza predefinita 600 secondi

Esiste un sottoinsieme di operazioni Node.js che sono condizione simili (è possibile riprovare in sicurezza). Queste operazioni vengono riprovate solo se includono argomenti specifici:

  • ifGenerationMatch o generation

    • È possibile riprovare se ifGenerationMatch o generation è stato passato come opzione al metodo. Spesso i metodi accettano solo uno di questi due parametri.

  • ifMetagenerationMatch

    • È possibile riprovare se ifMetagenerationMatch è stato passato come opzione.

retryOptions.idempotencyStrategy è impostato su IdempotencyStrategy.RetryConditional per impostazione predefinita. Consulta Personalizzare i tentativi di nuovo invio per esempi su come modificare il comportamento predefinito dei tentativi di nuovo invio.

PHP

Per impostazione predefinita, la libreria client PHP utilizza il backoff esponenziale.

Python

Per impostazione predefinita, le operazioni supportano i tentativi di nuovo invio per i seguenti codici di errore:

  • Errori di connessione:
    • requests.exceptions.ConnectionError
    • requests.exceptions.ChunkedEncodingError (solo per le operazioni che recuperano o inviano dati del payload agli oggetti, come caricamenti e download)
    • ConnectionError
  • Codici HTTP:
    • 408 Request Timeout
    • 429 Too Many Requests
    • 500 Internal Server Error
    • 502 Bad Gateway
    • 503 Service Unavailable
    • 504 Gateway Timeout

Le operazioni tramite Python utilizzano le seguenti impostazioni predefinite per il backoff esponenziale:

Impostazione Valore predefinito (in secondi)
Nuovo tentativo automatico True se idempotente
Tempo di attesa iniziale 1
Moltiplicatore del tempo di attesa per iterazione 2
Tempo di attesa massimo 60
Scadenza predefinita 120

Esiste un sottoinsieme di operazioni Python che sono condizionatamente idempotenti (è possibile riprovare in sicurezza) quando includono argomenti specifici. Queste operazioni vengono riprovate solo se viene soddisfatta una condizione:

  • DEFAULT_RETRY_IF_GENERATION_SPECIFIED

    • È possibile riprovare se generation o if_generation_match è stato passato come argomento al metodo. Spesso i metodi accettano solo uno di questi due parametri.

  • DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED

    • È possibile riprovare se if_metageneration_match è stato passato come argomento al metodo.

  • DEFAULT_RETRY_IF_ETAG_IN_JSON

    • È possibile riprovare se il metodo inserisce un etag nel corpo della richiesta JSON. Per HMACKeyMetadata.update(), significa che l'etag deve essere impostato sull'oggetto HMACKeyMetadata stesso. Per il metodo set_iam_policy() in altre classi, ciò significa che l'etag deve essere impostato nell'argomento "policy" passato al metodo.

Ruby

Per impostazione predefinita, le operazioni supportano i tentativi di nuovo invio per i seguenti codici di errore:

  • Errori di connessione:
    • SocketError
    • HTTPClient::TimeoutError
    • Errno::ECONNREFUSED
    • HTTPClient::KeepAliveDisconnected
  • Codici HTTP:
    • 408 Request Timeout
    • 429 Too Many Requests
    • 5xx Server Error

Tutte le impostazioni di backoff esponenziale nella libreria client Ruby sono configurabili. Per impostazione predefinita, le operazioni tramite la libreria client Ruby utilizzano le seguenti impostazioni per il backoff esponenziale:

Impostazione Valore predefinito
Nuovo tentativo automatico Vero
Numero massimo di nuovi tentativi 3
Tempo di attesa iniziale 1 secondo
Moltiplicatore del tempo di attesa per iterazione 2
Tempo di attesa massimo 60 secondi
Scadenza predefinita 900 secondi

Esiste un sottoinsieme di operazioni Ruby che sono condizionatamente idempotenti (è possibile riprovare in sicurezza) quando includono argomenti specifici:

  • if_generation_match o generation

    • È possibile riprovare se il parametro generation o if_generation_match viene passato come argomento al metodo. Spesso i metodi accettano solo uno di questi due parametri.

  • if_metageneration_match

    • È possibile riprovare se il parametro if_metageneration_match viene passato come opzione.

Per impostazione predefinita, viene eseguito un nuovo tentativo per tutte le operazioni idempotenti e per le operazioni idempotenti condizionali solo se la condizione è soddisfatta. Le operazioni non idempotenti non vengono ripetute. Consulta Personalizzare i tentativi di nuovo invio per esempi su come modificare il comportamento predefinito dei tentativi di nuovo invio.

API REST

Quando chiami direttamente l'API JSON o XML, devi utilizzare l'algoritmo di backoff esponenziale per implementare la tua strategia di nuovo tentativo.

Personalizzazione dei nuovi tentativi

Console

Non puoi personalizzare il comportamento dei tentativi di nuovo utilizzando la console Google Cloud.

Riga di comando

Per i comandi gcloud storage, puoi controllare la strategia di ripetizione creando una configurazione denominata e impostando alcune o tutte le seguenti proprietà:

  • base_retry_delay
  • exponential_sleep_multiplier
  • max_retries
  • max_retry_delay

Poi applichi la configurazione definita su base per comando utilizzando il flag --configuration a livello di progetto o per tutti i comandi gcloud utilizzando il comando gcloud config set.

Librerie client

C++

Per personalizzare il comportamento di ripetizione dei tentativi, fornisci i valori per le seguenti opzioni quando inizializzi l'oggetto google::cloud::storage::Client:

  • google::cloud::storage::RetryPolicyOption: la libreria fornisce i corsi google::cloud::storage::LimitedErrorCountRetryPolicy e google::cloud::storage::LimitedTimeRetryPolicy. Puoi fornire la tua classe, che deve implementare l'interfaccia google::cloud::RetryPolicy.

  • google::cloud::storage::BackoffPolicyOption: la libreria fornisce la classe google::cloud::storage::ExponentialBackoffPolicy. Puoi fornire la tua classe, che deve implementare l'interfaccia google::cloud::storage::BackoffPolicy.

  • google::cloud::storage::IdempotencyPolicyOption: la libreria fornisce i tipi google::cloud::storage::StrictIdempotencyPolicy e google::cloud::storage::AlwaysRetryIdempotencyPolicy. Puoi fornire la tua classe, che deve implementare l'interfaccia google::cloud::storage::IdempotencyPolicy.

Per saperne di più, consulta la documentazione di riferimento della libreria client C++. 

namespace gcs = ::google::cloud::storage;
// Create the client configuration:
auto options = google::cloud::Options{};
// Retries only idempotent operations.
options.set<gcs::IdempotencyPolicyOption>(
    gcs::StrictIdempotencyPolicy().clone());
// On error, it backs off for a random delay between [1, 3] seconds, then [3,
// 9] seconds, then [9, 27] seconds, etc. The backoff time never grows larger
// than 1 minute.
options.set<gcs::BackoffPolicyOption>(
    gcs::ExponentialBackoffPolicy(
        /*initial_delay=*/std::chrono::seconds(1),
        /*maximum_delay=*/std::chrono::minutes(1),
        /*scaling=*/3.0)
        .clone());
// Retries all operations for up to 5 minutes, including any backoff time.
options.set<gcs::RetryPolicyOption>(
    gcs::LimitedTimeRetryPolicy(std::chrono::minutes(5)).clone());
return gcs::Client(std::move(options));

C#

Non puoi personalizzare la strategia di ripetizione predefinita utilizzata dalla libreria client C#.

Vai

Quando viene inizializzato un client di archiviazione, viene impostata una configurazione di ripetizione predefinita. A meno che non vengano sostituite, le opzioni nella configurazione sono impostate sui valori predefiniti. Gli utenti possono configurare il comportamento di ripetizione non predefinito per una singola chiamata alla libreria (utilizzando BucketHandle.Retryer e ObjectHandle.Retryer) o per tutte le chiamate effettuate da un client (utilizzando Client.SetRetry). Per modificare il comportamento di ripetizione, passa RetryOptions pertinente a uno di questi metodi.

Consulta il seguente esempio di codice per scoprire come personalizzare il comportamento di ripetizione.

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/storage"
	"github.com/googleapis/gax-go/v2"
)

// configureRetries configures a custom retry strategy for a single API call.
func configureRetries(w io.Writer, bucket, object string) error {
	// bucket := "bucket-name"
	// object := "object-name"
	ctx := context.Background()
	client, err := storage.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("storage.NewClient: %w", err)
	}
	defer client.Close()

	// Configure retries for all operations using this ObjectHandle. Retries may
	// also be configured on the BucketHandle or Client types.
	o := client.Bucket(bucket).Object(object).Retryer(
		// Use WithBackoff to control the timing of the exponential backoff.
		storage.WithBackoff(gax.Backoff{
			// Set the initial retry delay to a maximum of 2 seconds. The length of
			// pauses between retries is subject to random jitter.
			Initial: 2 * time.Second,
			// Set the maximum retry delay to 60 seconds.
			Max: 60 * time.Second,
			// Set the backoff multiplier to 3.0.
			Multiplier: 3,
		}),
		// Use WithPolicy to customize retry so that all requests are retried even
		// if they are non-idempotent.
		storage.WithPolicy(storage.RetryAlways),
	)

	// Use context timeouts to set an overall deadline on the call, including all
	// potential retries.
	ctx, cancel := context.WithTimeout(ctx, 500*time.Second)
	defer cancel()

	// Delete an object using the specified retry policy.
	if err := o.Delete(ctx); err != nil {
		return fmt.Errorf("Object(%q).Delete: %w", object, err)
	}
	fmt.Fprintf(w, "Blob %v deleted with a customized retry strategy.\n", object)
	return nil
}

Java

Quando viene inizializzato Storage, viene inizializzata anche un'istanza di RetrySettings. A meno che non vengano superate, le opzioni in RetrySettings sono impostate sui valori predefiniti. Per modificare il comportamento di ripetizione automatica predefinito, passa il StorageRetryStrategy personalizzato al StorageOptions utilizzato per creare l'istanza Storage. Per modificare uno degli altri parametri scalari, passa un RetrySettings personalizzato al StorageOptions utilizzato per creare l'istanza Storage.

Consulta l'esempio seguente per scoprire come personalizzare il comportamento di ripetizione:


import com.google.api.gax.retrying.RetrySettings;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import com.google.cloud.storage.StorageRetryStrategy;
import org.threeten.bp.Duration;

public final class ConfigureRetries {
  public static void main(String[] args) {
    String bucketName = "my-bucket";
    String blobName = "blob/to/delete";
    deleteBlob(bucketName, blobName);
  }

  static void deleteBlob(String bucketName, String blobName) {
    // Customize retry behavior
    RetrySettings retrySettings =
        StorageOptions.getDefaultRetrySettings()
            .toBuilder()
            // Set the max number of attempts to 10 (initial attempt plus 9 retries)
            .setMaxAttempts(10)
            // Set the backoff multiplier to 3.0
            .setRetryDelayMultiplier(3.0)
            // Set the max duration of all attempts to 5 minutes
            .setTotalTimeout(Duration.ofMinutes(5))
            .build();

    StorageOptions alwaysRetryStorageOptions =
        StorageOptions.newBuilder()
            // Customize retry so all requests are retried even if they are non-idempotent.
            .setStorageRetryStrategy(StorageRetryStrategy.getUniformStorageRetryStrategy())
            // provide the previously configured retrySettings
            .setRetrySettings(retrySettings)
            .build();

    // Instantiate a client
    Storage storage = alwaysRetryStorageOptions.getService();

    // Delete the blob
    BlobId blobId = BlobId.of(bucketName, blobName);
    boolean success = storage.delete(blobId);

    System.out.printf(
        "Deletion of Blob %s completed %s.%n", blobId, success ? "successfully" : "unsuccessfully");
  }
}

Node.js

Quando inizializzazione Cloud Storage, viene inizializzato anche un file di configurazione retryOptions. A meno che non vengano sostituite, le opzioni nella configurazione sono impostate sui valori predefiniti. Per modificare il comportamento di ripetizione predefinito, passa la configurazione di ripetizione personalizzata retryOptions al costruttore dello spazio di archiviazione all'inizializzazione. La libreria client Node.js può utilizzare automaticamente le strategie di backoff per ritentare le richieste con il parametro autoRetry.

Consulta il seguente esempio di codice per scoprire come personalizzare il comportamento di ripetizione.

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// The ID of your GCS bucket
// const bucketName = 'your-unique-bucket-name';

// The ID of your GCS file
// const fileName = 'your-file-name';

// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');

// Creates a client
const storage = new Storage({
  retryOptions: {
    // If this is false, requests will not retry and the parameters
    // below will not affect retry behavior.
    autoRetry: true,
    // The multiplier by which to increase the delay time between the
    // completion of failed requests, and the initiation of the subsequent
    // retrying request.
    retryDelayMultiplier: 3,
    // The total time between an initial request getting sent and its timeout.
    // After timeout, an error will be returned regardless of any retry attempts
    // made during this time period.
    totalTimeout: 500,
    // The maximum delay time between requests. When this value is reached,
    // retryDelayMultiplier will no longer be used to increase delay time.
    maxRetryDelay: 60,
    // The maximum number of automatic retries attempted before returning
    // the error.
    maxRetries: 5,
    // Will respect other retry settings and attempt to always retry
    // conditionally idempotent operations, regardless of precondition
    idempotencyStrategy: IdempotencyStrategy.RetryAlways,
  },
});
console.log(
  'Functions are customized to be retried according to the following parameters:'
);
console.log(`Auto Retry: ${storage.retryOptions.autoRetry}`);
console.log(
  `Retry delay multiplier: ${storage.retryOptions.retryDelayMultiplier}`
);
console.log(`Total timeout: ${storage.retryOptions.totalTimeout}`);
console.log(`Maximum retry delay: ${storage.retryOptions.maxRetryDelay}`);
console.log(`Maximum retries: ${storage.retryOptions.maxRetries}`);
console.log(
  `Idempotency strategy: ${storage.retryOptions.idempotencyStrategy}`
);

async function deleteFileWithCustomizedRetrySetting() {
  await storage.bucket(bucketName).file(fileName).delete();
  console.log(`File ${fileName} deleted with a customized retry strategy.`);
}

deleteFileWithCustomizedRetrySetting();

PHP

Non puoi personalizzare la strategia di ripetizione predefinita utilizzata dalla libreria client PHP.

Python

Per modificare il comportamento di ripetizione predefinito, crea una copia dell'oggetto google.cloud.storage.retry.DEFAULT_RETRY chiamandolo con un metodo with_XXX. La libreria client Python utilizza automaticamente strategie di backoff per riprovare le richieste se includi il parametro DEFAULT_RETRY.

Tieni presente che with_predicate non è supportato per le operazioni che recuperano o inviano dati del payload agli oggetti, come caricamenti e download. Ti consigliamo di modificare gli attributi uno alla volta. Per ulteriori informazioni, consulta la documentazione di riferimento su Retry di google-api-core.

Per configurare il tuo nuovo tentativo condizionale, crea un oggetto ConditionalRetryPolicy e avvolgi l'oggetto Retry personalizzato con DEFAULT_RETRY_IF_GENERATION_SPECIFIED, DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED o DEFAULT_RETRY_IF_ETAG_IN_JSON.

Consulta il seguente esempio di codice per scoprire come personalizzare il comportamento di ripetizione.

from google.cloud import storage
from google.cloud.storage.retry import DEFAULT_RETRY


def configure_retries(bucket_name, blob_name):
    """Configures retries with customizations."""
    # The ID of your GCS bucket
    # bucket_name = "your-bucket-name"
    # The ID of your GCS object
    # blob_name = "your-object-name"

    storage_client = storage.Client()
    bucket = storage_client.bucket(bucket_name)
    blob = bucket.blob(blob_name)

    # Customize retry with a deadline of 500 seconds (default=120 seconds).
    modified_retry = DEFAULT_RETRY.with_deadline(500.0)
    # Customize retry with an initial wait time of 1.5 (default=1.0).
    # Customize retry with a wait time multiplier per iteration of 1.2 (default=2.0).
    # Customize retry with a maximum wait time of 45.0 (default=60.0).
    modified_retry = modified_retry.with_delay(initial=1.5, multiplier=1.2, maximum=45.0)

    # blob.delete() uses DEFAULT_RETRY_IF_GENERATION_SPECIFIED by default.
    # Override with modified_retry so the function retries even if the generation
    # number is not specified.
    print(
        f"The following library method is customized to be retried according to the following configurations: {modified_retry}"
    )

    blob.delete(retry=modified_retry)
    print(f"Blob {blob_name} deleted with a customized retry strategy.")

Ruby

Quando viene inizializzato il client di archiviazione, tutte le configurazioni di ripetizione vengono impostate su i valori mostrati nella tabella sopra. Per modificare il comportamento di riprova predefinito, passa le configurazioni di riprova durante l'inizializzazione del client di archiviazione.

Per ignorare il numero di tentativi per una determinata operazione, passa retries nel parametro options dell'operazione.

def configure_retries bucket_name: nil, file_name: nil
  # The ID of your GCS bucket
  # bucket_name = "your-unique-bucket-name"

  # The ID of your GCS object
  # file_name = "your-file-name"

  require "google/cloud/storage"

  # Creates a client
  storage = Google::Cloud::Storage.new(

    # The maximum number of automatic retries attempted before returning
    # the error.
    #
    # Customize retry configuration with the maximum retry attempt of 5.
    retries: 5,

    # The total time in seconds that requests are allowed to keep being retried.
    # After max_elapsed_time, an error will be returned regardless of any
    # retry attempts made during this time period.
    #
    # Customize retry configuration with maximum elapsed time of 500 seconds.
    max_elapsed_time: 500,

    # The initial interval between the completion of failed requests, and the
    # initiation of the subsequent retrying request.
    #
    # Customize retry configuration with an initial interval of 1.5 seconds.
    base_interval: 1.5,

    # The maximum interval between requests. When this value is reached,
    # multiplier will no longer be used to increase the interval.
    #
    # Customize retry configuration with maximum interval of 45.0 seconds.
    max_interval: 45,

    # The multiplier by which to increase the interval between the completion
    # of failed requests, and the initiation of the subsequent retrying request.
    #
    # Customize retry configuration with an interval multiplier per iteration of 1.2.
    multiplier: 1.2
  )

  # Uses the retry configuration set during the client initialization above with 5 retries
  file = storage.service.get_file bucket_name, file_name

  # Maximum retry attempt can be overridden for each operation using options parameter.
  storage.service.delete_file bucket_name, file_name, options: { retries: 4 }
  puts "File #{file.name} deleted with a customized retry strategy."
end

API REST

Utilizza l'algoritmo di backoff esponenziale per implementare la tua strategia di ripetizione.

Algoritmo di backoff esponenziale

Un algoritmo di backoff esponenziale riprova le richieste utilizzando tempi di attesa in aumento esponenziale tra le richieste, fino a un tempo di backoff massimo. In genere, dovresti utilizzare il backoff esponenziale con jitter per eseguire nuovamente le richieste che soddisfano sia i criteri di risposta sia quelli di iridempicità. Per le best practice sull'implementazione di tentativi automatici con backoff esponenziale, consulta Risolvere i guasti a cascata.

Passaggi successivi