Abfragefehlerprotokolle für Google Workspace-Add-ons

Wenn ein veröffentlichtes Google Workspace-Add-on einen Fehler zurückgibt, wird in der Add-on-Benutzeroberfläche die generische Meldung „Beim Ausführen des Add-ons ist ein Fehler aufgetreten“ angezeigt. Diese Fehler werden jedoch im Cloud Logging-Explorer protokolliert.

Hinweis:Wenn Ihr Add-on in Apps Script als Test bereitgestellt wird, werden Fehler sowohl im Cloud Logs Explorer als auch in der Add-on-Oberfläche gemeldet.

Bei der Testbereitstellung eines Add-ons kann beispielsweise eine Fehlermeldung wie TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn] in der Benutzeroberfläche angezeigt werden.

Fehlermeldungen wie diese sind zwar hilfreich, aber im Log-Explorer sind zusätzliche Informationen verfügbar. Als Best Practice sollten Sie die Fehlerlogs abfragen, um weitere Informationen zu erhalten. Weitere Informationen zum Testen von Add-on-Bereitstellungen finden Sie unter Google Workspace-Add-ons testen und debuggen.

In diesem Leitfaden wird beschrieben, wie Sie Add-on-Fehlerlogs im Cloud Logs Explorer abfragen, um:

• Herausfinden, ob Nutzer auf Fehler stoßen
• Sehen Sie sich an, wie oft Fehler auftreten und welche am häufigsten sind.
• Sie erhalten beschreibende Fehlermeldungen, die Ihnen bei der Behebung helfen.

Vorbereitung

Bevor Sie Add-on-Fehlerlogs abfragen:

• Aktivieren Sie die „Cloud Logging API“ im Google Cloud-Projekt des Add-ons. Informationen zum Aktivieren einer API finden Sie unter Cloud-Projekt erstellen und API aktivieren.
• Veröffentlichen Sie das Add‑on im Google Workspace Marketplace. Informationen zum Veröffentlichen eines Add-ons im Marketplace finden Sie unter App veröffentlichen.

Fehlerlogs für Add-ons abfragen

So rufen Sie Logs für ein Add‑on ab:

1. Öffnen Sie die Google Cloud Console.
2. Klicken Sie neben „Google Cloud Platform“ auf den Abwärtspfeil  und wählen Sie das Add-on-Projekt aus.
3. Klicken Sie links oben auf das Dreistrich-Menü  > Aufzeichnen. Der Log-Explorer wird geöffnet.

4. Geben Sie für Add-on-Fehlerlogs im Query Builder die folgende Abfrage ein:

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

5. Klicken Sie auf Abfrage ausführen, um die letzten Fehler aufzurufen. Wenn Sie Fehler sehen möchten, sobald sie auftreten, klicken Sie auf Stream-Logs. Fehlerlogs für Add-ons werden im Bereich „Abfrageergebnisse“ angezeigt.

Weitere Informationen zum Cloud Logs Explorer und zum Schreiben von Abfragen finden Sie unter:

• Log-Explorer verwenden
• Abfragen erstellen

Fehlerprotokollierung aktivieren oder deaktivieren

Das Fehler-Logging ist standardmäßig aktiviert. Wenn die Fehlerprotokollierung aktiviert ist, enthält die Manifestdatei Folgendes:

"exceptionLogging": "STACKDRIVER",

Wenn Sie die Fehlerprotokollierung deaktivieren möchten, ersetzen Sie "exceptionLogging": "STACKDRIVER", in der Manifestdatei durch die folgende Zeile:

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

Wenn Sie die Fehlerprotokollierung wieder aktivieren möchten, ersetzen Sie "exceptionLogging": "NONE" durch "exceptionLogging": "STACKDRIVER",.

Hinweise

Beachten Sie die folgenden Hinweise, wenn Sie mit Add-on-Fehlerlogs im Cloud Logs Explorer arbeiten:

• Add-ons protokollieren nur Fehler im Log-Explorer. Andere Logtypen werden nicht aufgezeichnet.
• Fehlermeldungen werden immer auf Englisch angezeigt.
• Für Cloud Logging fallen Kosten an. Weitere Informationen zu den Preisen für Cloud Logging finden Sie unter Google Cloud Observability-Preise.