เขียนและดูบันทึก


การบันทึกเป็นเครื่องมือสําคัญในการแก้ไขข้อบกพร่องและตรวจสอบโค้ด Cloud Functions มอบตัวเลือกในการใช้ Logger SDK สำหรับ Node.js หรือ Python หรือมาตรฐานออบเจ็กต์ console สำหรับการพัฒนาสำหรับเว็บ

Cloud Logging เป็นบริการที่เรียกเก็บเงินได้ และอาจเรียกเก็บเงินจากคุณหากใช้เกินโควต้าโดยไม่มีค่าใช้จ่าย ดูข้อมูลเพิ่มเติมได้ที่ราคา Cloud Logging

การเขียนบันทึก

การใช้ SDK บันทึก Cloud Functions

Logger SDK ของ Cloud Functions มีอินเทอร์เฟซมาตรฐานในการรายงานสถานะจากฟังก์ชันไปยัง Cloud Logging คุณสามารถใช้ SDK นี้เพื่อบันทึกเหตุการณ์ด้วย Structured Data ซึ่งช่วยให้การวิเคราะห์และการตรวจสอบง่ายขึ้น

นำเข้าจากแพ็กเกจย่อย logger

Node.js

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

Python

from firebase_functions import logger
  • คำสั่ง logger.log() มีระดับบันทึกเป็น INFO

  • คำสั่ง logger.info() มีระดับบันทึกเป็น INFO

  • คำสั่ง logger.warn() มีระดับบันทึกเป็นคำเตือน

  • คำสั่ง 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!");
});

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

ใช้ระดับบันทึกที่แตกต่างกันสําหรับบันทึกประเภทต่างๆ ในโค้ดฟังก์ชัน คุณสามารถแนบข้อมูลที่มีโครงสร้างกับบันทึกเป็นอาร์กิวเมนต์สุดท้ายได้ ต่อไปนี้คือตัวอย่างวิธีที่ฟังก์ชันสามารถใช้บันทึกแต่ละประเภท

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

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

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)

กำลังใช้ 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...');
});
  • คำสั่ง console.log() มีระดับบันทึกเป็น INFO
  • คำสั่ง console.info() มีระดับบันทึกเป็น INFO
  • คำสั่ง console.warn() มีระดับการบันทึกเป็น ERROR
  • คำสั่ง console.error() มีระดับบันทึกเป็น ERROR
  • ข้อความของระบบภายในจะมีระดับบันทึกเป็นแก้ไขข้อบกพร่อง

การดูบันทึก

บันทึกของ Cloud Functions จะดูได้ในคอนโซล Google Cloud, UI ของ Cloud Logging หรือผ่านเครื่องมือบรรทัดคำสั่ง firebase

การใช้ Firebase CLI

หากต้องการดูบันทึกด้วยเครื่องมือ firebase ให้ใช้คำสั่ง functions:log ดังนี้

firebase functions:log

หากต้องการดูบันทึกของฟังก์ชันที่เฉพาะเจาะจง ให้ระบุชื่อฟังก์ชันเป็นอาร์กิวเมนต์

firebase functions:log --only <FUNCTION_NAME>

สำหรับตัวเลือกการดูบันทึกทั้งหมด โปรดดูความช่วยเหลือสำหรับ functions:log:

firebase help functions:log

การใช้คอนโซล Google Cloud

คุณดูบันทึกของฟังก์ชันได้ในคอนโซล Google Cloud

การใช้ UI ของ Cloud Logging

คุณสามารถดูบันทึกของ Cloud Functions ได้ในส่วน UI ของ Cloud Logging

การวิเคราะห์บันทึก

Cloud Logging มีชุดเครื่องมือวิเคราะห์บันทึกที่มีประสิทธิภาพซึ่งคุณใช้ตรวจสอบ Cloud Functions ได้

แผนภูมิและการแจ้งเตือน

เมื่อสร้างเมตริกตามบันทึกเพื่อตรวจสอบฟังก์ชันแล้ว คุณสามารถสร้างแผนภูมิและการแจ้งเตือนตามเมตริกเหล่านี้ได้ เช่น คุณอาจสร้างแผนภูมิเพื่อแสดงภาพเวลาในการตอบสนองเมื่อเวลาผ่านไป หรือสร้างการแจ้งเตือนเพื่อแจ้งให้คุณทราบหากข้อผิดพลาดบางอย่างเกิดขึ้นบ่อยเกินไป

ดูข้อมูลโดยละเอียดเกี่ยวกับวิธีใช้เมตริกตามบันทึกในแผนภูมิและนโยบายการแจ้งเตือนได้ที่การสร้างแผนภูมิและการแจ้งเตือน