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

PHP 專用的錯誤報告程式庫可讓您直接從 PHP 應用程式將錯誤事件傳送至錯誤報告，以便診斷及監控執行階段當機情形。使用程式庫檢測應用程式，即可回報自訂錯誤事件，並擷取錯誤，即使記錄檔儲存空間使用客戶管理的加密金鑰 (CMEK) 也是如此。

對於在整合式服務 Google Cloud 上執行的應用程式 (包括 Cloud Run 函式、App Engine、Compute Engine 和 Google Kubernetes Engine)，Error Reporting 也能從 Cloud Logging 自動推斷錯誤事件，不必使用 PHP 適用的 Error Reporting 程式庫。如要讓 Error Reporting 從記錄檔推斷錯誤事件，記錄檔項目必須符合錯誤格式規定，並儲存在非 CMEK 記錄檔 bucket 中，且該 bucket 必須由原始專案或記錄檔轉送目的地專案擁有。

事前準備

登入 Google Cloud 帳戶。如果您是 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.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). 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.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

安裝用戶端程式庫

PHP 適用的 Error Reporting 程式庫可讓您監控及查看幾乎在任何位置執行的 PHP 應用程式回報的錯誤事件。

如要進一步瞭解如何安裝，請參閱 PHP 錯誤報告程式庫的說明文件。您也可以使用問題追蹤工具報告問題。

設定用戶端程式庫

您可以自訂 PHP 錯誤報告程式庫的行為。如要查看可能的設定選項清單，請參閱程式庫的設定。

在 Google Cloud上執行應用程式

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

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

Cloud Run 和 Cloud Run functions

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

您可以使用 PHP 適用的 Error Reporting 程式庫，不必明確提供憑證。

Cloud Run 會自動設定使用 Error Reporting。系統會將未處理的 JavaScript 例外狀況顯示在記錄中，並由 Error Reporting 處理，不必使用 PHP 的 Error Reporting 程式庫。

注意： 如果記錄項目包含堆疊追蹤，且記錄項目的嚴重性等級未設定或設為至少 ERROR，錯誤報告就會自動建立錯誤事件。

App Engine 彈性環境

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

您可以使用 PHP 適用的 Error Reporting 程式庫，不必明確提供憑證。

如要在 App Engine 彈性環境中啟用 Error Reporting，請按照下列步驟操作：

1. 使用下列指令安裝必要程式庫：

   $ composer require google/cloud-error-reporting

2. 在 app.yaml 的 runtime_config 區段中新增下列程式碼：

enable_stackdriver_integration: true

接著，程式庫會自動將所有錯誤和未處理的例外狀況收集到 Error Reporting。如果您使用的 Web Framework 會安裝自己的例外狀況處理常式，請參閱「Framework Integrations section」(架構整合部分) 瞭解詳情。

Google Kubernetes Engine

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

1. 確認容器使用的服務帳戶已獲派錯誤報告寫入者角色 (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

如要搭配使用 Error Reporting 和 Compute Engine VM 執行個體，請按照下列步驟操作：

1. 確認 VM 執行個體使用的服務帳戶已獲派「Error Reporting Writer」角色 (roles/errorreporting.writer)。

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

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

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

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

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

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

4. 依序點選「停止」和「編輯」。

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

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

7. 點選「啟動/重新啟用」。

範例

1. 使用以下指令安裝雲端程式庫：

$ composer require google/cloud-error-reporting

2. 在 php.ini 中新增下列程式碼，其中 WORKSPACE 是工作區根目錄的絕對路徑：

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

這個前置檔案會安裝例外狀況處理常式和錯誤處理常式，這兩個常式會自動將錯誤傳送至錯誤報告。

如果您使用 App Engine 彈性環境，請參閱本頁的「App Engine 彈性環境」。

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

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

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

1. 安裝 Google Cloud CLI。

2. 若您採用的是外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

3. 如果您使用本機殼層，請為使用者帳戶建立本機驗證憑證：

   gcloud auth application-default login

   如果您使用 Cloud Shell，則不需要執行這項操作。

   注意：如果 gcloud CLI 列印警告訊息，指出您的帳戶沒有 serviceusage.services.use 權限，部分 gcloud CLI 指令和用戶端程式庫可能無法運作。請管理員授予您「服務使用情形消費者」IAM 角色 (roles/serviceusage.serviceUsageConsumer)，然後執行下列指令：

   gcloud auth application-default set-quota-project PROJECT_ID

   如果系統傳回驗證錯誤，且您使用外部識別資訊提供者 (IdP)，請確認您已 使用聯合身分登入 gcloud CLI。

詳情請參閱 這篇文章，瞭解如何設定本機開發環境的驗證機制。

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

查看錯誤群組

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

前往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);
    }
}

您也需要在檔案開頭新增一行 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);
    }
}