Instrumenter des applications Java pour Error Reporting

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis des applications Java à l'aide du package Error Reporting pour Java. Utilisez le package Error Reporting pour Java afin de créer des groupes d'erreurs dans les cas suivants:

• Votre bucket de journaux contient des clés de chiffrement gérées par le client (CMEK).
• Vos buckets de journaux ne se trouvent pas dans la région global.
• Vous souhaitez signaler les événements d'erreur personnalisés.

Error Reporting est intégré à certains services Google Cloud, tels que App Engine, Compute Engine et Google Kubernetes Engine. Error Reporting vous permet d'afficher les erreurs qui sont consignées dans Cloud Logging par les applications exécutées sur ces services. Pour en savoir plus, consultez la section Exécuter sur Google Cloud sur cette page.

Vous pouvez également envoyer des données d'erreur à Error Reporting à l'aide de Logging. Pour en savoir plus sur les exigences en matière de mise en forme des données, consultez la page Formater les messages d'erreur dans Logging.

Avant de commencer

1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

4. Activez Error Reporting API .

   Activer l'API

5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

6. Vérifiez que la facturation est activée pour votre projet Google Cloud.

7. Activez Error Reporting API .

   Activer l'API

Installer la bibliothèque cliente

Le package Error Reporting pour Java vous permet de surveiller et d'afficher les erreurs signalées par les applications Java exécutées depuis presque n'importe quel emplacement.

Pour en savoir plus sur l'installation, consultez la documentation sur le package Error Reporting pour Java. Vous pouvez également signaler d'éventuels problèmes à l'aide de l'outil de suivi des problèmes.

Configurer la bibliothèque cliente

Vous pouvez personnaliser le comportement du package Error Reporting pour Java. Consultez la documentation de référence de l'API Java.

Exécuter des applications sur Google Cloud

Pour créer des groupes d'erreurs à l'aide de projects.events.report, votre compte de service doit disposer du rôle Rédacteur Error Reporting (roles/errorreporting.writer).

Certains services Google Cloud accordent automatiquement le rôle Rédacteur Error Reporting (roles/errorreporting.writer) au compte de service approprié. Toutefois, vous devez attribuer ce rôle au compte de service approprié pour certains services.

Environnement flexible App Engine

App Engine attribue automatiquement le rôle Rédacteur Error Reporting (roles/errorreporting.writer) à votre compte de service par défaut.

Le package Error Reporting pour Java peut être utilisé sans avoir à fournir explicitement des identifiants.

Error Reporting est automatiquement activé pour les applications de l'environnement flexible App Engine. Aucune configuration supplémentaire n'est requise.

Remarque :Les journaux d'erreurs écrits dans stderr sont traités automatiquement par Error Reporting, sans avoir à utiliser directement le package Error Reporting pour Java.

@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

Pour utiliser Error Reporting avec Google Kubernetes Engine, procédez comme suit:

1. Assurez-vous que le compte de service que votre conteneur doit utiliser a reçu le rôle Rédacteur Error Reporting (roles/errorreporting.writer).

   Vous pouvez utiliser le compte de service Compute Engine par défaut ou un compte de service personnalisé.

   Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer l'accès aux projets, aux dossiers et aux organisations.

2. Créez votre cluster et accordez-lui le niveau d'accès cloud-platform.

   Par exemple, la commande create suivante spécifie le niveau d'accès cloud-platform et un compte de service:

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

Remarque :Une fois le cluster créé, vous ne pouvez plus modifier son compte de service.

Compute Engine

Pour utiliser Error Reporting avec des instances de VM Compute Engine, procédez comme suit:

1. Assurez-vous que le compte de service que votre instance de VM doit utiliser a reçu le rôle Rédacteur Error Reporting (roles/errorreporting.writer).

   Vous pouvez utiliser le compte de service Compute Engine par défaut ou un compte de service personnalisé.

   Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer l'accès aux projets, aux dossiers et aux organisations.

2. Dans la console Google Cloud, accédez à la page Instances de VM :

   Accéder à la page Instances de VM

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.

3. Sélectionnez l'instance de VM à laquelle vous souhaitez recevoir le niveau d'accès cloud-platform.

4. Cliquez sur Arrêter, puis sur Modifier.

5. Dans la section Identité et accès à l'API, sélectionnez un compte de service doté du rôle Rédacteur Error Reporting (roles/errorreporting.writer).

6. Dans la section Niveaux d'accès, sélectionnez Autoriser l'accès complet à l'ensemble des API Cloud, puis enregistrez vos modifications.

7. Cliquez sur Démarrer/Réactiver.

Exemple

Les exceptions enregistrées à l'aide de l'appender de journalisation Cloud Logging ou du java.util.logging Handler sont automatiquement signalées à la console Error Reporting.

L'exemple suivant montre comment utiliser la bibliothèque cliente Java pour signaler un événement d'erreur personnalisé:

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

Consultez la documentation de référence de l'API Java pour savoir comment récupérer et gérer les statistiques d'erreur ainsi que les données relatives aux événements individuels.

Exécuter des applications dans un environnement de développement local

Pour utiliser le package Error Reporting pour Java dans un environnement de développement local (par exemple, en exécutant la bibliothèque sur votre propre poste de travail), vous devez fournir les identifiants par défaut de l'application locale à votre package Error Reporting pour Java. Pour en savoir plus, consultez S'authentifier auprès d'Error Reporting.

Pour utiliser les exemples Java de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez le service Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

1. Installez Google Cloud CLI.

2. Pour initialiser gcloudCLI, exécutez la commande suivante :

   gcloud init

3. Créez des identifiants d'authentification locaux pour votre compte Google :

   gcloud auth application-default login

   Remarque : Si gcloud CLI affiche un avertissement indiquant que votre compte ne dispose pas de l'autorisation serviceusage.services.use, certaines commandes gcloud CLI ainsi que certaines bibliothèques clientes peuvent ne pas fonctionner. Demandez à un administrateur de vous attribuer le rôle IAM "Consommateur de Service Usage" (roles/serviceusage.serviceUsageConsumer), puis exécutez la commande suivante :

   gcloud auth application-default set-quota-project PROJECT_ID

Pour en savoir plus, consultez les sections sur Configurer l'authentification pour un environnement de développement local.

La méthode projects.events.report est également compatible avec les clés API. Si vous souhaitez utiliser des clés API pour l'authentification, vous n'avez pas besoin de configurer un fichier d'identifiants par défaut de l'application local. Pour en savoir plus, consultez la page Créer une clé API dans la documentation sur l'authentification Google Cloud

Afficher les rapports d'erreurs

Dans la console Google Cloud, accédez à la page Error Reporting:

Accéder à Error Reporting

Vous pouvez également accéder à cette page à l'aide de la barre de recherche.

Pour en savoir plus, consultez la page Afficher les erreurs.