Informa errores de funciones del entorno de ejecución

Debes informar y manejar los errores del entorno de ejecución que ocurren en Cloud Functions. Las excepciones o ejecuciones no detectadas que dañan el proceso pueden dar como resultado inicios en frío, que en general debes intentar minimizar.

La forma recomendada para que una función indique un error depende del tipo de función:

  • Las funciones de HTTP deben mostrar códigos de estado HTTP correctos que denoten un error. Consulta Funciones de HTTP para obtener más información.

  • Las funciones controladas por eventos deben registrar y mostrar un mensaje de error. Consulta Funciones en segundo plano y Funciones de CloudEvent para obtener más información.

Si se controlan los errores de forma adecuada, las instancias de función que experimenten errores pueden permanecer activas y disponibles para entregar solicitudes.

Emite errores a Error Reporting

Para emitir un error desde una función de Cloud Functions en Error Reporting, haz lo siguiente:

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)

Comienza a usarlo


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 quieres obtener un informe de errores más detallado, puedes usar las bibliotecas cliente de Error Reporting.

En la consola de Google Cloud, puedes ver los errores informados en Error Reporting. También puedes ver los errores informados de una función en particular cuando la seleccionas en la lista de funciones de la consola de Google Cloud.

Las excepciones sin detectar que genere la función aparecerán en Error Reporting. Ten en cuenta que algunos tipos de excepciones sin detectar (como las que se muestran de forma asíncrona) provocarán un inicio en frío en una invocación de función futura. Esto aumentará la cantidad de tiempo que demorará en ejecutarse tu función.