Ghi và xem nhật ký


Ghi nhật ký là một công cụ quan trọng để gỡ lỗi và giám sát mã. Cloud Functions cung cấp cho bạn lựa chọn sử dụng SDK trình ghi nhật ký để Node.js hoặc Python, hoặc tiêu chuẩn đối tượng console để phát triển cho web.

Cloud Logging là một dịch vụ có tính phí; bạn có thể phải trả phí nếu muốn vượt quá hạn mức miễn phí. Để biết thêm thông tin, hãy xem Giá dành cho tính năng Ghi nhật ký đám mây.

Ghi nhật ký

Sử dụng SDK trình ghi nhật ký Cloud Functions

SDK trình ghi nhật ký Cloud Functions cung cấp giao diện chuẩn để báo cáo trạng thái của các hàm cho tính năng Ghi nhật ký trên đám mây. Bạn có thể sử dụng SDK này để ghi nhật ký sự kiện bằng dữ liệu có cấu trúc, cho phép phân tích và giám sát dễ dàng hơn.

Nhập từ gói con logger:

Node.js

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

Python

from firebase_functions import logger
  • Các lệnh logger.log() có cấp độ nhật ký INFO.

  • Các lệnh logger.info() có cấp độ nhật ký INFO.

  • Các lệnh logger.warn() có cấp độ nhật ký WARNING.

  • Các lệnh logger.error() có cấp độ nhật ký ERROR.

  • Các lệnh logger.debug() có cấp độ nhật ký DEBUG.

  • Thông báo nội bộ trong hệ thống có cấp độ nhật ký là GỠ LỖI.

Ví dụ sau minh hoạ một hàm ghi nhật ký cơ bản:

Node.js

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

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

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!")

Sử dụng các cấp độ nhật ký khác nhau cho các loại nhật ký khác nhau trong mã hàm. Bạn có thể đính kèm dữ liệu có cấu trúc vào nhật ký làm đối số cuối cùng. Dưới đây là một ví dụ về cách một hàm có thể sử dụng từng loại nhật ký:

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

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!")

Với logger.write(), bạn có thể ghi mục nhập nhật ký bằng mức độ nghiêm trọng của nhật ký về CRITICAL, ALERTEMERGENCY. Hãy xem LogSeverity (Mức độ nghiêm trọng).

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

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)

Sử dụng console.log

Giải pháp đề xuất để ghi nhật ký từ một hàm là sử dụng SDK trình ghi nhật ký cho nền tảng của bạn. Với Node.js, bạn có thể dùng tính năng ghi nhật ký JavaScript tiêu chuẩn chẳng hạn như console.logconsole.error, nhưng trước tiên, bạn cần yêu cầu mô-đun đặc biệt để vá các phương thức chuẩn để hoạt động chính xác:

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

Sau khi yêu cầu mô-đun tương thích với trình ghi nhật ký, bạn có thể sử dụng console.log() phương thức như bình thường trong mã của bạn:

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
  • Các lệnh console.log() có cấp độ nhật ký INFO.
  • Các lệnh console.info() có cấp độ nhật ký INFO.
  • Các lệnh console.warn() có cấp độ nhật ký ERROR.
  • Các lệnh console.error() có cấp độ nhật ký ERROR.
  • Thông báo nội bộ trong hệ thống có cấp độ nhật ký là GỠ LỖI.

Xem nhật ký

Bạn có thể xem nhật ký cho Cloud Functions trong Bảng điều khiển Google Cloud, Giao diện người dùng Cloud Logging hoặc thông qua công cụ dòng lệnh firebase.

Sử dụng Giao diện dòng lệnh (CLI) của Firebase

Để xem nhật ký bằng công cụ firebase, hãy dùng lệnh functions:log:

firebase functions:log

Để xem nhật ký của một hàm cụ thể, hãy cung cấp tên hàm làm đối số:

firebase functions:log --only <FUNCTION_NAME>

Để biết đầy đủ các tuỳ chọn xem nhật ký, hãy xem trợ giúp dành cho functions:log:

firebase help functions:log

Sử dụng bảng điều khiển Google Cloud

Bạn có thể xem nhật ký của các hàm trong bảng điều khiển Google Cloud.

Sử dụng giao diện người dùng Cloud Logging

Bạn có thể xem nhật ký về Cloud Functions trong giao diện người dùng Cloud Logging.

Đang phân tích nhật ký

Cloud Logging cung cấp một bộ công cụ phân tích nhật ký mạnh mẽ để bạn có thể dùng để giám sát Cloud Functions của bạn.

Biểu đồ và cảnh báo

Sau khi tạo các chỉ số dựa trên nhật ký để giám sát các chức năng của mình, bạn có thể tạo biểu đồ và cảnh báo dựa trên những chỉ số này. Ví dụ: bạn có thể tạo biểu đồ trực quan hoá độ trễ theo thời gian hoặc tạo cảnh báo để cho bạn biết nếu một lỗi nhất định xảy ra quá thường xuyên.

Xem Tạo biểu đồ và cảnh báo để biết thông tin chi tiết về cách thực hiện sử dụng các chỉ số dựa trên nhật ký trong các biểu đồ và chính sách cảnh báo.