Error Reporting용 Java 앱 계측

Java용 Error Reporting 패키지를 사용하여 Java 애플리케이션에서 Error Reporting으로 오류 보고서를 보낼 수 있습니다. 다음과 같은 경우 Java용 Error Reporting 패키지를 사용하여 오류 그룹을 만듭니다.

로그 버킷에 고객 관리 암호화 키(CMEK)가 포함됩니다.
로그 버킷이 global 리전에 없습니다.
커스텀 오류 이벤트를 보고합니다.

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

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

시작하기 전에

Google Cloud 계정에 로그인합니다. Google Cloud를 처음 사용하는 경우 계정을 만들고 Google 제품의 실제 성능을 평가해 보세요. 신규 고객에게는 워크로드를 실행, 테스트, 배포하는 데 사용할 수 있는 $300의 무료 크레딧이 제공됩니다.

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

프로젝트 선택기로 이동

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

Error Reporting API 사용 설정

API 사용 설정

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

프로젝트 선택기로 이동

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

Error Reporting API 사용 설정

API 사용 설정

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

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

설치에 대한 자세한 내용은 Java용 Error Reporting 패키지의 문서를 참조하세요. 또한 Issue Tracker를 통해 문제를 보고할 수도 있습니다.

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

Java용 Error Reporting 패키지의 동작을 맞춤설정할 수 있습니다. Java API 참조 문서를 확인하세요.

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)을 자동으로 부여합니다.

Java용 Error Reporting 패키지는 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Error Reporting은 App Engine 가변형 환경 애플리케이션에서 자동으로 사용 설정되며 추가 설정은 필요하지 않습니다.

@WebServlet(name = "Error reporting", value = "/error")
public class ErrorReportingExample extends HttpServlet {

  private Logger logger = Logger.getLogger(ErrorReportingExample.class.getName());

  @Override
  public void doGet(HttpServletRequest req, HttpServletResponse resp)
      throws IOException, ServletException {

    // errors logged to stderr / Cloud logging with exceptions are automatically reported.
    logger.log(Level.SEVERE, "exception using log framework", new IllegalArgumentException());

    // use the error-reporting client library only if you require logging custom error events.
    logCustomErrorEvent();

    // runtime exceptions are also automatically reported.
    throw new RuntimeException("this is a runtime exception");
  }

  private void logCustomErrorEvent() {
    try (ReportErrorsServiceClient reportErrorsServiceClient = ReportErrorsServiceClient.create()) {
      // Custom error events require an error reporting location as well.
      ErrorContext errorContext =
          ErrorContext.newBuilder()
              .setReportLocation(
                  SourceLocation.newBuilder()
                      .setFilePath("Test.java")
                      .setLineNumber(10)
                      .setFunctionName("myMethod")
                      .build())
              .build();
      // Report a custom error event
      ReportedErrorEvent customErrorEvent =
          ReportedErrorEvent.getDefaultInstance()
              .toBuilder()
              .setMessage("custom error event")
              .setContext(errorContext)
              .build();

      // default project id
      ProjectName projectName = ProjectName.of(ServiceOptions.getDefaultProjectId());
      reportErrorsServiceClient.reportErrorEvent(projectName, customErrorEvent);
    } catch (Exception e) {
      logger.log(Level.SEVERE, "Exception encountered logging custom event", e);
    }
  }
}

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 기본 서비스 계정 또는 커스텀 서비스 계정을 사용할 수 있습니다.

역할 부여에 대한 상세 설명은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.
Google Cloud 콘솔의 탐색 패널에서 Compute Engine을 선택한 후 VM 인스턴스를 선택합니다.
VM 인스턴스로 이동
cloud-platform 액세스 범위를 지정하려는 VM 인스턴스를 선택합니다.
중지를 클릭한 후 수정을 클릭합니다.
ID 및 API 액세스 섹션에서 Error Reporting 작성자 역할(roles/errorreporting.writer)이 있는 서비스 계정을 선택합니다.
액세스 범위 섹션에서 모든 Cloud API에 대한 전체 액세스 허용을 선택한 후 변경사항을 저장합니다.
시작/재개를 클릭합니다.

예시

Cloud Logging Logback Appender 또는 java.util.logging 핸들러를 사용하여 로깅된 예외는 Error Reporting 콘솔에 자동으로 보고됩니다.

다음 샘플에서는 Java 클라이언트 라이브러리를 사용하여 커스텀 오류 이벤트를 보고하는 방법을 보여줍니다.

import com.google.cloud.ServiceOptions;
import com.google.devtools.clouderrorreporting.v1beta1.ProjectName;
import com.google.devtools.clouderrorreporting.v1beta1.ReportErrorsServiceClient;
import com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;

/**
 * Snippet demonstrates using the Error Reporting API to report an exception.
 * <p>
 * When the workload runs on App Engine, GKE, Cloud Functions or another managed environment,
 * printing the exception's stack trace to stderr will automatically report the error
 * to Error Reporting.
 */
public class QuickStart {

  static String projectId;

  public static void main(String[] args) throws Exception {
    // Set your Google Cloud Platform project ID via environment or explicitly
    projectId = ServiceOptions.getDefaultProjectId();
    if (args.length > 0) {
      projectId = args[0];
    } else {
      String value = System.getenv("GOOGLE_CLOUD_PROJECT");
      if (value != null && value.isEmpty()) {
        projectId = value;
      }
    }

    try {
      throw new Exception("Something went wrong");
    } catch (Exception ex) {
      reportError(ex);
    }
  }

  /**
   * Sends formatted error report to Google Cloud including the error context.
   *
   * @param ex Exception containing the error and the context.
   * @throws IOException if fails to communicate with Google Cloud
   */
  private static void reportError(Exception ex) throws IOException {
    try (ReportErrorsServiceClient serviceClient = ReportErrorsServiceClient.create()) {
      StringWriter sw = new StringWriter();
      PrintWriter pw = new PrintWriter(sw);
      ex.printStackTrace(pw);

      ReportedErrorEvent errorEvent = ReportedErrorEvent.getDefaultInstance()
          .toBuilder()
          .setMessage(sw.toString())
          .build();
      // If you need to report an error asynchronously, use reportErrorEventCallable()
      // method
      serviceClient.reportErrorEvent(ProjectName.of(projectId), errorEvent);
    }
  }
}

개별 이벤트에 대한 데이터는 물론 오류 통계를 검색하고 관리하는 방법을 확인하려면 Java API 참조 문서를 참조하세요.

로컬 개발 환경에서 앱 실행

자체 워크스테이션에서 라이브러리를 실행하는 것과 같이 로컬 개발 환경에서 Java용 Error Reporting 패키지를 사용하려면 Java용 Error Reporting 패키지에 로컬 애플리케이션 기본 사용자 인증 정보를 제공해야 합니다. 자세한 내용은 Error Reporting에 인증을 참조하세요.

로컬 개발 환경에서 이 페이지의 Java 샘플을 사용하려면 gcloud CLI를 설치 및 초기화한 다음 사용자 인증 정보로 애플리케이션 기본 사용자 인증 정보를 설정하세요.

Google Cloud CLI를 설치합니다.
gcloud CLI를 초기화하려면 다음 명령어를 실행합니다.
```
gcloud init
```

Google 계정의 로컬 인증 사용자 인증 정보를 만듭니다.
```
gcloud auth application-default login
```
참고: gcloud CLI가 계정에 serviceusage.services.use 권한이 없다는 경고를 출력하는 경우 일부 gcloud CLI 명령어와 클라이언트 라이브러리가 작동하지 않을 수 있습니다. 관리자에게 서비스 사용량 소비자 IAM 역할(roles/serviceusage.serviceUsageConsumer)을 부여해 달라고 요청한 후 다음 명령어를 실행하세요.
```
gcloud auth application-default set-quota-project PROJECT_ID
```

자세한 내용은 로컬 개발 환경의 인증 설정를 참조하세요.

projects.events.report 메서드는 또한 API 키를 지원합니다. 인증에 API 키를 사용하려는 경우 로컬 애플리케이션 기본 사용자 인증 정보 파일을 설정할 필요가 없습니다. 자세한 내용은 Google Cloud 인증 문서에서 API 키 만들기를 수행합니다.

오류 보고서 보기

Google Cloud 콘솔의 탐색 패널에서 Error Reporting을 선택한 후 Google Cloud 프로젝트를 선택합니다.

Error Reporting으로 이동

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