為 Python 應用程式進行檢測，以便回報錯誤

您可以使用 Python 適用的 Error Reporting 程式庫，從 Python 應用程式傳送錯誤報告至 Error Reporting。 使用 Python 適用的 Error Reporting 程式庫，為下列情況建立錯誤群組：

• 含有記錄檔項目的記錄檔 bucket 具有客戶自行管理的加密金鑰 (CMEK)。
• 記錄檔 bucket 符合下列其中一項條件：
  • 記錄 bucket 會儲存在記錄項目來源的專案中。
  • 記錄項目已轉送至專案，然後該專案將這些記錄項目儲存在所屬的記錄 bucket 中。
• 您想回報自訂錯誤事件。

Error Reporting 已與部分 Google Cloud 服務整合，如 Cloud Functions、App Engine、Compute Engine 和 Google Kubernetes Engine。Error Reporting 會顯示在這些服務上執行的應用程式記錄到 Cloud Logging 的錯誤。詳情請參閱本頁面的「在 Google Cloud上執行」一節。

另外，您也可以使用 Logging，將錯誤資料傳送至 Error Reporting。如要瞭解資料格式要求，請參閱「在 Logging 中格式化錯誤訊息」。

事前準備

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

1. 設定 Python 開發環境。

   前往 Python 設定指南

安裝用戶端程式庫

Python 適用的 Error Reporting 程式庫可讓您監控並查看在各處執行的 Python 應用程式回報的錯誤。

1. 將虛擬環境實例化並使用 pip 來安裝套件：

   pip install google-cloud-error-reporting --upgrade
   

2. 匯入程式庫並將用戶端實例化，以開始回報錯誤：

   Python

   如要向 Error Reporting 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

   #!/usr/bin/env python
   #
   # Copyright 2022 Google, Inc.
   #
   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
   #    http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   
   
   def report_exception():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       try:
           raise Exception("Something went wrong")
       except Exception:
           client.report_exception()
   
   
   
   
   def report_manual_error():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       client.report("An error has occurred.")
   
   
   
   
   if __name__ == "__main__":
       report_exception()
       report_manual_error()
   

如需進一步瞭解安裝相關資訊，請參閱 Python 適用的 Error Reporting 程式庫說明文件。您也可以使用問題追蹤工具報告問題。

設定用戶端程式庫

您可以自訂 Python 適用的 Error Reporting 程式庫行為。如需設定範例，請參閱 用戶端程式庫說明文件 。

在 Google Cloud上執行應用程式

如要使用 projects.events.report 建立錯誤群組，服務帳戶必須具備Error Reporting 寫入者角色 (roles/errorreporting.writer)。

部分 Google Cloud 服務會自動將 Error Reporting 寫入者角色 (roles/errorreporting.writer) 授予適當的服務帳戶。不過，您必須為某些服務的適當服務帳戶授予這個角色。

Cloud Run 和 Cloud Run 函式

Cloud Run 使用的預設服務帳戶具有 Error Reporting 寫入者角色 (roles/errorreporting.writer) 的權限。

不需要明確提供憑證，即可使用 Python 適用的 Error Reporting 程式庫。

Cloud Run 設定為自動使用 Error Reporting。未處理的 JavaScript 例外狀況會出現在 Logging 之中並由 Error Reporting 處理，不需使用 Python 適用的 Error Reporting 程式庫。

注意： 如果記錄項目包含堆疊追蹤，且未指定記錄嚴重程度或指定的嚴重程度至少為 ERROR，系統就會自動處理這些項目，您無需使用 Python 適用的錯誤報告程式庫。

App Engine 彈性環境

App Engine 會自動將 Error Reporting 寫入者角色 (roles/errorreporting.writer) 授予預設服務帳戶。

不需要明確提供憑證，即可使用 Python 適用的 Error Reporting 程式庫。

系統會自動為 App Engine 彈性環境應用程式啟用 Error Reporting。您不需要另外進行設定。
注意： 寫入 stderr 的錯誤記錄項目會自動由錯誤報告處理，您無需直接使用 Python 適用的錯誤報告程式庫。

Google Kubernetes Engine

如要在 Google Kubernetes Engine 中使用 Error Reporting，請按照下列步驟操作：

1. 請確保容器使用的服務帳戶已取得 Error Reporting 寫入者角色 (roles/errorreporting.writer)。

   您可以使用 Compute Engine 預設服務帳戶或自訂服務帳戶。

   如要瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」一文。

2. 建立叢集，並授予叢集 cloud-platform access scope。

   舉例來說，下列建立指令會指定 cloud-platform 存取權範圍和服務帳戶：

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

注意： 叢集建立完成後，您就無法變更其服務帳戶。

Compute Engine

如要搭配 Compute Engine VM 執行個體使用錯誤報告，請完成下列步驟：

1. 確認 VM 執行個體使用的服務帳戶已取得 Error Reporting 寫入者角色 (roles/errorreporting.writer)。

   您可以使用 Compute Engine 預設服務帳戶或自訂服務帳戶。

   如要瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」一文。

2. 前往 Google Cloud 控制台的「VM instances」(VM 執行個體) 頁面：

   前往「VM instances」(VM 執行個體) 頁面

   如果您是使用搜尋列尋找這個頁面，請選取子標題為「Compute Engine」的結果。

3. 選取要接收cloud-platform 存取範圍的 VM 執行個體。

4. 按一下「停止」，然後按一下「編輯」。

5. 在「Identity and API access」(身分及 API 存取權) 區段，選取具有 Error Reporting 寫入者角色 (roles/errorreporting.writer) 的服務帳戶。

6. 在「存取權範圍」專區，選取「允許所有 Cloud API 的完整存取權」，然後儲存變更。

7. 按一下「開始/繼續」。

範例

您可以呼叫 report 方法手動回報錯誤，如下列範例所示：

Python

如要向 Error Reporting 進行驗證，請設定應用程式預設憑證。 詳情請參閱「設定驗證」。

#!/usr/bin/env python
#
# Copyright 2022 Google, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


def report_exception():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    try:
        raise Exception("Something went wrong")
    except Exception:
        client.report_exception()




def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")




if __name__ == "__main__":
    report_exception()
    report_manual_error()

在本機開發環境中執行應用程式

如要在本機開發環境中使用 Python 適用的 Error Reporting 程式庫 (例如在自己的工作站上執行該程式庫)，您必須為 Python 適用的 Error Reporting 程式庫提供本機應用程式預設憑證。詳情請參閱「向 Error Reporting 進行驗證」。

如要在本機開發環境中使用本頁的 Python 範例，請安裝並初始化 gcloud CLI，然後使用使用者憑證設定應用程式預設憑證。

1. Install the Google Cloud CLI.

2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

3. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

詳情請參閱 Set up authentication for a local development environment。

projects.events.report 方法也支援 API 金鑰。 如要使用 API 金鑰進行驗證，您不需要設定本機應用程式預設憑證檔案。 詳情請參閱 請參閱 Google Cloud 驗證說明文件，建立 API 金鑰。

查看錯誤報告

前往 Google Cloud 控制台的「Error Reporting」頁面：

前往 Error Reporting

您也可以透過搜尋列找到這個頁面。

詳情請參閱查看錯誤一文。