Informar de errores de funciones de tiempo de ejecución (1.ª gen.)

Debes gestionar e informar de los errores de tiempo de ejecución que se produzcan en las funciones de Cloud Run. Las excepciones no controladas o las ejecuciones que bloquean el proceso pueden provocar arranques en frío, que debes intentar minimizar.

La forma recomendada de que una función señale un error depende del tipo de función:

• Las funciones HTTP deben devolver códigos de estado HTTP adecuados que indiquen un error. Consulta más información en Funciones HTTP.

• Las funciones basadas en eventos deben registrar y devolver un mensaje de error. Consulta más información en el artículo sobre cómo escribir funciones basadas en eventos.

Si los errores se gestionan correctamente, las instancias de función que los detecten pueden permanecer activas y disponibles para atender solicitudes.

Emitir errores a Error Reporting

Puedes emitir un error desde una función de Cloud Run a Error Reporting, como se muestra a continuación:

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

Puedes ver los errores notificados en Informes de errores en la consola de Google Cloud . También puedes ver los errores registrados de una función concreta cuando la seleccionas en la lista de funciones de la Google Cloud consola.

Las excepciones no controladas que genere tu función aparecerán en Error Reporting. Ten en cuenta que algunos tipos de excepciones no controladas (como las que se producen de forma asíncrona) provocarán un inicio en frío en una invocación de función futura. Esto aumenta el tiempo que tardará en ejecutarse tu función.