@pitzzae/console-syslog

console-syslog

Version 2.0.0

This module enables you to patch process.stdout.write and process.stderr.write methods in Node.js.

Usage

Install

npm install @pitzzae/console-syslog

Patching the console

const { ConsoleSyslog } = require('@pitzzae/console-syslog');
const logger = new ConsoleSyslog('tcp+gelf://127.0.0.1:12201?appName=MyAppName');

Application/Network layer

It's support multiple network layer like TCP or UDP and application layer like Syslog and GELF.

Example

tcp+gelf://127.0.0.1:12201
udp+gelf://127.0.0.1:12201
tcp+syslog://127.0.0.1:12201
udp+syslog://127.0.0.1:12201

You can append your custom query param on url to append it on all message sent with GELF connector (Syslog do not support custom entry). All custom entry send by extra option with API call overwrite initial parameter.

logger.init() it's automatically trigger on class instantiation.

You can disable package with DEBUG=console-syslog:disable environment variable.

API

Restore original process.stdout.write and process.stderr.write.

logger.restoreStd();

Restore original process.stdout.write.

logger.restoreStdOut();

Restore original process.stderr.write.

logger.restoreStdErr();

Close network socket and restore process.stdout.write and process.stderr.write.

logger.close();

Rewrite original process.stdout.write and process.stderr.write.

logger.init();

Rewrite original process.stdout.write.

logger.initStdOut();

Rewrite original process.stderr.write.

logger.initStdErr();

Send emergency message (level 0).

logger.emergency('emergency message', {
  customEntry: 'emergency custom gelf param',
});

Send alert message (level 1).

logger.alert('alert message', {
  customEntry: 'alert custom gelf param',
});

Send critical message (level 2).

logger.critical('critical message', {
  customEntry: 'critical custom gelf param',
});

Send error message (level 3).

logger.error('error message', {
  customEntry: 'error custom gelf param',
});

Send warning message (level 4).

logger.warning('warning message', {
  customEntry: 'warning custom gelf param',
});

Send notice message (level 5).

logger.notice('notice message', {
  customEntry: 'notice custom gelf param',
});

Send info message (level 6).

logger.info('info message', {
  customEntry: 'info custom gelf param',
});

Send debug message (level 7).

logger.debug('debug message', {
  customEntry: 'debug custom gelf param',
});