Error Reporting용 PHP 앱 계측

PHP용 Error Reporting 라이브러리를 사용하여 PHP에서 Error Reporting에 오류 보고서를 보낼 수 있습니다. 다음과 같은 경우 PHP용 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의 형식 지정 오류 메시지를 참조하세요.

시작하기 전에

1. 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.

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

   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

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

4. Enable the Error Reporting API .

   Enable the API

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

   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

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

7. Enable the Error Reporting API .

   Enable the API

클라이언트 라이브러리 설치

PHP용 Error Reporting 라이브러리를 사용하면 거의 모든 곳에서 실행되는 PHP 애플리케이션에서 보고된 오류를 모니터링하고 볼 수 있습니다.

설치에 대한 자세한 내용은 PHP용 Error Reporting 라이브러리의 문서를 참조하세요. 또한 Issue Tracker를 통해 문제를 보고할 수도 있습니다.

클라이언트 라이브러리 구성

PHP용 Error Reporting 라이브러리의 동작을 맞춤설정할 수 있습니다. 가능한 구성 옵션 목록은 라이브러리 구성을 참조하세요.

Google Cloud에서 앱 실행

projects.events.report를 사용하여 오류 그룹을 만들려면 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)이 필요합니다.

일부 Google Cloud 서비스는 적합한 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)을 자동으로 부여합니다. 하지만 일부 서비스의 경우에는 사용자가 적합한 서비스 계정에 이 역할을 부여해야 합니다.

App Engine 가변형 환경

App Engine은 기본 서비스 계정에 Error Reporting 작성자 역할(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에 대한 모든 오류 및 포착되지 않은 예외를 자동으로 수집합니다. 자체 예외 핸들러를 설치하는 웹 프레임워크를 사용하는 경우 자세한 내용은 프레임워크 통합 섹션을 참조하세요.

Google Kubernetes Engine

Google Kubernetes Engine에 Error Reporting를 사용하려면 다음을 수행합니다.

1. 컨테이너에 사용할 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)이 부여되었는지 확인합니다.

   Compute Engine 기본 서비스 계정 또는 커스텀 서비스 계정을 사용할 수 있습니다.

   역할 부여에 대한 상세 설명은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

2. 클러스터를 만들고 클러스터에 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을 사용하려면 다음을 수행합니다.

1. VM 인스턴스에 사용할 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)이 부여되었는지 확인합니다.

   Compute Engine 기본 서비스 계정 또는 커스텀 서비스 계정을 사용할 수 있습니다.

   역할 부여에 대한 상세 설명은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

2. Google Cloud 콘솔에서 VM 인스턴스 페이지로 이동합니다.

   VM 인스턴스로 이동

   검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Compute Engine인 결과를 선택합니다.

3. cloud-platform 액세스 범위를 지정하려는 VM 인스턴스를 선택합니다.

4. 중지를 클릭한 후 수정을 클릭합니다.

5. ID 및 API 액세스 섹션에서 Error Reporting 작성자 역할(roles/errorreporting.writer)이 있는 서비스 계정을 선택합니다.

6. 액세스 범위 섹션에서 모든 Cloud API에 대한 전체 액세스 허용을 선택한 후 변경사항을 저장합니다.

7. 시작/재개를 클릭합니다.

Cloud Functions

Cloud Run 함수는 기본 서비스 계정에 자동으로 Error Reporting 작성자 역할(roles/errorreporting.writer)을 부여합니다.

PHP용 Error Reporting 라이브러리는 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Cloud Run 함수는 Error Reporting을 사용하도록 자동으로 구성됩니다. 처리되지 않은 JavaScript 예외는 Logging에 나타나고 PHP용 Error Reporting 라이브러리를 사용하지 않아도 Error Reporting에서 처리합니다.

참고: 스택 트레이스가 포함되어 있고 로그 심각도가 없거나 최소 ERROR 이상의 로그 심각도가 지정되어 있으면 PHP용 Error Reporting 라이브러리를 사용하지 않아도 로그 항목이 자동으로 처리됩니다.

예

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를 설치 및 초기화한 다음 사용자 인증 정보로 애플리케이션 기본 사용자 인증 정보를 설정하세요.

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. 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으로 이동

검색창을 사용하여 이 페이지를 찾을 수도 있습니다.

자세한 내용은 오류 보기를 참조하세요.

프레임워크 통합

일부 웹 프레임워크는 예외 핸들러를 대체합니다. 다음은 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);
    }
}