Python 用 Error Reporting の設定

Python アプリケーションから Error Reporting にエラーレポートを送信するには、Python 用 Error Reporting ライブラリを使用します。

Error Reporting は、App EngineCompute EngineGoogle Kubernetes Engine などの一部の Google Cloud サービスに統合されています。Error Reporting は、こうしたサービスで実行されるアプリケーションによって Cloud Logging に記録されたエラーを表示します。詳細については、このページの Google Cloud Platform での実行をご覧ください。

Logging を使用して、エラーデータを Error Reporting に送信することもできます。データ形式の要件については、Logging のエラー メッセージの形式設定をご覧ください。

始める前に

  1. Google アカウントにログインします。

    Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

  2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    [プロジェクトの選択] ページに移動

  3. Cloud プロジェクトに対して課金が有効になっていることを確認します。プロジェクトに対して課金が有効になっていることを確認する方法を学習する

  4. Error Reporting API を有効にします。

    API を有効にする

  5. Python 開発用に環境を準備します。

    Python 設定ガイドに移動

クライアント ライブラリのインストール

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

  1. 仮想環境をインスタンス化し、pip を使用してパッケージをインストールします。

    pip install google-cloud-error-reporting --upgrade
    
  2. エラーの報告を開始するために、ライブラリをインポートしてクライアントをインスタンス化します。

    Python

    def simulate_error():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        try:
            # simulate calling a method that's not defined
            raise NameError
        except Exception:
            client.report_exception()

インストールの詳細については、Python 用 Error Reporting ライブラリのドキュメントをご覧ください。公開バグトラッカーを使用して問題を報告することもできます。

クライアント ライブラリの構成

Python 用 Error Reporting ライブラリの動作をカスタマイズできます。構成例については、クライアント ライブラリのドキュメントをご覧ください。

エラーの報告

手動でエラーを報告するには、次の例で示すように、report メソッドを呼び出します。

Python

def report_manual_error():
    from google.cloud import error_reporting

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

if __name__ == '__main__':
    simulate_error()
    report_manual_error()

Google Cloud での実行

PHP 用 Error Reporting ライブラリを使用するには、Identity and Access Management Error Reporting Writer ロールが必要です。ほとんどの Google Cloud コンピューティング プラットフォームでは、デフォルトでこの役割が付与されます。

次の Google Cloud 環境で Python 用 Error Reporting を構成できます。

App Engine フレキシブル環境

App Engine は、デフォルトで Error Reporting Writer 役割を付与します。

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

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

Google Kubernetes Engine

GKE では、次のサンプル コマンドのように、クラスタの作成時に cloud-platform アクセス スコープを追加する必要があります。

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Compute Engine VM インスタンスを使用する場合は、各インスタンスに cloud-platform アクセス スコープを追加します。Google Cloud Console から新しいインスタンスを作成する場合は、[インスタンスの作成] パネルの [ID と API へのアクセス] のセクションで行います。Compute Engine のデフォルト サービス アカウントまたは別のサービス アカウントを使用し、[ID と API へのアクセス] セクションの [すべての Cloud API に完全アクセス権を許可] を選択します。どのサービス アカウントを選択する場合でも、Cloud Console の [IAM と管理] セクションで Error Reporting Writer ロールが付与されていることを確認してください。

ローカルやその他の場所での実行

自分のワークステーション、データセンターのコンピュータ、別のクラウド プロバイダの VM インスタンスでライブラリを実行するなど、Google Cloud の外部で Python 用 Error Reporting ライブラリを使用するには、Google Cloud プロジェクト ID と適切なサービス アカウント認証情報を Python 用 Error Reporting ライブラリに直接提供する必要があります。

サービス アカウントの認証情報は手動で作成して取得できます。[ロール] フィールドを指定する場合は、Error Reporting Writer ロールを使用します。Identity and Access Management のロールの詳細については、アクセス制御ガイドをご覧ください。

エラーレポートの表示

デプロイ後は、Cloud Console Error Reporting ダッシュボードでエラーレポートを表示できます。

Error Reporting ダッシュボードに移動

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