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 cung cấp cho bạn tùy chọn sử dụng SDK ghi nhật ký, Google Cloud Logging tùy chỉnh hoặc tiêu chuẩn đối tượng console để phát triển cho web.

Viết nhật ký

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

  • Bạn có cơ sở mã hiện có và không muốn cấu trúc lại từ console.log .
  • Bạn đã quen thuộc với Cloud Logging (trước đây là ghi nhật ký StackDriver) và thích sử dụng nó để ghi nhật ký tùy chỉnh.

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

SDK 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 lại các sự kiện bằng dữ liệu có cấu trúc , giúp phân tích và giám sát dễ dàng hơn.

SDK ghi nhật ký hỗ trợ các mục nhật ký như một phần của 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 xuất riêng lẻ. Ví dụ này minh họa 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ý CẢNH BÁO .
  • Các lệnh logger.error() có cấp độ nhật ký LỖI .
  • Thông báo hệ thống nội bộ có cấp độ nhật ký DEBUG .

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

Nhật ký ghi nhật ký đám mây tùy chỉnh

Nhật ký của Chức năng đám mây với SDK ghi nhật ký được hỗ trợ bởi Cloud Logging . Bạn có thể sử dụng thư viện Cloud Logging cho Node.js để ghi lại 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.

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 được đề xuất để ghi nhật ký từ một hàm là sử dụng SDK ghi nhật ký . Thay vào đó, bạn có thể sử dụng các lệnh gọi ghi nhật ký JavaScript tiêu chuẩn như console.log và console.error , nhưng trước tiên bạn cần yêu cầu một mô-đun đặc biệt để vá các phương thức tiêu chuẩn để hoạt động chính xác:

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

Khi đã yêu cầu mô-đun tương thích logger, 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ý LỖI .
  • Các lệnh console.error() có cấp độ nhật ký LỖI .
  • Thông báo hệ thống nội bộ có cấp độ nhật ký DEBUG .

Xem nhật ký

Bạn có thể xem nhật ký cho Chức năng đám mây trong Google Cloud Console , 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 Firebase CLI

Để xem nhật ký bằng công cụ firebase , hãy sử 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>

Để có đầy đủ các tùy chọn xem nhật ký, hãy xem trợ giúp cho functions:log :

firebase help functions:log

Sử dụng Bảng điều khiển đám mây của Google

Bạn có thể xem nhật ký các chức năng trong Google Cloud Console .

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

Bạn có thể xem nhật ký cho Chức năng đám mây trong Giao diện người dùng ghi nhật ký đám mây.

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ể sử dụng để giám sát Chức năng đám mây của mình.

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

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

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