Eseguire query sui log degli errori per i componenti aggiuntivi di Google Workspace

Quando un componente aggiuntivo di Google Workspace pubblicato restituisce un errore, l'interfaccia del componente aggiuntivo restituisce un messaggio generico "Si è verificato un problema durante l'esecuzione del componente aggiuntivo". Tuttavia, questi errori vengono registrati in Esplora log di Cloud.

Nota: per Apps Script, se il plug-in viene disegnato come test, gli errori vengono segnalati sia in Cloud Logs Explorer sia nell'interfaccia del plug-in.

Ad esempio, un deployment di test di un componente aggiuntivo potrebbe mostrare un messaggio di errore come questo nella sua interfaccia: TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn].

Sebbene i messaggi di errore come questo siano utili, sono disponibili ulteriori informazioni in Esplora log. Come best practice, esegui una query sui log degli errori per avere maggiori informazioni. Per ulteriori informazioni sul test dei deployment dei componenti aggiuntivi, consulta Testare e eseguire il debug dei componenti aggiuntivi di Google Workspace.

Questa guida descrive come eseguire query sui log degli errori dei componenti aggiuntivi in Esplora log di Cloud, in modo da poter:

• Scopri se gli utenti riscontrano errori.
• Scopri con quale frequenza si verificano gli errori e quali sono i più frequenti.
• Leggi messaggi di errore descrittivi che ti aiutano a risolverli.

Prerequisiti

Prima di eseguire query sui log degli errori dei componenti aggiuntivi:

• Abilita l'"API Cloud Logging" nel progetto Google Cloud del componente aggiuntivo. Per abilitare un'API, consulta Creare un progetto Cloud e abilitare l'API.
• Pubblica il componente aggiuntivo su Google Workspace Marketplace. Per pubblicare un componente aggiuntivo sul Marketplace, consulta Pubblicare un'app.

Esegui query sui log degli errori dei componenti aggiuntivi

Per ottenere i log di un componente aggiuntivo:

1. Apri la console Google Cloud.
2. Accanto a "Piattaforma Google Cloud", fai clic sulla Freccia giù e seleziona il progetto del componente aggiuntivo.
3. Nell'angolo in alto a sinistra, fai clic su Menu > Log. Si apre Esplora log.

4. Per i log degli errori dei componenti aggiuntivi, inserisci la seguente query in Query Builder:

   severity>=ERROR
   protoPayload.serviceName="gsuiteaddons.googleapis.com"
   

5. Per visualizzare gli errori recenti, fai clic su Esegui query. In alternativa, per visualizzare gli errori man mano che si verificano, fai clic su Avvia flusso di log. I log degli errori dei componenti aggiuntivi vengono visualizzati nel riquadro "Risultati delle query".

Per ulteriori informazioni su Esplora log di Cloud e sulla scrittura di query, consulta quanto segue:

• Utilizzare Esplora log
• Creare query

Attivare o disattivare il logging degli errori

Per impostazione predefinita, la registrazione degli errori è attivata. Quando il logging degli errori è abilitato, il file manifest contiene quanto segue:

"exceptionLogging": "STACKDRIVER",

Per disattivare il logging degli errori, sostituisci "exceptionLogging": "STACKDRIVER", con la seguente riga nel file manifest:

// Disable error logging
"exceptionLogging": "NONE"

Per riattivare il logging degli errori, sostituisci "exceptionLogging": "NONE" con "exceptionLogging": "STACKDRIVER",.

Considerazioni

Quando utilizzi i log degli errori dei componenti aggiuntivi in Esplora log di Cloud, tieni presente queste considerazioni:

• I componenti aggiuntivi registrano gli errori solo in Esplora log. Gli altri tipi di log non vengono registrati.
• I messaggi di errore sono sempre scritti in inglese.
• Cloud Logging comporta un costo. Per ulteriori informazioni sui prezzi di Cloud Logging, consulta la pagina Prezzi di Google Cloud Observability.