דיווח על שגיאות בפונקציות בזמן ריצה (דור ראשון)

צריך לטפל בשגיאות זמן ריצה שמתרחשות בפונקציות Cloud Run ולדווח עליהן. חריגים שלא נתפסו או ביצועים שגורמים לקריסת התהליך עלולים לגרום להפעלות במצב התחלתי, שכדאי לצמצם ככל האפשר.

הדרך המומלצת לאותת על שגיאה בפונקציה תלויה בסוג הפונקציה:

• פונקציות 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 . אפשר גם לראות את השגיאות שדווחו מפונקציה מסוימת כשבוחרים אותה מרשימת הפונקציות במסוף Google Cloud .

חריגים שלא נתפסו שנוצרו על ידי הפונקציה יופיעו בדוח השגיאות. חשוב לזכור שסוגים מסוימים של חריגות שלא נתפסו (כמו אלה שמופעלות באופן אסינכרוני) יגרמו להפעלה מחדש כשפונקציה תופעל בעתיד. כך יגדל משך הזמן שיידרש להפעלת הפונקציה.