Table of Contents

• Syslog
• Functions
• syslog.open( name, option, facility )
• syslog.log( level, msg )
• syslog.close()
• Example

Syslog

This module documents the Hop.js builtin syslog api.

Use require( hop.syslog ) to use it.

Additional information regarding syslog can be obtained in the Unix man page.

Functions

syslog.open( name, option, facility )

Initialize the syslog connection. The option argument is a bit-or combination of the following values:

• syslog.LOG_CONS: direct console writing
• syslog.LOG_NDELAY: open connection immediately
• syslog.LOG_NOWAIT: don't wait for child processes
• syslog.LOG_ODELAY: delayed opening connection until first message
• syslog.LOG_PID: include PID with each message

The value facility must be one of:

• syslog.LOG_AUTH: security/authorization messages.
• syslog.LOG_AUTHPRIV: security/authorization messages (private).
• syslog.LOG_CRON: cron messages.
• syslog.LOG_DAEMON: daemon messages.
• syslog.LOG_FTP: ftp messages.
• syslog.LOG_KERN: kernel messages.
• syslog.LOG_LOCAL0: kernel messages.
• ...
• syslog.LOG_LOCAL7: local messages
• syslog.LOG_LPR: printing messages
• syslog.LOG_MAIL: mail messages
• syslog.LOG_NEWS: news messages
• syslog.LOG_SYSLOG: syslog messages
• syslog.LOG_USER: generic user-level messages
• syslog.LOG_UUCP: uucp messages

syslog.log( level, msg )

Emit a log message. The argument msg is a string. The argument level denotes the importance of the message. The levels are, in order of decreasing importance:

• syslog.LOG_EMARG: system is unusable
• syslog.LOG_ALERT: action must be taken immediately
• syslog.LOG_CRIT: critical conditions
• syslog.LOG_ERR: error conditions
• syslog.LOG_WARNING: warning conditions
• syslog.LOG_NOTICE: normal but significant condition
• syslog.LOG_INFO: informational message
• syslog.LOG_DEBUG: debug-level message

syslog.close()

Closes the syslog connection.

Example

This example shows how to open a SYSLOG connection and how to emit messages.

syslog/syslog.js

var Syslog = require( hop.syslog );

Syslog.open( "hopjs-syslog", Syslog.LOG_PID | Syslog.LOG_ODELAY, Syslog.LOG_LOCAL0 );

Syslog.log( Syslog.LOG_INFO, "A hop.js message [v" + process.versions.hop + "]" ) ;

Syslog.close();

console.log( "check your log file (typically /var/log/syslog)" );