#Logger - Nhật ký

NocoBase cung cấp một hệ thống log hiệu năng cao dựa trên pino. Tại bất kỳ nơi nào có context, bạn đều có thể lấy instance logger thông qua ctx.logger để ghi lại các log quan trọng trong runtime của Plugin hoặc hệ thống.

#Cách dùng cơ bản

// Ghi lỗi nghiêm trọng (ví dụ: khởi tạo thất bại)
ctx.logger.fatal('Khởi tạo ứng dụng thất bại', { error });

// Ghi lỗi thông thường (ví dụ: yêu cầu API gặp lỗi)
ctx.logger.error('Tải dữ liệu thất bại', { status, message });

// Ghi cảnh báo (ví dụ: rủi ro hiệu năng hoặc thao tác bất thường của người dùng)
ctx.logger.warn('Form hiện tại có thay đổi chưa lưu');

// Ghi thông tin chạy thông thường (ví dụ: component đã tải xong)
ctx.logger.info('Component thông tin người dùng đã tải xong');

// Ghi thông tin debug (ví dụ: thay đổi trạng thái)
ctx.logger.debug('Trạng thái người dùng hiện tại', { user });

// Ghi thông tin trace chi tiết (ví dụ: quy trình render)
ctx.logger.trace('Component render xong', { component: 'UserProfile' });

Các phương thức này tương ứng với các cấp độ log khác nhau (từ cao xuống thấp):

#Định dạng log

Mỗi dòng log đầu ra là định dạng JSON có cấu trúc, mặc định bao gồm các trường sau:

Ví dụ đầu ra:

{
  "level": 30,
  "time": 1730540153064,
  "pid": 12765,
  "hostname": "nocobase.local",
  "msg": "HelloModel rendered",
  "a": "a"
}

#Gắn context

ctx.logger sẽ tự động đưa thông tin context vào, ví dụ Plugin, module hiện tại hoặc nguồn yêu cầu, giúp log truy vết nguồn gốc chính xác hơn.

plugin.context.logger.info('Plugin initialized');
model.context.logger.error('Model validation failed', { model: 'User' });

Ví dụ đầu ra (kèm context):

{
  "level": 30,
  "msg": "Plugin initialized",
  "plugin": "plugin-audit-trail"
}

#Logger tùy chỉnh

Bạn có thể tạo instance logger tùy chỉnh trong Plugin, kế thừa hoặc mở rộng cấu hình mặc định:

const logger = ctx.logger.child({ module: 'MyPlugin' });
logger.info('Submodule started');

Logger con sẽ kế thừa cấu hình của logger chính và tự động đính kèm context.

#Phân chia cấp độ log

Các cấp độ log của Pino tuân theo định nghĩa số từ cao đến thấp, số càng nhỏ thì độ ưu tiên càng thấp.
Dưới đây là bảng phân chia cấp độ log đầy đủ:

Pino chỉ xuất các log có cấp độ lớn hơn hoặc bằng cấu hình level hiện tại. Ví dụ, khi cấp độ log là info, các log debug và trace sẽ bị bỏ qua.

#Best practices trong phát triển Plugin

1. Sử dụng log có context
   Sử dụng ctx.logger trong context của Plugin, model hoặc app để tự động mang theo thông tin nguồn gốc.

2. Phân biệt cấp độ log

   • Dùng error để ghi lỗi nghiệp vụ
   • Dùng info để ghi thay đổi trạng thái
   • Dùng debug để ghi thông tin debug khi phát triển

3. Tránh log quá nhiều
   Đặc biệt ở cấp độ debug và trace, khuyến nghị chỉ bật trong môi trường phát triển.

4. Sử dụng dữ liệu có cấu trúc
   Truyền tham số dạng object thay vì nối chuỗi, giúp phân tích và lọc log dễ hơn.

Thông qua các cách trên, nhà phát triển có thể truy vết quy trình thực thi Plugin hiệu quả hơn, gỡ lỗi và giữ cho hệ thống log có cấu trúc và dễ mở rộng.