Strumenti per app Java per Error Reporting

Puoi inviare report sugli errori a Error Reporting dalle applicazioni Java utilizzando il pacchetto Error Reporting per Java. Utilizza il pacchetto Error Reporting per Java per creare gruppi di errori nei seguenti casi:

  • Il bucket di log ha chiavi di crittografia gestite dal cliente (CMEK).
  • I bucket di log non si trovano nella regione global.
  • Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni servizi Google Cloud, come App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting visualizza gli errori registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per ulteriori informazioni, vai ad In esecuzione su Google Cloud in questa pagina.

Puoi anche inviare i dati sugli errori a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, consulta Formattazione dei messaggi di errore in Logging.

Prima di iniziare

  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.

    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.

    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

Installa la libreria client

Il pacchetto Error Reporting per Java consente di monitorare e visualizzare gli errori segnalati dalle applicazioni Java eseguite quasi ovunque.

Per ulteriori informazioni sull'installazione, consulta la documentazione relativa al pacchetto Error Reporting per Java. Puoi anche segnalare i problemi utilizzando lo strumento Issue Tracker.

Configura la libreria client

Puoi personalizzare il comportamento del pacchetto Error Reporting per Java. Consulta la documentazione di riferimento dell'API Java.

Esegui app su Google Cloud

Per creare gruppi di errori utilizzando projects.events.report, il tuo account di servizio richiede il ruolo Writer Error Reporting (roles/errorreporting.writer).

Alcuni servizi Google Cloud concedono automaticamente il ruolo Writer Error Reporting (roles/errorreporting.writer) all'account di servizio appropriato. Tuttavia, devi concedere questo ruolo all'account di servizio appropriato per alcuni servizi.

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer Error Reporting (roles/errorreporting.writer) al tuo account di servizio predefinito.

Il pacchetto Error Reporting per Java può essere utilizzato senza dover fornire esplicitamente le credenziali.

Error Reporting è abilitato automaticamente per le applicazioni nell'ambiente flessibile di App Engine. Non è richiesta alcuna ulteriore configurazione.

@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

Per utilizzare Error Reporting con Google Kubernetes Engine:

  1. Assicurati che all'account di servizio che deve essere utilizzato dal container sia stato concesso il ruolo Writer Error Reporting (roles/errorreporting.writer).

    Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

    Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

  2. Crea il cluster e concedi al cluster l'ambito di accesso cloud-platform.

    Ad esempio, il seguente comando create specifica l'ambito di accesso cloud-platform e un account di servizio:

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

Compute Engine

Per utilizzare Error Reporting con le istanze VM di Compute Engine:

  1. Assicurati che all'account di servizio che deve essere utilizzato dall'istanza VM sia stato concesso il ruolo Writer Error Reporting (roles/errorreporting.writer).

    Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

    Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

  2. Nella console Google Cloud, seleziona Compute Engine e poi Istanze VM, oppure fai clic sul pulsante seguente:

    Vai a Istanze VM

  3. Seleziona l'istanza VM che vuoi ricevere l'ambito di accesso cloud-platform.

  4. Fai clic su Interrompi e poi su Modifica.

  5. Nella sezione Identità e accesso API, seleziona un account di servizio con il ruolo Writer Error Reporting (roles/errorreporting.writer).

  6. Nella sezione Ambiti di accesso, seleziona Consenti l'accesso completo a tutte le API Cloud, quindi salva le modifiche.

  7. Fai clic su Avvia/Riprendi.

Esempio

Le eccezioni registrate utilizzando l'appender di logback di Cloud Logging o il java.util.logging Handler vengono segnalate automaticamente nella console di Error Reporting.

L'esempio seguente mostra l'utilizzo della libreria client Java per segnalare un evento di errore personalizzato:

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

Consulta la documentazione di riferimento dell'API Java per informazioni su come recuperare e gestire le statistiche sugli errori, nonché i dati per i singoli eventi.

Eseguire app in un ambiente di sviluppo locale

Per utilizzare il pacchetto Error Reporting per Java in un ambiente di sviluppo locale, ad esempio eseguire la libreria sulla tua workstation, devi fornire il pacchetto Error Reporting per Java con le credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, vedi Eseguire l'autenticazione in Error Reporting.

Per utilizzare gli Java esempi in questa pagina in un ambiente di sviluppo locale, installa e inizializza l'interfaccia a riga di comando gcloud, quindi configura le credenziali predefinite dell'applicazione con le tue credenziali utente.

  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.

Per ulteriori informazioni, consulta Set up authentication for a local development environment.

La projects.events.report metodo supporta le chiavi API. Se vuoi utilizzare le chiavi API per l'autenticazione, non è necessario configurare un file Credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, vedi Crea una chiave API nella documentazione sull'autenticazione di Google Cloud.

Visualizzazione dei rapporti degli errori

Nella console Google Cloud, seleziona Error Reporting oppure fai clic sul pulsante seguente e seleziona un progetto:

Vai a Error Reporting

Per ulteriori informazioni, consulta la sezione Visualizzazione degli errori.