Melengkapi aplikasi Java untuk Error Reporting

Anda dapat mengirim peristiwa error ke Error Reporting dari aplikasi Java menggunakan paket Error Reporting untuk Java. Gunakan paket Error Reporting untuk Java guna membuat grup error untuk kasus berikut:

• Bucket log yang berisi entri log Anda memiliki kunci enkripsi yang dikelola pelanggan (CMEK).
• Bucket log memenuhi salah satu hal berikut:
  • Bucket log disimpan di project yang sama dengan tempat asal entri log.
  • Entri log dirutekan ke project, lalu project tersebut menyimpan entri log tersebut di bucket log miliknya.
• Anda ingin melaporkan peristiwa error kustom.

Error Reporting terintegrasi dengan beberapa Google Cloud layanan, seperti Cloud Run Functions dan App Engine, Compute Engine, serta Google Kubernetes Engine. Error Reporting menampilkan peristiwa error yang dicatat ke Cloud Logging oleh aplikasi yang berjalan di layanan tersebut. Untuk mengetahui informasi selengkapnya, buka Menjalankan Google Cloud di halaman ini.

Anda juga dapat mengirim peristiwa error ke Error Reporting menggunakan Logging. Untuk mengetahui informasi tentang persyaratan pemformatan data, baca Memformat entri log untuk melaporkan peristiwa error.

Sebelum memulai

Login keakun Anda. Google Cloud Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

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 .

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 .

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

Menginstal library klien

Paket Error Reporting untuk Java memungkinkan Anda memantau dan melihat peristiwa error yang dilaporkan oleh aplikasi Java yang berjalan di hampir semua tempat.

Jika Anda menggunakan Maven, tambahkan kode berikut ke file pom.xml Anda: Untuk informasi lebih lanjut tentang BOM, lihat BOM Library Google Cloud Platform.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.86.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-errorreporting</artifactId>
  </dependency>
</dependencies>

Jika menggunakan Gradle, tambahkan kode berikut ke dependensi Anda:

implementation platform('com.google.cloud:libraries-bom:26.86.0')

implementation 'com.google.cloud:google-cloud-errorreporting'

Jika Anda menggunakan sbt, tambahkan kode berikut ke dependensi Anda:

libraryDependencies += "com.google.cloud" % "google-cloud-errorreporting" % "0.216.0-beta"

Jika menggunakan Visual Studio Code atau IntelliJ, Anda dapat menambahkan library klien ke project menggunakan plugin IDE berikut:

• Cloud Code for VS Code
• Cloud Code for IntelliJ

Plugin menyediakan fungsi tambahan, seperti pengelolaan kunci untuk akun layanan. Lihat dokumentasi setiap plugin untuk mengetahui detailnya.

Untuk mengetahui informasi selengkapnya tentang penginstalan, baca dokumentasi untuk paket Error Reporting untuk Java. Anda juga dapat melaporkan masalah menggunakan the issue tracker.

Mengonfigurasi library klien

Anda dapat menyesuaikan perilaku paket Error Reporting untuk Java. Lihat dokumentasi referensi Java API.

Menjalankan aplikasi di Google Cloud

Untuk membuat grup error menggunakan projects.events.report, akun layanan Anda memerlukan peran Error Reporting Writer (roles/errorreporting.writer).

Beberapa Google Cloud layanan secara otomatis memberikan peran Error Reporting Writer (roles/errorreporting.writer) ke akun layanan yang sesuai. Namun, Anda harus memberikan peran ini ke akun layanan yang sesuai untuk beberapa layanan.

Cloud Run dan Cloud Run Functions

Akun layanan default yang digunakan oleh Cloud Run memiliki izin peran Error Reporting Writer (roles/errorreporting.writer).

Paket Error Reporting untuk Java dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Cloud Run dikonfigurasi untuk menggunakan Error Reporting secara otomatis. Pengecualian JavaScript yang tidak tertangani akan muncul di Logging dan diproses oleh Error Reporting tanpa perlu menggunakan paket Error Reporting untuk Java.

Catatan: Error Reporting otomatis membuat peristiwa error saat entri log berisi stack trace dan tingkat keparahan entri log tidak ditetapkan atau ditetapkan ke setidaknya ERROR.

Lingkungan fleksibel App Engine

App Engine otomatis memberikan peran Error Reporting Writer (roles/errorreporting.writer) ke akun layanan default Anda.

Paket Error Reporting untuk Java dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Error Reporting diaktifkan secara otomatis untuk aplikasi lingkungan fleksibel App Engine. Tidak diperlukan penyiapan tambahan.

Catatan: Entri log error yang ditulis ke stderr diproses secara otomatis oleh Error Reporting, tanpa perlu menggunakan paket Error Reporting untuk Java secara langsung.

@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

Untuk menggunakan Error Reporting dengan Google Kubernetes Engine, lakukan hal berikut:

1. Pastikan akun layanan yang akan digunakan oleh container Anda telah diberi peran Error Reporting Writer (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Buat cluster Anda dan berikan cakupan akses cloud-platform ke cluster.

   Misalnya, perintah pembuatan berikut menentukan cakupan akses cloud-platform dan akun layanan:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Catatan: Setelah membuat cluster, Anda tidak dapat mengubah akun layanannya.

Compute Engine

Untuk menggunakan Error Reporting dengan instance VM Compute Engine, lakukan hal berikut:

1. Pastikan akun layanan yang akan digunakan oleh instance VM Anda telah diberi peran Error Reporting Writer (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Di Google Cloud konsol, buka halaman VM instances:

   Buka VM instances

   Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Compute Engine.

3. Pilih instance VM yang ingin Anda beri cakupan akses cloud-platform .

4. Klik Stop, lalu klik Edit.

5. Di bagian Identity and API access, pilih akun layanan yang memiliki peran Error Reporting Writer (roles/errorreporting.writer).

6. Di bagian Access scopes , pilih Allow full access to all Cloud APIs, lalu simpan perubahan Anda.

7. Klik Start/Resume.

Contoh

Pengecualian yang dicatat menggunakan Cloud Logging Logback Appender atau java.util.logging Handler otomatis dilaporkan ke konsol Error Reporting.

Contoh berikut menunjukkan cara menggunakan library klien Java untuk melaporkan peristiwa error kustom:

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

Lihat Dokumentasi Referensi Java API tentang cara mengambil dan mengelola statistik error serta data untuk setiap peristiwa.

Menjalankan aplikasi di lingkungan pengembangan lokal

Untuk menggunakan paket Error Reporting untuk Java di lingkungan pengembangan lokal, seperti menjalankan library di workstation Anda sendiri, Anda harus memberikan kredensial default aplikasi lokal ke paket Error Reporting untuk Java. Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi ke Error Reporting.

Untuk menggunakan contoh Java di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

1. Instal Google Cloud CLI.

2. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus terlebih dahulu login ke gcloud CLI dengan identitas gabungan Anda.

3. Jika Anda menggunakan shell lokal, buat kredensial autentikasi lokal untuk akun pengguna Anda:

   gcloud auth application-default login

   Anda tidak perlu melakukan hal ini jika menggunakan Cloud Shell.

   Catatan: Jika gcloud CLI menampilkan peringatan bahwa akun Anda tidak memiliki izin serviceusage.services.use, beberapa perintah gcloud CLI dan library klien mungkin tidak berfungsi. Minta administrator untuk memberi Anda peran IAM Konsumen Penggunaan Layanan (roles/serviceusage.serviceUsageConsumer), lalu jalankan perintah berikut:

   gcloud auth application-default set-quota-project PROJECT_ID

   Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, pastikan Anda telah login ke gcloud CLI dengan identitas gabungan Anda.

Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

Metode projects.events.report juga mendukung kunci API. Jika ingin menggunakan kunci API untuk autentikasi, Anda tidak perlu menyiapkan file Kredensial Default Aplikasi lokal. Untuk mengetahui informasi selengkapnya, lihat Membuat kunci API di Google Cloud dokumentasi autentikasi.

Melihat grup error

Di Google Cloud konsol, buka halaman Error Reporting:

Buka Error Reporting

Anda juga dapat menemukan halaman ini menggunakan kotak penelusuran.

Untuk mengetahui informasi selengkapnya, lihat Melihat dan memfilter grup error.