このページは Cloud Translation API によって翻訳されました。

Error Reporting 用の Python アプリのインストルメント化

Python アプリケーションから Error Reporting にエラーレポートを送信するには、Python 用 Error Reporting ライブラリを使用します。次の場合は、Python 用 Error Reporting ライブラリを使用してエラーグループを作成します。

ログエントリを含むログバケットに、顧客管理の暗号鍵(CMEK)がある。
ログバケットが次のいずれかを満たしている。
- ログバケットがログエントリの元のプロジェクトに保存されている。
- ログエントリがプロジェクトに転送され、そのプロジェクトがそれらのログエントリを、所有するログバケットに保存した。
カスタムエラーイベントを報告する必要がある。

Error Reporting は、Cloud Functions、App Engine、Compute Engine、Google Kubernetes Engine などの一部の Google Cloud サービスに統合されています。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.

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.

Go to project selector

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

Enable the Error Reporting API .

Enable the API

Python 開発用に環境を準備します。
Python 設定ガイドに移動

クライアントライブラリをインストールする

Python 用 Error Reporting ライブラリを使用すると、ほぼすべての場所で動作している Python アプリケーションから報告されるエラーをモニタリングして表示できます。

仮想環境をインスタンス化し、pip を使用してパッケージをインストールします。
```
pip install google-cloud-error-reporting --upgrade
```

エラーの報告を開始するために、ライブラリをインポートしてクライアントをインスタンス化します。

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 functions

Cloud Run で使用されるデフォルトのサービスアカウントには、Error Reporting 書き込みロール（roles/errorreporting.writer）の権限があります。

Python 用 Error Reporting ライブラリは、明示的に認証情報を提示しなくても使用できます。

Cloud Run は、Error Reporting を自動的に使用するように構成されています。JavaScript の未処理の例外は、Logging に表示され、Python 用 Error Reporting ライブラリを使用しなくても、Error Reporting によって処理されます。

App Engine フレキシブル環境

App Engine では、デフォルトのサービスアカウントに Error Reporting 書き込みロール（roles/errorreporting.writer）が自動的に付与されます。

Python 用 Error Reporting ライブラリは、明示的に認証情報を提示しなくても使用できます。

App Engine フレキシブル環境のアプリケーションでは、Error Reporting が自動的に有効になります。特別な設定は必要ありません。

Google Kubernetes Engine

Google Kubernetes Engine で Error Reporting を使用するには、次の操作を行います。

コンテナが使用するサービスアカウントに、Error Reporting 書き込みロール（roles/errorreporting.writer）が付与されていることを確認します。

Compute Engine のデフォルトのサービスアカウントまたはカスタムサービスアカウントを使用できます。

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
クラスタを作成し、クラスタに cloud-platform アクセススコープを付与します。

たとえば、次の作成コマンドは、cloud-platform アクセススコープとサービスアカウントを指定します。
```
gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
```

Compute Engine

Compute Engine VM インスタンスで Error Reporting を使用する手順は次のとおりです。

VM インスタンスが使用するサービスアカウントに、Error Reporting 書き込みロール（roles/errorreporting.writer）が付与されていることを確認します。

Compute Engine のデフォルトのサービスアカウントまたはカスタムサービスアカウントを使用できます。

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
Google Cloud コンソールで、[VM インスタンス] ページに移動します。
[VM インスタンス] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Compute Engine] である結果を選択します。
cloud-platform アクセススコープを適用する VM インスタンスを選択します。
[停止]、[編集] の順にクリックします。
[ID と API へのアクセス] セクションで、Error Reporting 書き込みロール（roles/errorreporting.writer）を持つサービスアカウントを選択します。
[アクセススコープ] セクションで、[すべての Cloud API に完全アクセス権を許可] を選択し、変更を保存します。
[開始 / 再開] をクリックします。

例

手動でエラーを報告するには、次の例で示すように、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 をインストールして初期化し、ユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定します。

Install the Google Cloud CLI.
To initialize the gcloud CLI, run the following command:
```
gcloud init
```
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
```

詳細については Set up authentication for a local development environment をご覧ください。

projects.events.report メソッドは API キーもサポートしています。認証に API キーを使用する場合、ローカルのアプリケーションのデフォルト認証情報ファイルを設定する必要はありません。詳細については、 Google Cloud の認証に関するドキュメントの API キーを作成するをご覧ください。

エラーレポートの表示

Google Cloud コンソールで、[Error Reporting] ページに移動します。

Error Reporting に移動

このページは、検索バーを使用して見つけることもできます。

詳細については、エラーの表示をご覧ください。

Error Reporting 用の Python アプリのインストルメント化

始める前に

クライアント ライブラリをインストールする

Python

クライアント ライブラリを設定する

Google Cloud でアプリを実行する

Cloud Run と Cloud Run functions

App Engine フレキシブル環境

Google Kubernetes Engine

Compute Engine

例

Python

ローカル開発環境でアプリを実行する

エラーレポートの表示

クライアントライブラリをインストールする

クライアントライブラリを設定する