Risoluzione dei problemi di utilizzo delle API

La telemetria diagnostica e l'analisi degli errori ti consentono di identificare e risolvere gli errori delle richieste nelle API di Google e nei servizi Cloud de Confiance by S3NS . Puoi esaminare le metriche di utilizzo delle API, i log lato client, Cloud Audit Logs e le risposte di errore strutturate per diagnosticare le cause principali nelle tue applicazioni.

Sfondo

Le API di Google sono API di rete fornite dai servizi Google. Le applicazioni possono accedere alle API di Google tramite JSON HTTP e gRPC da ambienti diversi. Consigliamo agli sviluppatori di utilizzare le librerie client fornite da Google nelle loro applicazioni. Queste librerie implementano la logica boilerplate comune, come l'autenticazione e la paginazione degli elenchi, che riduce notevolmente il sovraccarico di sviluppo e gli errori comuni.

Per saperne di più, consulta la sezione Spiegazione delle librerie client.

Per iniziare

Se non hai mai utilizzato le API di Google, segui la pagina Per iniziare per completare i passaggi di preparazione della tua applicazione. Per prima cosa, utilizza il comando curl -v per inviare richieste di test alle API di Google che vuoi utilizzare. Ti consente di sperimentare con le API di Google senza scrivere codice. Spesso puoi risolvere molti problemi prima di iniziare lo sviluppo effettivo dell'applicazione.

Per saperne di più, consulta la sezione Per iniziare.

Risoluzione dei problemi utilizzando le metriche

Le API di Google forniscono metriche API senza costi che coprono gli aspetti comuni dell'utilizzo delle API, tra cui conteggi delle richieste, errori, latenze, dimensioni delle richieste e delle risposte. Forniscono dimensioni granulari in termini di applicazioni e località. Gli sviluppatori possono scoprire un utilizzo anomalo delle API e identificare le potenziali cause principali. Ad esempio, un numero maggiore di errori 400 può indicare che un'applicazione aggiornata di recente presenta alcuni bug logici oppure dimensioni maggiori delle richieste e delle risposte possono causare un rallentamento delle prestazioni dell'applicazione.

Per saperne di più, consulta la sezione Monitoraggio dell'utilizzo delle API.

Risoluzione dei problemi utilizzando i log

Per motivi di sicurezza e privacy, le API di Google in genere non forniscono log delle API agli sviluppatori di applicazioni. Consigliamo vivamente agli sviluppatori di applicazioni di registrare gli errori delle API lato client. Puoi registrare gli errori in uno spazio di archiviazione locale o in un'API di logging remota, ad esempio l'API Cloud Logging.

In genere, i log contengono più informazioni sugli errori rispetto alle metriche, ad esempio messaggi di errore e dettagli dell'errore. Sono estremamente utili e spesso necessari per risolvere i problemi relativi agli errori delle API. Quando gli sviluppatori notano un problema con l'utilizzo delle API, possono eseguire query sui log per trovare messaggi di errore e dettagli dell'errore e utilizzare le informazioni per risolvere gli errori o contattare l'assistenza.

Cloud Audit Logs

Per le attività sensibili alla sicurezza, i prodotti Google Cloud possono generare audit log che contengono informazioni dettagliate sulle attività. Sono un'ottima fonte di informazioni per risolvere i problemi relativi all'utilizzo delle API Google Cloud. Ad esempio, la funzionalità di simulazione di Controlli di servizio VPC genera audit log per consentire agli amministratori di valutare le modifiche alle policy imminenti.

Per saperne di più, consulta la sezione Cloud Audit Logs.

Risolvo gli errori

Se riscontri problemi con l'utilizzo delle API Google e hai trovato le metriche e i log corrispondenti, puoi seguire la pagina Errori della Guida alla progettazione delle API Errori per risolvere gli errori.

In generale, ogni errore API ha 3 informazioni: codice di errore, messaggio di errore e dettagli dell'errore:

  • Il codice di errore consente alle applicazioni di gestire l'errore a un livello superiore, ad esempio di riprovare dopo gli errori 503 o di autenticare nuovamente gli utenti dopo gli errori 401.
  • Il messaggio di errore consente agli sviluppatori di applicazioni di comprendere l'errore e correggere la logica dell'applicazione.

  • I dettagli dell'errore contengono informazioni aggiuntive che le applicazioni possono utilizzare per gestire l'errore a livello di programmazione.

Per saperne di più, consulta la pagina Errori.