SQ-Logger

Wrap do LogEntries para utilização em APIs Squid

• SQ-Logger
  • Instalação
  • Uso
    • log.info(message: any!)
    • log.warning(message: any!)
    • log.error(message: any!)
    • log.log(level: string!, message: any!)
    • log.packageName[get, set]
    • log.packageVersion[get, set]
  • Casos especiais
    • Nome de aplicação não encontrado

Instalação

Em definição se vamos publicar no NPM ou não

Uso

Após a instalação use require para trazer o pacote:

const Logger = require('sq-logger').Logger

Estamos utilizando .Logger porque temos outros dois métodos mais antigos que serão removidos depois (sqReply e sqReplyError)

Crie uma nova instancia da classe:

const Logger = require('sq-logger').Logger
const log = new Logger('<token do LogEntries>')

Isto vai liberar 4 métodos principais e duas propriedades.

log.info(message: any!)

Loga uma mensagem com o nível de informação.

const Logger = require('sq-logger').Logger
const log = new Logger('<token do LogEntries>')

log.info('uma mensagem')
log.info({name: 'Objeto', mensagem: 'A mensagem'})

log.warning(message: any!)

Loga uma mensagem com o nível de aviso.

const Logger = require('sq-logger').Logger
const log = new Logger('<token do LogEntries>')

log.warning('uma mensagem')
log.warning({name: 'Objeto', mensagem: 'A mensagem'})

log.error(message: any!)

Loga uma mensagem com o nível de erro.

const Logger = require('sq-logger').Logger
const log = new Logger('<token do LogEntries>')

log.error('uma mensagem')
log.error({name: 'Objeto', mensagem: 'A mensagem'})

log.log(level: string!, message: any!)

Quando nenhum dos níveis acima for suficiente, expomos um método para utilização de qualquer outro nível que esteja documentado no pacote do Log Entries:

• info
• debug
• warning
• err
• crit
• alert
• notice
• emerg

const Logger = require('sq-logger').Logger
const log = new Logger('<token do LogEntries>')

log.log('notice', 'uma mensagem de notice')
log.log('crit', {name: 'Objeto crítico', mensagem: 'A mensagem'})

log.packageName[get, set]

Busca ou seta o nome do pacote atual

log.packageVersion[get, set]

Busca ou seta a versão do pacote no formato 0.0.0

Casos especiais

Nome de aplicação não encontrado

Usamos um pacote para buscar o package.json e pegar o nome e a versão da sua aplicação, mas as vezes isso pode não funcionar, se este for o caso uma mensagem será exibida no console e você poderá setar manualmente através de:

const log = new Logger('token')

log.packageName = 'Meu package'
log.packageVersion = '1.2.3'