Errori

Questo capitolo fornisce una panoramica del modello di errore per le API di Google. Fornisce inoltre indicazioni generali agli sviluppatori su come generare e gestire correttamente gli errori.

Le API di Google utilizzano un modello di errore semplice indipendente dal protocollo, che ci permette di offrire un'esperienza coerente su diverse API, diversi protocolli API (ad esempio gRPC o HTTP) e diversi contesti di errore (come errori asincroni, batch o di flusso di lavoro).

Modello di errore

Il modello di errore per le API di Google è definito logicamente da google.rpc.Status, un'istanza la cui istanza viene restituita al client quando si verifica un errore dell'API. Il seguente snippet di codice mostra la progettazione generale del modello di errore:

package google.rpc;

// The `Status` type defines a logical error model that is suitable for
// different programming environments, including REST APIs and RPC APIs.
message Status {
  // A simple error code that can be easily handled by the client. The
  // actual error code is defined by `google.rpc.Code`.
  int32 code = 1;

  // A developer-facing human-readable error message in English. It should
  // both explain the error and offer an actionable resolution to it.
  string message = 2;

  // Additional error information that the client code can use to handle
  // the error, such as retry info or a help link.
  repeated google.protobuf.Any details = 3;
}

Poiché la maggior parte delle API di Google utilizza una progettazione di API orientata alle risorse, la gestione degli errori segue lo stesso principio di progettazione, utilizzando un piccolo insieme di errori standard con un numero elevato di risorse. Ad esempio, anziché definire tipi diversi di errori "non trovati", il server utilizza un codice di errore google.rpc.Code.NOT_FOUND standard e indica al client quale risorsa specifica non è stata trovata. Lo spazio di errore più ridotto riduce la complessità della documentazione, offre migliori mappature idiomatiche nelle librerie client e riduce la complessità della logica del client, senza limitare l'inclusione di informazioni strategiche.

Nota: quando utilizzi gRPC, gli errori sono inclusi nelle intestazioni e le intestazioni totali nelle risposte sono limitate a 8 KB (8192 byte). Assicurati che le dimensioni degli errori non superino 1-2 kB.

Codici di errore

Le API di Google devono utilizzare i codici di errore canonici definiti da google.rpc.Code. Le singole API devono evitare di definire codici di errore aggiuntivi, poiché è improbabile che gli sviluppatori scrivano una logica per gestire un numero elevato di codici di errore. Per riferimento, la gestione di una media di tre codici di errore per chiamata API significherebbe che la maggior parte della logica dell'applicazione sarà solo per la gestione degli errori, il che non sarebbe una buona esperienza per sviluppatori.

Messaggi di errore

Il messaggio di errore deve aiutare gli utenti a comprendere e risolvere l'errore dell'API in modo facile e veloce. In generale, durante la scrittura dei messaggi di errore, segui queste linee guida:

• Non dare per scontato che l'utente sia un utente esperto della tua API. Può trattarsi di sviluppatori client, personale operativo, personale IT o utenti finali delle app.
• Non dare per scontato che l'utente sappia qualcosa sull'implementazione del servizio o che conosca il contesto degli errori (ad esempio, l'analisi dei log).
• Quando possibile, i messaggi di errore devono essere costruiti in modo che un utente tecnico (ma non necessariamente uno sviluppatore dell'API) possa rispondere all'errore e correggerlo.
• Il messaggio di errore deve essere breve. Se necessario, fornisci un link in cui un lettore confuso può porre domande, fornire feedback o ottenere ulteriori informazioni che non rientrano in un messaggio di errore. Altrimenti, utilizza il campo dei dettagli per espanderlo.

Avviso: i messaggi di errore non fanno parte della piattaforma API. e sono soggetti a modifiche senza preavviso. Il codice dell'applicazione non deve avere una dipendenza rigida dai messaggi di errore.

Dettagli errore

Le API di Google definiscono un insieme di payload degli errori standard per i dettagli degli errori, che puoi trovare in google/rpc/error_details.proto. Includono le esigenze più comuni per gli errori delle API, come gli errori di quota e i parametri non validi. Come per i codici di errore, gli sviluppatori dovrebbero usare questi payload standard, se possibile.

Devono essere introdotti altri tipi di dettagli di errore solo se possono aiutare il codice dell'applicazione a gestire gli errori. Se le informazioni di errore possono essere gestite soltanto da persone, affidati ai contenuti dei messaggi di errore e lascia che gli sviluppatori le gestiscano manualmente, anziché introdurre altri tipi di dettagli di errore.

Ecco alcuni esempi di payload di error_details:

• ErrorInfo: fornisce informazioni sugli errori strutturati stabili ed estendibili.
• RetryInfo: indica quando i client possono riprovare una richiesta non riuscita, possono essere ripristinati il giorno Code.UNAVAILABLE o Code.ABORTED
• QuotaFailure: descrive come un controllo della quota non può essere restituito, il giorno Code.RESOURCE_EXHAUSTED
• BadRequest: descrive le violazioni in una richiesta del cliente, che possono essere restituite il giorno Code.INVALID_ARGUMENT

Informazioni sull'errore

ErrorInfo è un tipo speciale di payload degli errori. Fornisce informazioni sugli errori stabili ed estensibili da cui possono dipendere persone e applicazioni. Ogni ErrorInfo ha tre informazioni: un dominio di errore, un motivo di errore e un set di metadati di errore, come questo esempio. Per ulteriori informazioni, consulta la definizione di ErrorInfo.

Per le API di Google, il dominio di errore principale è googleapis.com e i motivi di errore corrispondenti sono definiti da google.api.ErrorReason enum. Per ulteriori informazioni, consulta la definizione di google.api.ErrorReason.

Localizzazione errore

Il campo message in google.rpc.Status è rivolto agli sviluppatori e deve essere in inglese.

Se è necessario un messaggio di errore rivolto agli utenti, utilizza google.rpc.LocalizedMessage come campo dei dettagli. Anche se il campo del messaggio in google.rpc.LocalizedMessage può essere localizzato, assicurati che il campo del messaggio in google.rpc.Status sia in inglese.

Per impostazione predefinita, il servizio API deve utilizzare le impostazioni internazionali dell'utente autenticato o l'intestazione HTTP Accept-Language o il parametro language_code nella richiesta per determinare la lingua per la localizzazione.

Mappatura degli errori

Le API di Google sono accessibili in diversi ambienti di programmazione. In genere, ogni ambiente dispone di una propria gestione degli errori. Le seguenti sezioni spiegano come viene mappato il modello di errore negli ambienti di uso comune.

Mappatura HTTP

Anche se i messaggi proto3 hanno una codifica JSON nativa, la piattaforma API di Google utilizza uno schema di errore diverso per le API HTTP JSON di Google per motivi di compatibilità con le versioni precedenti.

Schema:

// This message defines the error schema for Google's JSON HTTP APIs.
message Error {
  // Deprecated. This message is only used by error format v1.
  message ErrorProto {}
  // This message has the same semantics as `google.rpc.Status`. It uses HTTP
  // status code instead of gRPC status code. It has extra fields `status` and
  // `errors` for backward compatibility with [Google API Client
  // Libraries](https://developers.google.com/api-client-library).
  message Status {
    // The HTTP status code that corresponds to `google.rpc.Status.code`.
    int32 code = 1;
    // This corresponds to `google.rpc.Status.message`.
    string message = 2;
    // Deprecated. This field is only used by error format v1.
    repeated ErrorProto errors = 3;
    // This is the enum version for `google.rpc.Status.code`.
    google.rpc.Code status = 4;
    // This corresponds to `google.rpc.Status.details`.
    repeated google.protobuf.Any details = 5;
  }
  // The actual error payload. The nested message structure is for backward
  // compatibility with [Google API Client
  // Libraries](https://developers.google.com/api-client-library). It also
  // makes the error more readable to developers.
  Status error = 1;
}

Esempio (link):

{
  "error": {
    "code": 400,
    "message": "API key not valid. Please pass a valid API key.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "API_KEY_INVALID",
        "domain": "googleapis.com",
        "metadata": {
          "service": "translate.googleapis.com"
        }
      }
    ]
  }
}

Mappatura gRPC

I diversi protocolli RPC mappano il modello di errore in modo diverso. Per gRPC, il modello di errore è supportato in modo nativo dal codice generato e dalla libreria di runtime in ogni linguaggio supportato. Potete trovare ulteriori informazioni nella documentazione dell'API gRPC. Ad esempio, consulta io.grpc.Status Java di gRPC.

Mappatura della libreria client

Le librerie client di Google possono scegliere di mostrare errori in modo diverso per ogni lingua, in linea con gli idiomi consolidati. Ad esempio, la libreria google-cloud-go restituisce un errore che implementa la stessa interfaccia di google.rpc.Status, mentre google-cloud-java genera un'eccezione.

Gestione degli errori

Di seguito è riportata una tabella contenente tutti i codici di errore gRPC definiti in google.rpc.Code e una breve descrizione della causa. Per gestire un errore, puoi controllare la descrizione del codice di stato restituito e modificare la chiamata di conseguenza.

HTTP	gRPC	Descrizione
200	OK	Nessun errore.
400	INVALID_ARGUMENT	Il client ha specificato un argomento non valido. Per saperne di più, consulta il messaggio e i dettagli dell'errore.
400	FAILED_PRECONDITION	La richiesta non può essere eseguita nello stato attuale del sistema, come l'eliminazione di una directory non vuota.
400	OUT_OF_RANGE	Il client ha specificato un intervallo non valido.
401	UNAUTHENTICATED	La mancata autenticazione della richiesta è dovuta a un token OAuth mancante, non valido o scaduto.
403	PERMISSION_DENIED	Il client non dispone di autorizzazioni sufficienti. Questo può accadere perché il token OAuth non dispone degli ambiti giusti, il client non dispone dell'autorizzazione o l'API non è stata abilitata.
404	NOT_FOUND	Risorsa specificata non trovata.
409	ABORTED	Conflitto di contemporaneità, ad esempio conflitto di lettura, modifica e scrittura.
409	ALREADY_EXISTS	La risorsa che un client ha cercato di creare esiste già.
429	RESOURCE_EXHAUSTED	Quota di risorse esaurita o vicina alla limitazione della frequenza. Il cliente dovrebbe cercare informazioni dettagliate sull'errore google.rpc.QuotaFailure.
499	CANCELLED	La richiesta è stata annullata dal client.
500	DATA_LOSS	Perdita di dati non recuperabili o danneggiamento dei dati. Il cliente dovrebbe segnalare l'errore all'utente.
500	UNKNOWN	Errore sconosciuto del server. In genere un bug del server.
500	INTERNAL	Errore interno del server. In genere un bug del server.
501	NOT_IMPLEMENTED	Metodo API non implementato dal server.
502	N/A	Si è verificato un errore di rete prima di raggiungere il server. Solitamente un'interruzione della rete o una configurazione errata.
503	UNAVAILABLE	Servizio non disponibile. In genere il server non è attivo.
504	DEADLINE_EXCEEDED	Scadenza richiesta superata. Questo si verifica solo se il chiamante imposta una scadenza inferiore alla scadenza predefinita del metodo (ossia la scadenza richiesta non è sufficiente per l'elaborazione da parte del server) e la richiesta non è stata completata entro la scadenza.

Avviso: le API di Google possono contemporaneamente controllare più precondizioni per una richiesta API. La restituzione di un codice di errore non implica che altre condizioni preliminari siano soddisfatte. Il codice dell'applicazione non deve dipendere dall'ordine dei controlli di precondizione.

Nuovi errori

I client potrebbero riprovare in caso di errori 503 NON DISPONIBILI con backoff esponenziale. Il ritardo minimo deve essere di 1 secondo se non diversamente specificato. La ripetizione predefinita deve essere eseguita una sola volta, a meno che non sia indicato diversamente.

Per gli errori 429 RESOURCE_EXHAUSTED, il client può riprovare al livello superiore con un ritardo minimo di 30 s. Questi nuovi tentativi sono utili solo per i job in background a lunga esecuzione.

Per tutti gli altri errori, un nuovo tentativo potrebbe non essere applicabile. Innanzitutto assicurati che la richiesta sia idempotente e consulta google.rpc.RetryInfo per indicazioni.

Errori di propagazione

Se il servizio API dipende da altri servizi, non devi propagare ciecamente gli errori dei servizi ai tuoi client. Durante la traduzione degli errori, suggeriamo:

• Nascondi i dettagli dell'implementazione e le informazioni riservate.
• Modifica la parte responsabile dell'errore. Ad esempio, un server che riceve un errore INVALID_ARGUMENT da un altro servizio deve propagare un INTERNAL al proprio chiamante.

Errori di riproduzione

Se non riesci a risolvere gli errori tramite l'analisi dei log e il monitoraggio, devi provare a riprodurre gli errori con un test semplice e ripetibile. Puoi utilizzare il test per raccogliere ulteriori informazioni per la risoluzione dei problemi, che puoi fornire quando contatti l'assistenza tecnica.

Consigliamo di utilizzare curl -v e Parametri di sistema per riprodurre errori con le API di Google. Insieme possono riprodurre quasi tutte le richieste API di Google e fornire informazioni di debug dettagliate. Per ulteriori informazioni, consulta le rispettive pagine della documentazione per l'API che stai chiamando.

Generazione degli errori

Se sei uno sviluppatore di server, dovresti generare errori con informazioni sufficienti per aiutare gli sviluppatori client a comprendere e risolvere il problema. Allo stesso tempo, devi essere a conoscenza della sicurezza e della privacy dei dati utente ed evitare di divulgare informazioni sensibili nel messaggio e nei dettagli dell'errore, poiché gli errori vengono spesso registrati e potrebbero essere accessibili ad altri. Ad esempio, un messaggio di errore come "L'indirizzo IP del client non è nella lista consentita 128.0.0.0/8" espone le informazioni relative al criterio lato server, che potrebbero non essere accessibili all'utente che ha accesso ai log.

Per generare errori appropriati, devi prima conoscere google.rpc.Code e scegliere il codice di errore più adatto per ogni condizione di errore. Un'applicazione server può controllare più condizioni di errore in parallelo e restituire la prima.

La tabella riportata di seguito elenca ciascun codice di errore e un esempio di messaggio di errore valido.

HTTP	gRPC	Esempio di messaggio di errore
400	INVALID_ARGUMENT	Il campo di richiesta x.y.z è xxx, uno previsto per [yyy, zzz].
400	FAILED_PRECONDITION	La risorsa xxx è una directory non vuota, quindi non può essere eliminata.
400	OUT_OF_RANGE	Il parametro "age" non rientra nell'intervallo [0, 125].
401	UNAUTHENTICATED	Credenziali di autenticazione non valide.
403	PERMISSION_DENIED	Autorizzazione "xxx" negata per la risorsa "yyy".
404	NOT_FOUND	Risorsa "xxx" non trovata.
409	ABORTED	Impossibile acquisire il blocco sulla risorsa "xxx".
409	ALREADY_EXISTS	La risorsa "xxx" esiste già.
429	RESOURCE_EXHAUSTED	Limite quota "xxx" superato.
499	CANCELLED	La richiesta è stata annullata dal client.
500	DATA_LOSS	Nota.
500	UNKNOWN	Nota.
500	INTERNAL	Nota.
501	NOT_IMPLEMENTED	Metodo "xxx" non implementato.
503	UNAVAILABLE	Nota.
504	DEADLINE_EXCEEDED	Nota.

Nota: poiché il client non può correggere l'errore del server, non è utile generare ulteriori dettagli dell'errore. Per evitare fughe di informazioni sensibili in condizioni di errore, consigliamo di non generare messaggi di errore e di generare solo dettagli degli errori google.rpc.DebugInfo. DebugInfo è stato appositamente progettato solo per il logging lato server e non deve essere inviato al client.

Payload di errori

Il pacchetto google.rpc definisce un insieme di payload degli errori standard, preferiti per i payload degli errori personalizzati. La tabella seguente elenca ciascun codice di errore e il payload di errore standard corrispondente, se applicabile. Consigliamo alle applicazioni avanzate di rilevare questi payload di errore in google.rpc.Status quando gestiscono gli errori.

HTTP	gRPC	Dettagli sull'errore consigliati
400	INVALID_ARGUMENT	google.rpc.BadRequest
400	FAILED_PRECONDITION	google.rpc.PreconditionFailure
400	OUT_OF_RANGE	google.rpc.BadRequest
401	UNAUTHENTICATED	google.rpc.ErrorInfo
403	PERMISSION_DENIED	google.rpc.ErrorInfo
404	NOT_FOUND	google.rpc.ResourceInfo
409	ABORTED	google.rpc.ErrorInfo
409	ALREADY_EXISTS	google.rpc.ResourceInfo
429	RESOURCE_EXHAUSTED	google.rpc.QuotaFailure
499	CANCELLED
500	DATA_LOSS	google.rpc.DebugInfo
500	UNKNOWN	google.rpc.DebugInfo
500	INTERNAL	google.rpc.DebugInfo
501	NOT_IMPLEMENTED
503	UNAVAILABLE	google.rpc.DebugInfo
504	DEADLINE_EXCEEDED	google.rpc.DebugInfo