Python 用 Error Reporting の設定

は、

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

Error Reporting は、App EngineCompute EngineGoogle Kubernetes Engine などの一部の Google Cloud Platform プロダクトに統合されています。Error Reporting は、それらのプロダクトで実行中のアプリケーションによって Stackdriver Logging に記録されたエラーを表示します。詳細については、Google Cloud Platform での実行をご覧ください。

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

始める前に

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

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

  2. GCP プロジェクトを選択または作成します。

    [リソースの管理] ページに移動

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

    課金を有効にする方法について

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

    APIを有効にする

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

    Python 開発環境のセットアップに移動

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

Python 用 Stackdriver 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 用 Stackdriver Error Reporting ライブラリのドキュメントをご覧ください。問題追跡ツールを使用して問題を報告することもできます。

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

Python 用 Stackdriver 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 Platform での実行

Python 用 Stackdriver Error Reporting ライブラリを使用するには、Cloud IAM Error Reporting 書き込み役割が必要です。ほとんどの Google Cloud Platform コンピューティング プラットフォームでは、デフォルトでこの役割が提供されています。

App Engine フレキシブル環境

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

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

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

GKE

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 Platform Console で新しいインスタンスを作成する場合は、[インスタンスの作成] パネルの [ID と API へのアクセス] セクションで行うことができます。Compute Engine のデフォルト サービス アカウントや別のサービス アカウントを使用して、[ID と API へのアクセス] セクションの [すべての Cloud API に完全アクセス権を許可] を選択します。どのサービス アカウントを選択する場合でも、GCP Console の [IAM と管理] セクションで、そのアカウントに Error Reporting 書き込み役割が付与されていることを確認してください。

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

Google Cloud Platform の外部で Python 用 Stackdriver Error Reporting ライブラリを使用するには、GCP プロジェクト ID と該当するサービス アカウント認証情報を Python 用 Stackdriver Error Reporting ライブラリに直接指定する必要があります。これは、自分のワークステーション、データセンターのコンピュータ、または別のクラウド プロバイダの VM インスタンスでライブラリを実行する場合に適用されます。詳しくは、サービス アカウントの認証情報を手動で取得して指定するをご覧ください。

エラーレポートの表示

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

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

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

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Stackdriver Error Reporting
ご不明な点がありましたら、Google のサポートページをご覧ください。