#Logger

NocoBase erbjuder ett högpresterande loggningssystem baserat på pino. Överallt där ni har tillgång till context kan ni hämta en logger-instans via ctx.logger för att logga viktiga händelser under en plugin:s eller systemets körning.

#Grundläggande användning

// Loggar fatala fel (t.ex. misslyckad initiering)
ctx.logger.fatal('Applikationsinitiering misslyckades', { error });

// Loggar allmänna fel (t.ex. fel vid API-anrop)
ctx.logger.error('Dataladdning misslyckades', { status, message });

// Loggar varningar (t.ex. prestandarisker eller oväntade användaråtgärder)
ctx.logger.warn('Aktuellt formulär innehåller osparade ändringar');

// Loggar allmän körningsinformation (t.ex. att en komponent har laddats)
ctx.logger.info('Användarprofilkomponent laddad');

// Loggar felsökningsinformation (t.ex. statusändringar)
ctx.logger.debug('Aktuell användarstatus', { user });

// Loggar detaljerad spårningsinformation (t.ex. renderingsflöde)
ctx.logger.trace('Komponent renderad', { component: 'UserProfile' });

Dessa metoder motsvarar olika loggnivåer (från hög till låg):

#Loggformat

Varje loggutdata är i strukturerat JSON-format och innehåller som standard följande fält:

Exempel på utdata:

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

#Kontextbindning

ctx.logger injicerar automatiskt kontextinformation, såsom aktuell plugin, modul eller begärans källa, vilket gör att loggarna mer exakt kan spåras till sin källa.

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

Exempel på utdata (med kontext):

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

#Anpassad logger

Ni kan skapa anpassade logger-instanser i plugins, som ärver eller utökar standardkonfigurationen:

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

Underordnade loggers ärver huvudloggerns konfiguration och bifogar automatiskt kontext.

#Loggnivåhierarki

Pinos loggnivåer följer en numerisk definition från hög till låg, där lägre nummer indikerar lägre prioritet.
Nedan finns den fullständiga tabellen över loggnivåhierarkin:

Pino matar endast ut loggar som är större än eller lika med den aktuella level-konfigurationen. Till exempel, när loggnivån är info, kommer debug- och trace-loggar att ignoreras.

#Bästa praxis vid utveckling av plugins

1. Använd kontextloggern
   Använd ctx.logger i plugin-, modell- eller applikationskontexter för att automatiskt inkludera källinformation.

2. Skilj på loggnivåer

   • Använd error för att logga affärsundantag
   • Använd info för att logga statusändringar
   • Använd debug för att logga felsökningsinformation under utveckling

3. Undvik överdriven loggning
   Särskilt på debug- och trace-nivåer rekommenderas det att endast aktivera dem i utvecklingsmiljöer.

4. Använd strukturerad data
   Skicka in objektparametrar istället för att sammanfoga strängar, vilket underlättar logganalys och filtrering.

Genom att följa dessa metoder kan utvecklare mer effektivt spåra plugins körning, felsöka problem och upprätthålla ett strukturerat och utbyggbart loggningssystem.