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


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

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

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

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

การใช้ SDK ของเครื่องบันทึก Cloud Functions

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

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

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

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

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

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 ที่มี 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);
index.js

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

การดูบันทึก

คุณดูบันทึกสำหรับ Cloud Functions ได้ในGoogle Cloud คอนโซล 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 คอนโซล

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

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

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

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

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

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

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