Documentation forPapertrail

Node.js

Papertrail can accept logs from any Node.js app using a regular text log file or the libraries winston or bunyan.

If the Node.js app is running on Heroku, try the Heroku setup instead.

Send log file with remote_syslog2

Have Node log to a file, then transmit the log file to Papertrail using remote_syslog2.

To make Node log to a file, either redirect its output or use the fs module. For example, to redirect stdout to myapp.log, start the daemon with:

Copy
$ nohup node myapp.js > myapp.log &

Send events from Node.js

To asynchronously transmit events from Node.js, use the winston-syslog transport:

Copy
const os = require('os');
const winston = require('winston');
require('winston-syslog');

const papertrail = new winston.transports.Syslog({
  host: 'logsN.papertrailapp.com',
  port: XXXXX,
  protocol: 'tls4',
  localhost: os.hostname(),
  eol: '\n',
});

const logger = winston.createLogger({
  format: winston.format.simple(),
  levels: winston.config.syslog.levels,
  transports: [papertrail],
});

logger.info('hello papertrail');

See the README for more information about the winston-syslog transport. To log unhandled exceptions, see the winston documentation.

If syslog isn't available, Winston's native HTTP transport can be used with Papertrail's Token-based destination. This sends messages using a non-customizable JSON format.

Copy
const winston = require('winston');

const papertrail = new winston.transports.Http({
  host: 'logs.collector.solarwinds.com',
  path: '/v1/log',
  auth: { username: new String(''), password: 'TOKEN' },
  ssl: true,
});

const logger = winston.createLogger({
  transports: [papertrail],
});

logger.info('hello papertrail');

node-bunyan users can use the node-bunyan-syslog stream.

Related

  • node-posix library for sending to local system syslog daemon, which can then relay to Papertrail using standard syslog instructions.
  • rconsole for logging Node console to local syslog.

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.