PHP용 Error Reporting 설정

라이브러리 사용 설정

PHP용 Error Reporting 라이브러리를 사용하여 PHP에서 Error Reporting에 오류 보고서를 보낼 수 있습니다.

Error Reporting은 App Engine, Compute Engine, Google Kubernetes Engine과 같은 일부 Google Cloud 서비스에 통합되어 있습니다. Error Reporting은 해당 서비스에서 실행되는 애플리케이션에서 Cloud Logging에 로깅한 오류를 표시합니다. 자세한 내용은 이 페이지의 Google Cloud Platform에서 실행을 참조하세요.

또한 Logging을 사용하여 Error Reporting에 오류 데이터를 보낼 수도 있습니다. 데이터 형식 지정 요구사항에 대한 자세한 내용은 Logging의 형식 지정 오류 메시지를 참조하세요.

시작하기 전에

  1. Google 계정으로 로그인합니다.

    아직 계정이 없으면 새 계정을 등록하세요.

  2. Cloud Console의 프로젝트 선택기 페이지에서 Cloud 프로젝트를 선택하거나 만듭니다.

    프로젝트 선택기 페이지로 이동

  3. Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다. 프로젝트에 결제가 사용 설정되어 있는지 확인하는 방법을 알아보세요.

  4. Error Reporting API 를 사용 설정합니다.

    API 사용 설정

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

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

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

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

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

오류 보고

1. 다음 명령어로 클라우드 라이브러리를 설치합니다.

$ composer require google/cloud-error-reporting
1. 다음 줄을 php.ini에 추가합니다. 여기서 PROJECT_DIR은 프로젝트의 루트 디렉터리에 대한 절대 경로입니다.
auto_prepend_file='PROJECT_DIR/vendor/google/cloud-error-reporting/src/prepend.php'
1. GOOGLE_CLOUD_PROJECT 환경 변수를 Google Cloud 프로젝트 이름으로 설정합니다.

이 말머리 파일은 Error Reporting에 오류를 자동으로 보내는 예외 핸들러와 오류 핸들러를 설치합니다.

Google Cloud에서 실행

PHP용 Error Reporting 라이브러리를 사용하려면 ID 및 액세스 관리 Error Reporting 작성자 역할이 필요합니다. 대부분의 Google Cloud 컴퓨팅 플랫폼은 기본적으로 이 역할을 제공합니다.

다음 Google Cloud 환경에서 PHP용 Error Reporting을 구성할 수 있습니다.

App Engine 가변형 환경

App Engine은 기본적으로 Error Reporting 작성자 역할을 부여합니다.

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

App Engine 가변형 환경에서 Error Reporting을 사용 설정하려면 다음 단계를 따르세요.

  1. 다음 명령어로 필요한 라이브러리를 설치합니다.

    $ composer require google/cloud-error-reporting
  2. app.yamlruntime_config 섹션에 다음 줄을 추가합니다.

enable_stackdriver_integration: true

그런 다음 라이브러리는 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 작성자 역할이 부여되었는지 확인합니다.

로컬 및 기타 위치에서 실행

자체 워크스테이션, 데이터 센터의 컴퓨터 또는 다른 클라우드 제공업체의 VM 인스턴스에서 라이브러리를 실행하는 경우와 같이 Google Cloud 외부에서 PHP용 Error Reporting 라이브러리를 사용하려면 PHP용 Error Reporting 라이브러리에 직접 Google Cloud project ID와 적절한 서비스 계정 사용자 인증 정보를 제공해야 합니다.

서비스 계정 사용자 인증 정보를 수동으로 만들고 가져올 수 있습니다. 역할 필드를 지정할 때 Error Reporting 작성자 역할을 사용하세요. ID 및 액세스 관리 역할에 대한 자세한 내용은 액세스 제어 가이드를 참조하세요.

오류 보고서 보기

배포 후 Cloud Console 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\GetResponseForExceptionEvent;
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(GetResponseForExceptionEvent $event)
    {
        $exception = $event->getException();
        Bootstrap::exceptionHandler($exception);
    }
}