回報執行階段函式錯誤 (第 1 代)

請妥善處理並回報 Cloud Run functions 中發生的執行階段錯誤。未處理的例外狀況，或任何導致程序異常中止的執行作業，都可能造成冷啟動，應盡量避免這種狀況發生。

針對不同類型的函式，回報錯誤的建議方式如下：

• 若為 HTTP 函式，應傳回適當的 HTTP 狀態碼來標示錯誤，詳見「HTTP 函式」。

• 若為事件導向函式，應記錄並傳回錯誤訊息，詳見「編寫事件導向函式」。

如果處理得當，發生錯誤的函式執行個體仍可維持活動狀態，繼續處理要求。

將錯誤發送至 Error Reporting

您可以將 Cloud Run 函式中的錯誤發送至 Error Reporting，方式如下：

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

如需更精細的錯誤報告，請使用 Error Reporting 用戶端程式庫。

您可以在 Google Cloud 控制台的「Error Reporting」中查看回報的錯誤；或是在 Google Cloud 控制台的函式清單選取特定函式，查看該函式所回報的錯誤。

由函式所產生的未處理例外狀況，都會顯示在Error Reporting 中。請注意，某些類型的未處理例外狀況 (例如以非同步方式擲回的項目)，會在後續函式叫用時導致冷啟動，進而增加函式執行所需的時間。