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

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

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

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

Logging を使用して、エラーイベントを Error Reporting に送信することもできます。データ形式の要件については、ログエントリの形式を設定してエラーイベントを報告するをご覧ください。

始める前に

アカウントにログインしてください。 Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオで Google プロダクトのパフォーマンスを評価してください。 Google Cloud新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

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

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

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

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

PHP 用 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）の権限があります。

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

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

App Engine フレキシブル環境

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

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

App Engine フレキシブル環境で Error Reporting を有効にするには、次の手順を実行します。

次のコマンドを使用して必要なライブラリをインストールします。
```
$ composer require google/cloud-error-reporting
```
次の行を app.yaml の runtime_config セクションに追加します。

enable_stackdriver_integration: true

その後、ライブラリが、自動的に、すべてのエラーと捕捉されなかった例外を Error Reporting に収集します。独自の例外ハンドラをインストールするウェブフレームワークを使用している場合は、フレームワークの統合のセクションをご覧ください。

Google Kubernetes Engine

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

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

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

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

たとえば、次の create コマンドは、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 のデフォルトのサービスアカウントまたはカスタムサービスアカウントを使用できます。

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

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

例

1. 次のコマンドを使用して、クラウドライブラリをインストールします。

$ composer require google/cloud-error-reporting

2. 次の行を php.ini に追加します。ここで、WORKSPACE はワークスペースのルートディレクトリの絶対パスです。

auto_prepend_file='/WORKSPACE/vendor/google/cloud-error-reporting/src/prepend.php'

このプリペンドファイルは、エラーを自動的に Error Reporting に送信する例外ハンドラとエラーハンドラをインストールします。

App Engine フレキシブル環境を使用している場合は、このページの App Engine フレキシブル環境をご覧ください。

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

自分のワークステーションでライブラリを実行するなど、ローカル開発環境で PHP 用 Error Reporting ライブラリを使用するには、ローカルアプリケーションのデフォルト認証情報を使用して、PHP 用 Error Reporting ライブラリを指定する必要があります。詳細については、Error Reporting に対する認証をご覧ください。

ローカル開発環境でこのページの PHP サンプルを使用するには、gcloud CLI をインストールして初期化し、ユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定します。

Google Cloud CLI をインストールします。
外部 ID プロバイダ（IdP）を使用している場合は、まずフェデレーション ID を使用して gcloud CLI にログインする必要があります。
ローカルシェルを使用している場合は、ユーザーアカウントのローカル認証情報を作成します。
```
gcloud auth application-default login
```
Cloud Shell を使用している場合は、この操作を行う必要はありません。
注: gcloud CLI で、アカウントに serviceusage.services.use 権限がないという警告が表示される場合は、一部の gcloud CLI コマンドとクライアントライブラリが動作しない可能性があります。管理者に Service Usage Consumer IAM ロール（roles/serviceusage.serviceUsageConsumer）を付与してもらってから、次のコマンドを実行してください。
```
gcloud auth application-default set-quota-project PROJECT_ID
```
認証エラーが返され、外部 ID プロバイダ（IdP）を使用している場合は、フェデレーション ID を使用して gcloud CLI にログインしていることを確認します。

詳細については、ローカル開発環境の認証を設定するをご覧ください。

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

エラーグループを表示する

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

Error Reporting に移動

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

詳細については、エラーグループを表示してフィルタするをご覧ください。

フレームワークの統合

一部のウェブフレームワークは例外ハンドラをオーバーライドします。Laravel と Symfony で Error Reporting を有効にする例を以下に示します。他のフレームワークでは、Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler を例外ハンドラとして使用できます。

Laravel

次のように、ファイル app/Exceptions/Handler.php 内の report 関数を編集します。

public function report(Exception $exception)
{
    if (isset($_SERVER['GAE_SERVICE'])) {
        // Ensure Stackdriver is initialized and handle the exception
        Bootstrap::init();
        Bootstrap::exceptionHandler($exception);
    } else {
        parent::report($exception);
    }
}

また、ファイルの先頭に 1 行の use ステートメントを追加する必要もあります。

use Google\Cloud\ErrorReporting\Bootstrap;

Symfony

次の内容の新しいファイル src/AppBundle/EventSubscriber/ExceptionSubscriber.php を作成します。

// src/AppBundle/EventSubscriber/ExceptionSubscriber.php
namespace AppBundle\EventSubscriber;

use Google\Cloud\ErrorReporting\Bootstrap;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class ExceptionSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents()
    {
        // return the subscribed events, their methods and priorities
        return [KernelEvents::EXCEPTION => [
            ['logException', 0]
        ]];
    }

    public function logException(ExceptionEvent $event)
    {
        $exception = $event->getThrowable();
        Bootstrap::exceptionHandler($exception);
    }
}

Enabling the library

Error Reporting 用の PHP アプリのインストルメント化 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

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

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

でアプリを実行する Google Cloud

Cloud Run と Cloud Run functions

App Engine フレキシブル環境

Google Kubernetes Engine

Compute Engine

例

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

エラーグループを表示する

フレームワークの統合

Laravel

Symfony

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

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

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