Logger

Ein Sumor Cloud Tool.
Weitere Dokumentation

Dies ist ein leichter Logger für Node.JS. Er kann Logs auf verschiedenen Ebenen ausgeben, und Sie können den Scope, die ID und die Zeitzone anpassen.

Installation

npm i @sumor/logger --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 16.x oder höher

Erforderliches Node.JS ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

Allgemeine Verwendung

import Logger from '@sumor/logger'
const logger = new Logger()

logger.trace('Hallo Welt!')
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 TRACE MAIN - Hallo Welt!

Scope ändern

In manchen Fällen müssen wir Logs kategorisieren. scope wird hierfür verwendet.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'DEMO'
})
logger.trace('Hallo Welt!')
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 TRACE DEMO - Hallo Welt!

Benutzerkennung ändern

In manchen Fällen benötigen wir eine Benutzerkennung. id wird hierfür verwendet.

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'BENUTZER001'
})
logger.trace('Hallo Welt!')
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 TRACE MAIN BENUTZER001 - Hallo Welt!

Ebenen ändern

Meistens müssen wir nur Logs einer bestimmten Ebene ausgeben. Dann können wir entscheiden, ob wir sie speichern und anzeigen oder nicht.

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('Hallo Welt!') // trace ist die unterste Ebene, alle Logs werden ausgegeben
logger.debug('Hallo Welt!')
logger.info('Hallo Welt!')
logger.warn('Hallo Welt!')
logger.error('Hallo Welt!')
logger.fatal('Hallo Welt!') // fatal ist die höchste Ebene, nur kritische Fehler werden ausgegeben

Zeitzone ändern

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // UTC+2 Offset beträgt 2 Stunden
})
logger1.info('Hallo Welt!')
// Sie sehen die folgende Ausgabe:
// 2020-01-01 02:00:00.000 INFO MAIN - Hallo Welt!

const logger2 = new Logger({
  offset: 8 * 60 // UTC+8 Offset beträgt 8 Stunden
})
logger2.info('Hallo Welt!')
// Sie sehen die folgende Ausgabe:
// 2020-01-01 08:00:00.000 INFO MAIN - Hallo Welt!

Vordefinierter Code

import Logger from '@sumor/logger'
const code = {
  trace: {
    HTTP_ZUGRIFF: 'Der Benutzer greift über HTTP zu und die IP-Adresse lautet {ip}'
  },
  debug: {
    BENUTZER_TOKEN_GELADEN:
      'Die Benutzeranmeldedaten werden gelesen und die Benutzer-ID lautet {id}'
  },
  info: {
    BENUTZER_LOGIN: 'Der Benutzer meldet sich an und die Benutzer-ID lautet {id}'
  },
  warn: {
    BENUTZER_LOGOUT: 'Der Benutzer meldet sich ab und die Benutzer-ID lautet {id}'
  },
  error: {
    BENUTZER_ANMELDUNG_FEHLGESCHLAGEN:
      'Die Benutzeranmeldung ist fehlgeschlagen und die Benutzer-ID lautet {id}'
  },
  fatal: {
    BENUTZERANMELDUNG_BLOCKIERT:
      'Die Benutzeranmeldung ist gesperrt und die Benutzer-ID lautet {id}'
  }
}
const i18n = {
  zh: {
    BENUTZER_LOGIN: 'Benutzeranmeldung, Benutzer-ID ist {id}'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('BENUTZER_LOGIN', { id: 'BENUTZER001' })
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 INFO MAIN - Der Benutzer meldet sich an und die Benutzer-ID lautet BENUTZER001

const logger2 = new Logger({
  code,
  i18n,
  language: 'zh-US'
})

logger2.code('BENUTZER_LOGIN', { id: 'BENUTZER001' })
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 INFO MAIN - Der Benutzer meldet sich an und die Benutzer-ID lautet BENUTZER001

const logger3 = new Logger({
  code,
  i18n,
  language: 'zh-CN'
})

logger3.code('BENUTZER_LOGIN', { id: 'BENUTZER001' })
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 INFO MAIN - Benutzeranmeldung, Benutzer-ID ist BENUTZER001

Globale Spracheinstellung

process.env.LANGUAGE = 'zh-CN'
import Logger from '@sumor/logger'

const code = {
  info: {
    BENUTZER_LOGIN: 'Der Benutzer meldet sich an und die Benutzer-ID lautet {id}'
  }
}
const i18n = {
  zh: {
    BENUTZER_LOGIN: 'Benutzeranmeldung, Benutzer-ID ist {id}'
  }
}
const logger = new Logger({
  code,
  i18n
})

logger.code('BENUTZER_LOGIN', { id: 'BENUTZER001' })
// Sie sehen die folgende Ausgabe:
// 2020-01-01 00:00:00.000 INFO MAIN - Benutzeranmeldung, Benutzer-ID ist BENUTZER001

Ebene filtern

Wenn Sie Logs nach Ebene filtern möchten, können Sie den folgenden Code verwenden:

import Logger from '@sumor/logger'
const logger = new Logger({
  level: 'info'
})
logger.trace('Hallo Welt!') // trace ist die unterste Ebene, wird nicht ausgegeben
logger.debug('Hallo Welt!') // debug ist niedriger als info, wird nicht ausgegeben
logger.info('Hallo Welt!') // info ist gleich wie info, wird ausgegeben
logger.warn('Hallo Welt!') // warn ist höher als info, wird ausgegeben
logger.error('Hallo Welt!') // error ist höher als info, wird ausgegeben
logger.fatal('Hallo Welt!') // fatal ist die höchste Ebene, wird ausgegeben

Wenn Sie diese Bibliothek über mehrere Bibliotheken hinweg verwenden, können Sie den folgenden Code verwenden:

import Logger from '@sumor/logger'
const logger = new Logger()
process.env.LOG_LEVEL = 'info'

logger.trace('Hallo Welt!') // trace ist die unterste Ebene, wird nicht ausgegeben
logger.debug('Hallo Welt!') // debug ist niedriger als info, wird nicht ausgegeben
logger.info('Hallo Welt!') // info ist gleich wie info, wird ausgegeben
logger.warn('Hallo Welt!') // warn ist höher als info, wird ausgegeben
logger.error('Hallo Welt!') // error ist höher als info, wird ausgegeben

process.env.LOG_LEVEL = 'warn' // Log-Ebene in Echtzeit ändern
logger.info('Hallo Welt!') // info ist niedriger als warn, wird nicht ausgegeben