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


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

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

แม้ว่าเราจะแนะนำให้ใช้ SDK ตัวบันทึก Cloud Functions ในสถานการณ์ส่วนใหญ่ แต่คุณอาจเลือกหนึ่งในตัวเลือกอื่นๆ ก็ได้ด้วยเหตุผลต่อไปนี้

  • คุณมีฐานของโค้ดอยู่แล้วและไม่ต้องการเปลี่ยนโครงสร้างภายในโค้ดจาก console.log
  • คุณคุ้นเคยกับ Cloud Logging (เดิมเรียกว่าการบันทึก StackDriver) และต้องการใช้สำหรับการบันทึกที่กำหนดเองมากกว่า

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

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

SDK ตัวบันทึกรองรับรายการบันทึกโดยเป็นส่วนหนึ่งของการนำเข้าไวลด์การ์ด เช่น

  const functions = require("firebase-functions");

  functions.logger.log("Hello from info. Here's an object:", someObj);

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

const { warn } = require("firebase-functions/logger");


// Attach structured data to the log as the last argument.
warn("This is a 'WARNING' severity message with some metadata.", {
  key1: 'val1',
  key2: 'val2'
});
  • คำสั่ง logger.log() มีระดับการบันทึก INFO
  • คำสั่ง logger.info() มีระดับการบันทึก INFO
  • คำสั่ง logger.warn() มีระดับการบันทึก WARNING
  • คำสั่ง logger.error() มีระดับการบันทึก ERROR
  • ข้อความของระบบภายในจะมีระดับการบันทึกเป็น DEBUG

เมื่อใช้ logger.write() คุณจะเขียนระดับความรุนแรงของบันทึกการเพิ่มรายการบันทึกเป็น CRITICAL, ALERT และ EMERGENCY ได้ ดูความรุนแรงของบันทึก

บันทึกของ Cloud Logging ที่กำหนดเอง

บันทึก Cloud Functions ที่มี SDK ของตัวบันทึกได้รับการสนับสนุนโดย Cloud Logging คุณใช้ไลบรารี Cloud Logging สำหรับ Node.js เพื่อบันทึกเหตุการณ์ด้วยข้อมูลที่มีโครงสร้าง ซึ่งช่วยให้วิเคราะห์และตรวจสอบได้ง่ายขึ้น

const { Logging } = require('@google-cloud/logging');

// ...

// Instantiate the logging SDK. The project ID will
// be automatically inferred from the Cloud Functions environment.
const logging = new Logging();
const log = logging.log('my-custom-log-name');

// This metadata is attached to each log entry. This specifies a fake
// Cloud Function called 'Custom Metrics' in order to make your custom
// log entries appear in the Cloud Functions logs viewer.
const METADATA = {
  resource: {
    type: 'cloud_function',
    labels: {
      function_name: 'CustomMetrics',
      region: 'us-central1'
    }
  }
};

// ...

// Data to write to the log. This can be a JSON object with any properties
// of the event you want to record.
const data = {
  event: 'my-event',
  value: 'foo-bar-baz',

  // Optional 'message' property will show up in the Firebase
  // console and other human-readable logging surfaces
  message: 'my-event: foo-bar-baz'
};

// Write to the log. The log.write() call returns a Promise if you want to
// make sure that the log was written successfully.
const entry = log.entry(METADATA, data);
log.write(entry);

กำลังใช้ 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
  • ข้อความของระบบภายในจะมีระดับการบันทึกเป็น DEBUG

การดูบันทึก

คุณจะดูบันทึกสำหรับ 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

การใช้ Cloud Logging UI

คุณดูบันทึกสำหรับ Cloud Functions ใน Cloud Logging UI

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

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

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

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

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