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
});

• Warning Message

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

• Debug Message

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

• 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
});

• Verbose Message

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

• Silly Message

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

LogMessage

| Field | Type | Description | Required | |---|---|---|---| | message | string | Main log message | yes | | description | string | Log message description | no | | error | Error | Error object to be logged with the message | no | | meta | { [key: string]: string \| number \| Date } | Meta details for log message | no | | json | any (Valid JSON object) | Additional JSON to be logged in discord message | no |

Changelog

v1.1.0

• Added description field in log message. See usage.