Node Syslog

A modern Node.js syslog library with fluent TypeScript API and native N-API bindings for Linux systems.

Features

• 🚀 Modern N-API - Stable ABI compatibility across Node.js versions
• 📝 Fluent TypeScript API - Full IntelliSense support with method chaining
• ⚡ Synchronous Only - Fast, non-blocking syslog(3) calls
• 🐧 Linux Native - Direct syslog(3) integration for ARM64/AMD64
• 📦 Binary Distribution - Precompiled binaries, no compilation required
• 🧪 Full Test Coverage - Comprehensive tests with mocked native module

Installation

npm install node-syslog
# or
pnpm add node-syslog

Note: This package only supports Linux x64/ARM64 systems.

Legacy Version Support

This version requires Node.js 22.0.0+. If you need support for older Node.js versions:

• Node.js 18+: Use npm install node-syslog@1.x (legacy version)
• Node.js < 18: Consider migrating to modern-syslog for broader compatibility

See the migration guide for detailed instructions.

Documentation

Full documentation is available at: https://schamane.github.io/node-syslog/

Quick Start

import{Syslog,SyslogFacility,SyslogLevel,SyslogOption}from'node-syslog';// Create a logger instanceconstlogger=newSyslog({ident: 'my-app',facility: SyslogFacility.LOG_LOCAL0,options: SyslogOption.LOG_PID});// Use fluent interfacelogger.info('Application started').debug('Debugging information').warning('Something might be wrong').error('An error occurred',{userId: 123,error: 'timeout'});// Or use convenience functionsimport{info,error,debug}from'node-syslog';info('Simple info message');error('Error with context',{code: 500,message: 'Internal server error'});

API Reference

Constructor Options

interfaceSyslogOptions{ident?: string;// Identifier (defaults to process name)facility?: SyslogFacility;// Syslog facility (defaults to LOG_USER)options?: SyslogOption;// Syslog options (defaults to LOG_PID)}

Logging Methods

All methods support fluent chaining:

logger.emergency(message,context?)logger.alert(message,context?)logger.critical(message,context?)logger.error(message,context?)logger.warning(message,context?)logger.notice(message,context?)logger.info(message,context?)logger.debug(message,context?)

Constants

import{SyslogFacility,SyslogLevel,SyslogOption}from'node-syslog';// FacilitiesSyslogFacility.LOG_USER// 1SyslogFacility.LOG_LOCAL0// 16SyslogFacility.LOG_DAEMON// 3// ... and more// LevelsSyslogLevel.LOG_EMERG// 0SyslogLevel.LOG_ALERT// 1SyslogLevel.LOG_CRIT// 2SyslogLevel.LOG_ERR// 3SyslogLevel.LOG_WARNING// 4SyslogLevel.LOG_NOTICE// 5SyslogLevel.LOG_INFO// 6SyslogLevel.LOG_DEBUG// 7// OptionsSyslogOption.LOG_PID// 0x01SyslogOption.LOG_CONS// 0x02SyslogOption.LOG_NDELAY// 0x08// ... and more

Examples

Basic Usage

import{Syslog,SyslogFacility}from'node-syslog';constlogger=newSyslog({ident: 'web-server',facility: SyslogFacility.LOG_DAEMON});logger.info('Server listening on port 3000');logger.error('Database connection failed',{host: 'localhost',port: 5432,error: 'ECONNREFUSED'});

Context Logging

import{createSyslog}from'node-syslog';constlogger=createSyslog({ident: 'auth-service'});functionlogUserAction(userId: number,action: string,success: boolean){logger.info('User action',{
userId,
action,
success,timestamp: newDate().toISOString()});}

Method Chaining

import{Syslog}from'node-syslog';constlogger=newSyslog();logger.debug('Starting request processing').info('Request received',{method: 'GET',path: '/api/users'}).warning('Rate limit approaching',{current: 95,limit: 100}).error('Request failed',{error: 'Timeout',duration: 5000});

Custom Facility

import{Syslog,SyslogFacility,SyslogOption}from'node-syslog';constlogger=newSyslog({ident: 'payment-service',facility: SyslogFacility.LOG_LOCAL1,options: SyslogOption.LOG_PID|SyslogOption.LOG_CONS});logger.critical('Payment processing failed',{amount: 99.99,currency: 'USD',error: 'Gateway timeout'});

Platform Support

• Operating Systems: Linux only
• Architectures: x64 (AMD64), ARM64
• Node.js: 22.0.0+

Development

# Clone repository
git clone https://github.com/yourusername/node-syslog.git
cd node-syslog
# Install dependencies
pnpm install
# Build TypeScript
pnpm run build
# Build native module
pnpm run build:native
# Run tests
pnpm test# Run tests with coverage
pnpm run test:coverage

Migration from node-syslog

This is a complete rewrite with a different API. See migration guide for detailed instructions.

// Old node-syslogconstsyslog=require('node-syslog');syslog.init('my-app',syslog.LOG_PID|syslog.LOG_ODELAY,syslog.LOG_LOCAL0);syslog.log(syslog.LOG_INFO,'Message');// New node-syslogimport{Syslog,SyslogFacility,SyslogOption,SyslogLevel}from'node-syslog';constlogger=newSyslog({ident: 'my-app',facility: SyslogFacility.LOG_LOCAL0,options: SyslogOption.LOG_PID|SyslogOption.LOG_ODELAY});logger.info('Message');

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions