Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.03 KB

README.md

File metadata and controls

36 lines (28 loc) · 1.03 KB
Raw

Mailgun Appender for Log4JS

This is an optional appender for log4js-node.

npm install @log4js-node/mailgun

This appender uses the mailgun service to send log messages as emails. It uses the mailgun-js package.

Configuration

  • type - @log4js-node/mailgun
  • apiKey - string - your mailgun API key
  • domain - string - your domain
  • from - string
  • to - string
  • subject - string
  • layout - object (optional, defaults to basicLayout) - see layouts

The body of the email will be the result of applying the layout to the log event. Refer to the mailgun docs for how to obtain your API key.

Example

log4js.configure({
  appenders: {
    type: '@log4js-node/mailgun',
    apiKey: '123456abc',
    domain: 'some.company',
    from: '[email protected]',
    to: '[email protected]',
    subject: 'Error: Developers Need To Be Fired'
  }
});