Risoluzione dei problemi di utilizzo delle API

Questa pagina fornisce agli sviluppatori di applicazioni una panoramica su come risolvere i problemi il loro utilizzo delle API di Google e delle API Google Cloud.

Sfondo

Le API di Google sono API di rete fornite dai servizi Google. Applicazioni possono accedere alle API di Google tramite JSON HTTP e gRPC da diversi ambienti. Consigliamo agli sviluppatori di utilizzare le librerie client fornite da Google nei propri diverse applicazioni. Queste librerie implementano la logica boilerplate comune, ad esempio autenticazione e impaginazione degli elenchi, che riducono notevolmente lo sviluppo overhead ed errori comuni.

Per ulteriori informazioni, vedi Spiegazione delle librerie client

Come iniziare

Se non hai mai utilizzato le API di Google, segui le Come iniziare per completare i passaggi di preparazione per la tua richiesta. Dovresti prima usare curl -v per inviare richieste di test alle API di Google che vuoi utilizzare. Ti consente di fare esperimenti con le API Google senza scrivere codice. Spesso è possibile risolvere molti problemi prima di iniziare lo sviluppo reale dell'applicazione.

Per ulteriori informazioni, consulta la Guida introduttiva.

Risoluzione dei problemi relativi all'utilizzo delle metriche

Le API di Google offrono metriche gratuite relative alle API che riguardano aspetti comuni dell'utilizzo delle API, tra cui numero di richieste, errori, latenze e dimensioni di richieste e risposte. Forniscono dimensioni granulari in termini di applicazioni e località. Gli sviluppatori possono rilevare un utilizzo anomalo dell'API e identificare potenziali cause di fondo. Ad esempio, un numero maggiore di errori 400 può indicare un errore di recente l'applicazione aggiornata presenta alcuni bug logici o un numero maggiore di richieste e risposte di queste dimensioni possono rallentare le prestazioni dell'applicazione.

Per ulteriori informazioni, consulta la sezione sull'utilizzo dell'API Monitoring.

Risoluzione dei problemi relativi all'utilizzo dei log

Per motivi di sicurezza e privacy, in genere le API di Google non forniscono log API agli sviluppatori di applicazioni. Consigliamo vivamente agli sviluppatori di applicazioni di registrare gli errori dell'API lato client. Puoi registrare gli errori in uno spazio di archiviazione locale oppure a un'API di logging remoto come l'API Cloud Logging.

In genere i log contengono più informazioni sugli errori rispetto alle metriche, ad esempio messaggi di errore e dettagli sugli errori. Sono estremamente utili e spesso necessari per risolvere i problemi relativi alle API. Quando gli sviluppatori rilevano un problema con l'utilizzo dell'API, possono eseguire query sui log per trovare messaggi di errore e dettagli sugli errori, nonché 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 log di audit che contengono informazioni dettagliate sulle attività. Sono un'ottima fonte di informazioni per la risoluzione dei problemi relativi all'utilizzo delle API Google Cloud. Ad esempio, funzionalità dry run di Controlli di servizio VPC genera log di controllo per consentire agli amministratori di valutare le imminenti modifiche ai criteri.

Per ulteriori informazioni, consulta Cloud Audit Logs.

Risolvere gli errori

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

In generale, ogni errore dell'API è costituito da tre informazioni: codice di errore, errore e ai dettagli dell'errore:

  • Il codice di errore consente alle applicazioni di gestire l'errore a un livello superiore, ad esempio riprovare dopo errori 503 o autenticare nuovamente gli utenti dopo errori 401.

  • Il messaggio di errore consente agli sviluppatori di applicazioni di comprendere l'errore e e correggere la logica dell'applicazione.

  • I dettagli dell'errore contengono informazioni aggiuntive che le applicazioni possono utilizzare per gestire l'errore in modo programmatico.

Per ulteriori informazioni, consulta la pagina Errori.