1.2.2 • Published 2 years ago

node-discord-logger v1.2.2

Weekly downloads
17
License
ISC
Repository
github
Last release
2 years ago

Node Discord Logger

Send logs to Discord from your NodeJS application. See detailed documentation

Installation

npm i -S node-discord-logger

Initialization

import DiscordLogger from 'node-discord-logger';

const logger = new  DiscordLogger({
  hook: 'https://your/discord/webhook',
  icon: 'https://icon/for/service', // optional, will be included as an icon in the footer
  serviceName: 'My NodeJS Service', // optional, will be included as text in the footer
  defaultMeta: {                    // optional, will be added to all the messages
    'Process ID': process.pid,
    Host: os.hostname(),            // import os from 'os';
  },
  errorHandler: err => {            // optional, if you don't want this library to log to console
    console.error('error from discord', err);
  }
});

Usage

  • Error Message
logger.error({
  message: 'This is an error message',
  error: new Error('sample error') // This field can be included in other log functions as well
});

error message example

  • Warning Message
logger.warn({ message: 'This is warning message' });

warning message example

  • Debug Message
logger.debug({
  message: 'This is a debug message',
  json: { debug: 'data' } // This field can be included in other log functions as well
});

debug message example

  • Info Message
logger.info({
  message: 'This is a info message',
  description: 'Some additional description' // This field can be included in other log functions as well
});

info message example

  • Verbose Message
logger.verbose({ message: 'This is a verbose message' });

verbose message example

  • Silly Message
logger.silly({ message: 'This is a silly message' });

silly message example

LogMessage

FieldTypeDescriptionRequired
messagestringMain log messageyes
descriptionstringLog message descriptionno
errorErrorError object to be logged with the messageno
meta{ [key: string]: string \| number \| Date }Meta details for log messageno
jsonany (Valid JSON object)Additional JSON to be logged in discord messageno

Changelog

v1.1.0

  • Added description field in log message. See usage.
1.2.2

2 years ago

1.2.1

3 years ago

1.2.0

3 years ago

1.1.0

4 years ago

1.0.0

4 years ago