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


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

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

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

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

การใช้ SDK ตัวบันทึกฟังก์ชันคลาวด์

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

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() มีระดับบันทึก ข้อมูล
  • คำสั่ง logger.info() มีระดับบันทึก INFO
  • คำสั่ง logger.warn() มีระดับ บันทึกคำเตือน
  • คำสั่ง logger.error() มีระดับบันทึก ข้อผิดพลาด
  • ข้อความระบบภายในมีระดับบันทึก DEBUG

ด้วย logger.write() คุณสามารถเขียนรายการบันทึกเพิ่มเติมระดับความรุนแรงของบันทึกของ CRITICAL , ALERT และ EMERGENCY ดู LogSeverity

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

บันทึกฟังก์ชันคลาวด์ที่มี 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() มีระดับบันทึก ข้อมูล
  • คำสั่ง console.info() มีระดับบันทึก ข้อมูล
  • คำสั่ง console.warn() มีระดับบันทึก ข้อผิดพลาด
  • คำสั่ง console.error() มีระดับบันทึก ข้อผิดพลาด
  • ข้อความระบบภายในมีระดับบันทึก DEBUG

กำลังดูบันทึก

บันทึกสำหรับฟังก์ชันคลาวด์สามารถดูได้ใน Google Cloud Console , Cloud Logging UI หรือผ่านเครื่องมือบรรทัดคำสั่ง 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 UI

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

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

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

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

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