Google Workspace 부가기능에 대한 오류 로그 쿼리

게시된 Google Workspace 부가기능이 오류를 반환하면 부가기능 인터페이스는 '부가기능을 실행하는 중에 문제가 발생했습니다'라는 일반적인 메시지를 반환합니다. 하지만 이러한 오류는 Cloud Logs Explorer에 로깅됩니다.

참고: Apps Script의 경우 부가기능이 테스트로 배포되면 Cloud 로그 탐색기와 부가기능 인터페이스 모두에서 오류가 보고됩니다.

예를 들어 부가기능 테스트 배포는 인터페이스에 TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn]와 같은 오류 메시지를 표시할 수 있습니다.

이러한 오류 메시지는 유용하지만 로그 탐색기에서 추가 정보를 확인할 수 있습니다. 오류 로그에서 자세한 정보를 쿼리하는 것이 좋습니다. 부가기능 배포 테스트에 관한 자세한 내용은 Google Workspace 부가기능 테스트 및 디버깅을 참고하세요.

이 가이드에서는 Cloud Logs Explorer에서 부가기능 오류 로그를 쿼리하여 다음 작업을 수행하는 방법을 설명합니다.

• 사용자에게 오류가 발생하는지 알아봅니다.
• 오류가 발생하는 빈도와 가장 빈번하게 발생하는 오류를 확인합니다.
• 문제를 해결하는 데 도움이 되는 설명 오류 메시지를 읽습니다.

기본 요건

부가기능 오류 로그를 쿼리하기 전에 다음을 실행합니다.

• 부가기능의 Google Cloud 프로젝트에서 'Cloud Logging API'를 사용 설정합니다. API를 사용 설정하려면 Cloud 프로젝트 만들기 및 API 사용 설정하기를 참고하세요.
• Google Workspace Marketplace에 부가기능을 게시합니다. 마켓플레이스에 부가기능을 게시하려면 앱 게시를 참고하세요.

부가기능 오류 로그 쿼리

부가기능의 로그를 가져오려면 다음 단계를 따르세요.

1. Google Cloud 콘솔을 엽니다. 
2. 'Google Cloud Platform' 옆에 있는 아래쪽 화살표 를 클릭하고 부가기능 프로젝트를 선택합니다.
3. 왼쪽 상단에서 메뉴 > 로깅을 클릭합니다. 로그 탐색기가 열립니다.

4. 부가기능 오류 로그의 경우 쿼리 빌더에 다음 쿼리를 입력합니다.

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

5. 최근 오류를 보려면 쿼리 실행을 클릭합니다. 또는 오류가 발생할 때 이를 확인하려면 로그 스트리밍을 클릭합니다. 부가기능 오류 로그가 '쿼리 결과' 창에 표시됩니다.

Cloud 로그 탐색기 및 쿼리 작성에 관한 자세한 내용은 다음을 참고하세요.

• 로그 탐색기 사용
• 쿼리 빌드

오류 로깅 사용 설정 또는 중지

기본적으로 오류 로깅은 사용 설정되어 있습니다. 오류 로깅이 사용 설정된 경우 매니페스트 파일에는 다음이 포함됩니다.

"exceptionLogging": "STACKDRIVER",

오류 로깅을 사용 중지하려면 매니페스트 파일에서 "exceptionLogging": "STACKDRIVER",를 다음 줄로 바꿉니다.

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

오류 로깅을 다시 사용 설정하려면 "exceptionLogging": "NONE"를 "exceptionLogging": "STACKDRIVER",로 바꿉니다.

고려사항

Cloud 로그 탐색기에서 부가기능 오류 로그를 사용할 때는 다음 사항을 고려하세요.

• 부가기능은 로그 탐색기에서만 오류를 로깅합니다. 다른 로그 유형은 기록되지 않습니다.
• 오류 메시지는 항상 영어로 작성됩니다.
• Cloud Logging에는 비용이 발생합니다. Cloud Logging 가격 책정에 관한 자세한 내용은 Google Cloud Observability 가격 책정을 참고하세요.