apex-logs-winston

Apex Logs transport for the popular Winston Node.js logging framework.

Installation

npm install --save apex-logs-winston

Usage

Logs are buffered in memory and flushed periodically for more efficient ingestion. By default a maxEntries of 250, and flushInterval of 5 seconds (5000) are used.

const ApexLogsTransport = require('apex-logs-winston')
const winston = require('winston')

const apex = new ApexLogsTransport({
  url: process.env.APEX_LOGS_URL,
  authToken: process.env.APEX_LOGS_AUTH_TOKEN,
  projectId: process.env.APEX_LOGS_PROJECT_ID,
})

const logger = winston.createLogger({
  levels: winston.config.syslog.levels,
  transports: [apex],
  defaultMeta: { program: 'api', host: 'api-01' }
})

logger.info('User Login', { user: { name: 'Tobi Ferret' } })

Here's an example tuning the default buffering options:

const apex = new ApexLogsTransport({
  url: process.env.APEX_LOGS_URL,
  authToken: process.env.APEX_LOGS_AUTH_TOKEN,
  projectId: process.env.APEX_LOGS_PROJECT_ID
  buffer: { maxEntries: 100, flushInterval: 5000 }
})

Heroku & AWS Lambda

Services such as Heroku and AWS Lambda expect logs to be written to stdout, in these cases use json: true to simple output an Apex Logs-friendly JSON format:

const apex = new ApexLogsTransport({ json: true })

Note that the other options do not apply in this situation.