Relatar erros de função de tempo de execução

Observação: este conteúdo se aplica apenas às funções do Cloud Run, anteriormente chamadas de Cloud Functions (2ª geração).

Para a versão de 1ª geração deste documento, consulte Informar erros de função de tempo de execução (1ª geração).

Trate e relate erros de ambiente de execução que ocorrem no Cloud Run functions. Execuções ou exceções não identificadas que causam falhas no processo podem resultar em inicializações a frio, o que geralmente você deve tentar minimizar.

A maneira recomendada para uma função sinalizar um erro depende do tipo de função:

• As funções HTTP retornarão códigos de status HTTP apropriados que denotarem um erro. Consulte Funções HTTP para mais informações.

• As funções orientadas a eventos precisam registrar e retornar uma mensagem de erro. Consulte Escrever funções orientadas a eventos para mais informações.

Se os erros forem tratados adequadamente, as instâncias de função que encontrarem erros poderão permanecer ativas e disponíveis para atender às solicitações.

Aviso: nos ambientes de execução do Node.js, Python e Go do Cloud Run functions, as exceções não processadas são exibidas na resposta ao autor da chamada da função. Isso inclui funções não autenticadas (públicas). Reveja as mensagens de exceção para verificar se elas não contêm informações que você não quer expor ao autor da chamada.

Informar erros ao Error Reporting

É possível informar um erro de uma função do Cloud Run para o Error Reporting, conforme mostrado abaixo:

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

Para ter relatórios de erros mais detalhados, use as bibliotecas de cliente do Error Reporting.

Para ver os erros registrados, use o Error Reporting no console do Google Cloud. Também é possível ver os erros registrados de uma função específica quando a seleciona na lista de funções no console do Google Cloud.

As exceções não identificadas que foram produzidas pela função serão exibidas no Error Reporting. Alguns tipos de exceções não identificadas (como as geradas de forma assíncrona) farão com que uma inicialização a frio ocorra em uma invocação futura de uma função. Isso aumenta o tempo de execução da função.