log4js-node

A port of log4js to node.js

View the Project on GitHub

SMTP Appender

Sends log events as emails. To use this appender you will need to include the nodemailer package in your dependencies. If you use this appender, you should also call log4js.shutdown when your application closes so that any remaining emails can be sent. Many of the configuration options below are passed through to nodemailer, so you should read their docs to get the most out of this appender.

Configuration

Example (default config)

log4js.configure({
  appenders: {
    'email': {
      type: 'smtp', recipients: 'dev.team@company.name'
    }
  },
  categories: { default: { appenders: [ 'email' ], level: 'error' } }
});

This configuration will send an email using the smtp server running on localhost:25, for every log event of level ERROR and above. The email will be sent to dev.team@company.name, the subject will be the message part of the log event, the body of the email will be log event formatted by the basic layout function.

Example (logs as attachments, batched)

log4js.configure({
  appenders: {
    'email': {
      type: 'smtp',
      recipients: 'dev.team@company.name',
      subject: 'Latest logs',
      sender: 'my.application@company.name',
      attachments: {
        enable: true,
        filename: 'latest.log',
        message: 'See the attachment for the latest logs'
      },
      sendInterval: 3600
    }
  },
  categories: { default: { appenders: ['email'], level: 'ERROR' } }
});

This configuration will send an email once every hour, with all the log events of level ‘ERROR’ and above as an attached file.

Example (custom SMTP host)

log4js.configure({
  appenders: {
    email: {
      type: 'smtp', smtp: { host: 'smtp.company.name', port: 8025 }, recipients: 'dev.team@company.name'
    }
  },
  categories: { default: { appenders: ['email'], level: 'info' } }
});

This configuration can also be written as:

log4js.configure({
  appenders: {
    email: {
      type: 'smtp',
      transport: {
        plugin: 'smtp',
        options: {
          host: 'smtp.company.name',
          port: 8025
        }
      },
      recipients: 'dev.team@company.name'
    }
  },
  categories: {
    default: { appenders: ['email'], level: 'info' }
  }
});

A similar config can be used to specify a different transport plugin than smtp. See the nodemailer docs for more details.