寫入和檢視記錄


記錄是用於偵錯及監控程式碼的重要工具。Cloud Functions 可讓您選擇使用 Node.js 或 Python 的記錄器 SDK，或是用於開發網頁的 console 物件標準。

Cloud Logging 是付費服務，如果超出免付費配額，系統可能會向您收費。詳情請參閱 Cloud Logging 定價。

寫入記錄

使用 Cloud Functions Logger SDK

Cloud Functions Logger SDK 提供標準介面，可將函式的狀態回報至 Cloud Logging。您可以使用這個 SDK 記錄含有結構化資料的事件，方便進行分析和監控。

從 logger 子套件匯入：

Node.js

// All available logging functions
const {
  log,
  info,
  debug,
  warn,
  error,
  write,
} = require("firebase-functions/logger");
index.js

Python

from firebase_functions import logger
main.py

  • logger.log() 指令具有 INFO 記錄層級。

  • logger.info() 指令擁有 INFO 記錄層級。

  • logger.warn() 指令具有 WARNING 記錄層級。

  • logger.error() 指令擁有 ERROR 記錄層級。

  • logger.debug() 指令具有 DEBUG 記錄層級。

  • 內部系統訊息的記錄層級為 DEBUG。

以下範例說明寫入基本記錄的函式：

Node.js

exports.helloWorld = onRequest((request, response) => {
  // sends a log to Cloud Logging
  log("Hello logs!");

  response.send("Hello from Firebase!");
});
index.js

Python

@https_fn.on_request()
def hello_world(req: https_fn.Request) -> https_fn.Response:
    # sends a log to Cloud Logging
    logger.log("Hello logs!")

    return https_fn.Response("Hello from Firebase!")
main.py

針對函式程式碼中的不同類型記錄，使用不同的記錄層級。您可以將結構化資料附加至日誌，做為最後一個引數。以下是函式如何使用各個記錄類型的範例：

Node.js

exports.getInspirationalQuote = onRequest(async (request, response) => {
  const db = getFirestore();
  const today = new Date();
  const quoteOfTheMonthRef = db
      .collection("quotes")
      .doc(`${today.getFullYear()}`)
      .collection("months")
      .doc(`${today.getMonth()}`);

  const DEFAULT_QUOTE =
      "You miss 100% of the shots you don't take. -Wayne Gretzky";
  let quote;
  try {
    const quoteOfTheMonthDocSnap = await quoteOfTheMonthRef.get();

    // Attach relevant debugging information with debug()
    debug("Monthly quote fetch result", {
      docRef: quoteOfTheMonthRef.path,
      exists: quoteOfTheMonthDocSnap.exists,
      createTime: quoteOfTheMonthDocSnap.createTime,
    });

    if (quoteOfTheMonthDocSnap.exists) {
      quote = quoteOfTheMonthDocSnap.data().text;
    } else {
      // Use warn() for lower-severity issues than error()
      warn("Quote not found for month, sending default instead", {
        docRef: quoteOfTheMonthRef.path,
        dateRequested: today.toLocaleDateString("en-US"),
      });

      quote = DEFAULT_QUOTE;
    }
  } catch (err) {
    // Attach an error object as the second argument
    error("Unable to read quote from Firestore, sending default instead",
        err);

    quote = DEFAULT_QUOTE;
  }

  // Attach relevant structured data to any log
  info("Sending a quote!", {quote: quote});
  response.json({inspirationalQuote: quote});
});
index.js

Python

@https_fn.on_request()
def get_inspirational_quote(req: https_fn.Request) -> https_fn.Response:
    firestore_client = firestore.client()
    today = datetime.date.today()
    quote_of_the_month_ref = (firestore_client.collection("quotes").doc(str(
        today.year)).collection("months").doc(str(today.month)))

    default_quote = "Python has been an important part of Google since the beginning, and remains so as the system grows and evolves."

    quote = None
    try:
        quote_of_the_month = quote_of_the_month_ref.get()

        # Attach relevant debugging information with debug()
        logger.debug(
            "Monthly quote fetch result",
            docRef=quote_of_the_month.path,
            exists=quote_of_the_month.exists,
            createTime=quote_of_the_month.createTime,
        )

        if quote_of_the_month.exists:
            quote = quote_of_the_month.to_dict()["text"]
        else:
            # Use warn() for lower-severity issues than error()
            logger.warn(
                "Quote not found for month, sending default instead",
                doc_reference=quote_of_the_month.path,
                date_requested=today.strftime("%Y-%m-%d"),
            )
            quote = default_quote
    except:
        e = sys.exc_info()[0]
        # Attach an error object as the second argument
        logger.error("Unable to read quote from Firestore, sending default instead", error=e)
        quote = default_quote

    # Attach relevant structured data to any log
    logger.info("Sending a quote!", quote=quote)
    return https_fn.Response("Hello from Firebase!")
main.py

使用 logger.write() 時，您可以編寫記錄項目，並使用其他記錄嚴重性層級 CRITICAL、ALERT 和 EMERGENCY。請參閱「LogSeverity」。

Node.js

exports.appHasARegression = onRegressionAlertPublished((event) => {
  write({
    // write() lets you set additional severity levels
    // beyond the built-in logger functions
    severity: "EMERGENCY",
    message: "Regression in production app",
    issue: event.data.payload.issue,
    lastOccurred: event.data.payload.resolveTime,
  });
});
index.js

Python

@crashlytics_fn.on_regression_alert_published()
def app_has_regression(alert: crashlytics_fn.CrashlyticsRegressionAlertEvent) -> None:
    logger.write(
        severity="EMERGENCY",
        message="Regression in production app",
        issue=alert.data.payload.issue,
        last_occurred=alert.data.payload.resolve_time,
    )
    print(alert)
main.py

正在使用 console.log

建議您使用平台的記錄器 SDK，透過函式記錄資料。在 Node.js 中，您可以改用標準的 JavaScript 記錄呼叫，例如 console.log 和 console.error，但您必須先要求特殊模組來修補標準方法，才能正常運作：

require("firebase-functions/logger/compat");

要求記錄器相容性模組後，您就可以在程式碼中照常使用 console.log() 方法：

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
index.js
  • console.log() 指令擁有 INFO 記錄層級。
  • console.info() 指令具有 INFO 記錄層級。
  • console.warn() 指令擁有 ERROR 記錄層級。
  • console.error() 指令具有 ERROR 記錄層級。
  • 內部系統訊息的記錄層級為 DEBUG。

查看記錄

您可以透過 Google Cloud 控制台、Cloud Logging UI 或 firebase 指令列工具查看 Cloud Functions 的記錄。

使用 Firebase CLI

如要使用 firebase 工具查看記錄，請使用 functions:log 指令：

firebase functions:log

如要查看特定函式的記錄，請提供函式名稱做為引數：

firebase functions:log --only <FUNCTION_NAME>

如需查看記錄的完整選項，請參閱 functions:log 的說明：

firebase help functions:log

使用 Google Cloud 主控台

您可以在 Google Cloud 控制台中查看函式的記錄。

使用 Cloud Logging UI

您可以在 Cloud Logging UI 中查看 Cloud Functions 的記錄。

分析記錄檔

Cloud Logging 提供強大的記錄分析工具套件，可用於監控 Cloud Functions。

圖表和快訊

建立以記錄為依據的指標來監控函式後，您就可以根據這些指標建立圖表和快訊。舉例來說，您可以建立圖表來視覺化時間延遲，或是建立快訊，在特定錯誤過於頻繁發生時通知您。

如要進一步瞭解如何在圖表和快訊政策中使用記錄指標，請參閱建立圖表與快訊。