Ghi và xem nhật ký


Ghi nhật ký là một công cụ quan trọng để gỡ lỗi và giám sát mã. Cloud Functions cho phép bạn sử dụng SDK trình ghi nhật ký, tính năng Ghi nhật ký đám mây tuỳ chỉnh của Google hoặc tiêu chuẩn đối tượng console để phát triển cho web.

Ghi nhật ký

Mặc dù bạn nên dùng SDK trình ghi nhật ký Cloud Functions cho hầu hết các trường hợp, nhưng bạn vẫn có thể chọn một trong những cách khác vì những lý do sau:

  • Bạn đã có cơ sở mã và không muốn cải tiến từ console.log.
  • Bạn đã quen với tính năng Ghi nhật ký trên đám mây (trước đây là ghi nhật ký StackDriver) và muốn sử dụng tính năng này để ghi nhật ký tuỳ chỉnh.

Sử dụng SDK trình ghi nhật ký Chức năng đám mây

SDK trình ghi nhật ký Cloud Functions cung cấp giao diện chuẩn có API tương tự như câu lệnh console.log và hỗ trợ các cấp độ nhật ký khác. Bạn có thể sử dụng SDK này để ghi nhật ký các sự kiện bằng dữ liệu có cấu trúc, cho phép phân tích và giám sát dễ dàng hơn.

SDK trình ghi nhật ký hỗ trợ các mục nhập nhật ký trong quá trình nhập ký tự đại diện. Ví dụ:

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

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

Ngoài ra, bạn có thể sử dụng từng tệp xuất. Ví dụ này minh hoạ dữ liệu có cấu trúc được đính kèm vào nhật ký làm đối số cuối cùng:

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'
});
  • Các lệnh logger.log() có cấp độ nhật ký INFO.
  • Các lệnh logger.info() có cấp độ nhật ký INFO.
  • Các lệnh logger.warn() có cấp độ nhật ký WARNING.
  • Các lệnh logger.error() có cấp độ nhật ký ERROR.
  • Thông báo nội bộ trong hệ thống có cấp độ nhật ký là GỠ LỖI.

Với logger.write(), bạn có thể ghi các mức độ nghiêm trọng của nhật ký bổ sung của mục nhập nhật ký là CRITICAL, ALERT và EMERGENCY. Hãy xem LogSeverity (Mức độ nghiêm trọng).

Nhật ký ghi nhật ký trên đám mây tuỳ chỉnh

Nhật ký của Cloud Functions chứa SDK trình ghi nhật ký được Cloud Logging hỗ trợ. Bạn có thể sử dụng thư viện Cloud Logging cho Node.js để ghi nhật ký các sự kiện bằng dữ liệu có cấu trúc. Việc này giúp quá trình phân tích và giám sát trở nên dễ dàng hơn.

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

Sử dụng console.log

Giải pháp đề xuất để ghi nhật ký từ một hàm là sử dụng SDK trình ghi nhật ký cho nền tảng của bạn. Với Node.js, bạn có thể sử dụng các lệnh gọi ghi nhật ký JavaScript chuẩn như console.log và console.error, nhưng trước tiên, bạn cần phải có một mô-đun đặc biệt để vá các phương thức chuẩn để các phương thức chuẩn hoạt động chính xác:

require("firebase-functions/logger/compat");

Sau khi yêu cầu mô-đun tương thích trình ghi nhật ký, bạn có thể sử dụng các phương thức console.log() như bình thường trong mã của mình:

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
index.js
  • Các lệnh console.log() có cấp độ nhật ký INFO.
  • Các lệnh console.info() có cấp độ nhật ký INFO.
  • Các lệnh console.warn() có cấp độ nhật ký ERROR.
  • Các lệnh console.error() có cấp độ nhật ký ERROR.
  • Thông báo nội bộ trong hệ thống có cấp độ nhật ký là GỠ LỖI.

Xem nhật ký

Bạn có thể xem nhật ký của các Hàm đám mây trong bảng điều khiển Google Cloud, giao diện người dùng Ghi nhật ký đám mây hoặc thông qua công cụ dòng lệnh firebase.

Sử dụng Giao diện dòng lệnh (CLI) của Firebase

Để xem nhật ký bằng công cụ firebase, hãy dùng lệnh functions:log:

firebase functions:log

Để xem nhật ký của một hàm cụ thể, hãy cung cấp tên hàm làm đối số:

firebase functions:log --only <FUNCTION_NAME>

Để biết đầy đủ các tuỳ chọn xem nhật ký, hãy xem trợ giúp dành cho functions:log:

firebase help functions:log

Sử dụng bảng điều khiển Google Cloud

Bạn có thể xem nhật ký của các chức năng trong bảng điều khiển Google Cloud.

Sử dụng giao diện người dùng ghi nhật ký đám mây

Bạn có thể xem nhật ký của Cloud Functions trong giao diện người dùng Ghi nhật ký trên đám mây.

Đang phân tích nhật ký

Cloud Logging cung cấp một bộ công cụ phân tích nhật ký mạnh mẽ mà bạn có thể dùng để giám sát Cloud Functions.

Biểu đồ và cảnh báo

Sau khi tạo các chỉ số dựa trên nhật ký để theo dõi các hàm của mình, bạn có thể tạo biểu đồ và cảnh báo dựa trên các chỉ số này. Ví dụ: bạn có thể tạo biểu đồ để trực quan hoá độ trễ theo thời gian hoặc tạo cảnh báo để cho biết có phải một lỗi nhất định xảy ra quá thường xuyên hay không.

Xem phần Tạo biểu đồ và cảnh báo để biết thông tin chi tiết về cách sử dụng các chỉ số dựa trên nhật ký trong các biểu đồ và chính sách cảnh báo.