Signaler les erreurs de fonction de l'environnement d'exécution

Vous devez gérer et signaler les erreurs d'exécution qui se produisent dans Cloud Functions. Les exceptions ou exécutions non détectées qui plantent le processus peuvent entraîner des démarrages à froid, que vous devez généralement essayer de minimiser.

La méthode recommandée pour qu'une fonction signale une erreur dépend du type de fonction :

  • Les fonctions HTTP doivent afficher les codes d'état HTTP appropriés indiquant une erreur. Consultez la page Fonctions HTTP pour en savoir plus.

  • Les fonctions basées sur des événements doivent enregistrer et renvoyer un message d'erreur. Consultez les pages Fonctions d'arrière-plan et Fonctions CloudEvent pour plus d'informations.

Si les erreurs sont correctement traitées, les instances de fonction qui rencontrent des erreurs peuvent rester actives et disponibles pour diffuser des requêtes.

Émettre des erreurs dans Error Reporting

Vous pouvez envoyer une erreur à partir d'une fonction Cloud Functions vers Error Reporting, comme indiqué ci-dessous :

Node.js 

// These WILL be reported to Error Reporting
throw new Error('I failed you'); // Will cause a cold start if not caught

Python 

@functions_framework.http
def hello_error_1(request):
    # This WILL be reported to Error Reporting,
    # and WILL NOT show up in logs or
    # terminate the function.
    from google.cloud import error_reporting

    client = error_reporting.Client()

    try:
        raise RuntimeError("I failed you")
    except RuntimeError:
        client.report_exception()

    # This WILL be reported to Error Reporting,
    # and WILL terminate the function
    raise RuntimeError("I failed you")

@functions_framework.http
def hello_error_2(request):
    # These errors WILL NOT be reported to Error
    # Reporting, but will show up in logs.
    import logging
    import sys

    print(RuntimeError("I failed you (print to stdout)"))
    logging.warning(RuntimeError("I failed you (logging.warning)"))
    logging.error(RuntimeError("I failed you (logging.error)"))
    sys.stderr.write("I failed you (sys.stderr.write)\n")

    # This is considered a successful execution and WILL NOT be reported
    # to Error Reporting, but the status code (500) WILL be logged.
    from flask import abort

    return abort(500)

Go 


package tips

import (
	"fmt"
	"net/http"
	"os"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)

func init() {
	functions.HTTP("HTTPError", HTTPError)
}

// HTTPError describes how errors are handled in an HTTP function.
func HTTPError(w http.ResponseWriter, r *http.Request) {
	// An error response code is NOT reported to Error Reporting.
	// http.Error(w, "An error occurred", http.StatusInternalServerError)

	// Printing to stdout and stderr is NOT reported to Error Reporting.
	fmt.Println("An error occurred (stdout)")
	fmt.Fprintln(os.Stderr, "An error occurred (stderr)")

	// Calling log.Fatal sets a non-zero exit code and is NOT reported to Error
	// Reporting.
	// log.Fatal("An error occurred (log.Fatal)")

	// Panics are reported to Error Reporting.
	panic("An error occurred (panic)")
}

Java 


import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.IOException;
import java.util.logging.Logger;

public class HelloError implements HttpFunction {

  private static final Logger logger = Logger.getLogger(HelloError.class.getName());

  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    // These will NOT be reported to Error Reporting
    System.err.println("I failed you");
    logger.severe("I failed you");

    // This WILL be reported to Error Reporting
    throw new RuntimeException("I failed you");
  }
}

Si vous souhaitez obtenir des rapports d'erreurs plus détaillés, vous pouvez utiliser les bibliothèques clientes Error Reporting.

Vous pouvez afficher les erreurs signalées dans Error Reporting dans la console Google Cloud. Vous pouvez également consulter les erreurs signalées à partir d'une fonction particulière en la sélectionnant dans la liste de fonctions dans la console Google Cloud.

Les exceptions non détectées générées par votre fonction apparaissent dans Error Reporting. Notez que certains types d'exceptions non détectées (telles que celles générées de manière asynchrone) provoquent un démarrage à froid lors d'un futur appel de fonction. Cela augmente le temps nécessaire à l'exécution de votre fonction.