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


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

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

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

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

การใช้ Cloud Functions Logger SDK

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

Logger 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 ได้ โปรดดู LogSeverity

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

บันทึก Cloud Functions ด้วย Logger 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

โซลูชันที่แนะนำสำหรับการบันทึกจากฟังก์ชันคือการใช้ Logger 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 Console

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

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

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

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

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

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

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