Esegui 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 di "Si è verificato un problema durante l'esecuzione del componente aggiuntivo." Tuttavia, questi errori sono e registrato in Esplora log di Cloud.

Nota: per Apps Script, se le tue viene eseguito il deployment di un componente aggiuntivo come prova, vengono segnalati sia in Esplora log di Cloud l'interfaccia del componente aggiuntivo.

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

Sebbene messaggi di errore come questo siano utili, puoi trovare altre informazioni disponibili in Esplora log. Come best practice, esegui una query sui log degli errori ulteriori informazioni. Per ulteriori informazioni sui test sui deployment dei componenti aggiuntivi, consulta Testa ed esegui il debug dei componenti aggiuntivi di Google Workspace.

Questa guida descrive come eseguire query sui log degli errori dei componenti aggiuntivi Esplora log di Cloud, per permetterti di:

• Scopri se gli utenti riscontrano errori.
• Scopri con quale frequenza si verificano gli errori e quali sono più frequenti.
• Leggi i 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 componente aggiuntivo progetto Google Cloud. Per abilitare un'API, consulta Crea un progetto Cloud e abilita l'API.
• Pubblica il componente aggiuntivo su Google Workspace Marketplace. Per pubblicare un componente aggiuntivo sul marketplace, consulta Pubblicare un'app.

Log degli errori dei componenti aggiuntivi delle query

Per ottenere i log per un componente aggiuntivo:

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

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

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

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

Per saperne di più su Esplora log di Cloud e sulla scrittura di query, consulta le seguenti:

• Utilizzare Esplora log
• Creare query

Abilita o disabilita il logging degli errori

Il logging degli errori è abilitato per impostazione predefinita. Quando il logging degli errori è abilitato, file manifest include quanto segue:

"exceptionLogging": "STACKDRIVER",

Per disabilitare il logging degli errori, sostituisci "exceptionLogging": "STACKDRIVER", con la seguente riga in 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 Cloud Logs Esploratore, tieni presente questi aspetti:

• I componenti aggiuntivi registrano solo gli errori in Esplora log. Altri tipi di log sono non registrato.
• I messaggi di errore sono sempre scritti in inglese.
• Cloud Logging prevede un costo. Per ulteriori informazioni su Cloud Logging Consulta i prezzi di Google Cloud Observability.