#Логер

NocoBase пропонує високопродуктивну систему логування, засновану на pino. У будь-якому місці, де доступний context, ви можете отримати екземпляр логера через ctx.logger для запису ключових журналів під час виконання плагіна або системи.

#Основне використання

// Запис критичних помилок (наприклад, збій ініціалізації)
ctx.logger.fatal('Ініціалізація застосунку не вдалася', { error });

// Запис загальних помилок (наприклад, помилки запиту API)
ctx.logger.error('Не вдалося завантажити дані', { status, message });

// Запис попереджень (наприклад, ризики продуктивності або незвичайні дії користувача)
ctx.logger.warn('Поточна форма містить незбережені зміни');

// Запис загальної інформації про роботу (наприклад, компонент завантажено)
ctx.logger.info('Компонент профілю користувача завантажено');

// Запис налагоджувальної інформації (наприклад, зміни стану)
ctx.logger.debug('Поточний стан користувача', { user });

// Запис детальної інформації для трасування (наприклад, процес рендерингу)
ctx.logger.trace('Компонент відрендерено', { component: 'UserProfile' });

Ці методи відповідають різним рівням логування (від найвищого до найнижчого):

#Формат логів

Кожен вивід логу має структурований формат JSON і за замовчуванням містить такі поля:

Приклад виводу:

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

#Прив'язка контексту

ctx.logger автоматично вбудовує контекстну інформацію, таку як поточний плагін, модуль або джерело запиту, що дозволяє точніше відстежувати походження логів.

plugin.context.logger.info('Плагін ініціалізовано');
model.context.logger.error('Перевірка моделі не вдалася', { model: 'User' });

Приклад виводу (з контекстом):

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

#Користувацький логер

Ви можете створювати власні екземпляри логера в плагінах, успадковуючи або розширюючи конфігурації за замовчуванням:

const logger = ctx.logger.child({ module: 'MyPlugin' });
logger.info('Підмодуль запущено');

Дочірні логери успадковують конфігурацію основного логера та автоматично додають контекст.

#Ієрархія рівнів логування

Рівні логування Pino дотримуються числового визначення від найвищого до найнижчого, де менші числа вказують на нижчий пріоритет.
Нижче наведено повну таблицю ієрархії рівнів логування:

Pino виводить лише ті логи, рівень яких більший або дорівнює поточному налаштуванню level. Наприклад, якщо рівень логування встановлено на info, логи debug та trace будуть ігноруватися.

#Найкращі практики у розробці плагінів

1. Використовуйте контекстний логер
   Використовуйте ctx.logger у контекстах плагінів, моделей або застосунків, щоб автоматично додавати інформацію про джерело.

2. Розрізняйте рівні логування

   • Використовуйте error для запису бізнес-винятків
   • Використовуйте info для запису змін стану
   • Використовуйте debug для запису налагоджувальної інформації під час розробки

3. Уникайте надмірного логування
   Особливо на рівнях debug та trace рекомендується вмикати їх лише в середовищах розробки.

4. Використовуйте структуровані дані
   Передавайте об'єктні параметри замість об'єднання рядків, це допомагає в аналізі та фільтрації логів.

Дотримуючись цих практик, розробники можуть ефективніше відстежувати виконання плагінів, усувати проблеми та підтримувати структурованість і розширюваність системи логування.