Newsworthy Presidential Mistakes

    winston-cluster
    TypeScript icon, indicating that this package has built-in type declarations

    0.5.4 • Public • Published

    winston-cluster

    NPM Version Build Status Dependency Status

    Winston transport for Node.js clustering.
    Uses IPC to send log information from cluster workers to the master process for file based or other single threaded logging.

    Usage

    #!/usr/bin/env node
     
    var cluster = require('cluster');
    var winston = require('winston');
    var winstonCluster = require('./lib/winston-cluster');
     
    var logLevel = 'info';
     
    if (cluster.isMaster) {
     
        // Create parent thread logger
        // Other transports (ie. file writing) should be bound to this
        var logger = new winston.Logger({
            transports: [
                new winston.transports.Console({
                    level: logLevel,
                }),
            ]
        });
     
        // Start child threads
        var cpuCount = require('os').cpus().length;
        for (var i = 0; i < cpuCount; i++) {
            cluster.fork();
        }
     
        // Bind event listeners to child threads using the local logger instance
        // has to be called after the child threads are started.
        winstonCluster.bindListeners(logger);
     
        // Logging works as normal in the main thread
        logger.info("Started server!")
     
        // Server thread logic here
        // ...
     
    } else {
     
        // Create a new logger instance for the child thread using the cluster transport to
        // send data back to the parent thread.
        // Note that log level must also be set here to avoid filtering prior to sending logs back
        var logger = winston.createLogger({transports: [
            new winstonCluster({
                level: logLevel,
            }),
        ]})
     
        // Logging in this instance now passed via IPC back to the parent
        // (and tagged with the worker thread ID)
        logger.info("Test Message!")
     
        // Client thread logic here
        // ...
     
    }

    Binding Multiple Logger Instances

    See example-multi-logger.js for an example on binding multiple logger instances.

    TODO

    • Write tests (check message passing works between threads)
    • Refactor names of messages structures (maybe add a prototype)
    • Allow bypass for other callbacks on non log messages

    Install

    npm i winston-cluster

    DownloadsWeekly Downloads

    514

    Version

    0.5.4

    License

    MIT

    Unpacked Size

    17.2 kB

    Total Files

    10

    Last publish

    Collaborators

    • ryankurte
    • zerote000
    • ralphschuler