Logstash UDP transport for winston
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
lib
test
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

winston-logstash-udp Build Status

A Logstash UDP transport for winston.

Based on a gist by mbrevoort and inspired by winston-logstash.

Usage

Node

Recommended method:

    var winston = require('winston'),
        LogstashUDP = require('winston-logstash-udp').LogstashUDP;

    var logger = new(winston.Logger)({
      transports: [
        new(LogstashUDP)({
          port: 9999,
          appName: 'my application name',
          host: '127.0.0.1'
        })
      ]
    });

Alternate method:

    var winston = require('winston');

    //
    // Requiring `winston-logstash-udp` will expose
    // `winston.transports.LogstashUDP`
    //
    require('winston-logstash-udp');

    winston.add(winston.transports.LogstashUDP, {
      port: 9999,
      appName: 'my application name',
      host: '127.0.0.1'
    });

Logstash

    input {
      # Sample input over UDP
      udp { format => "json" port => 9999 type => "sample" }
    }
    output {
      stdout { debug => true debug_format => "json"}
    }

Run Tests

  npm test

Troubleshooting

  • I get an error when installing node packages *"ERR! Error: No compatible version found: assertion-error@'^1.0.1'"*

    If you are running a version of NodeJS less than or equal to 0.8, upgrading NPM to a version greater than or equal to 1.4.6 should solve this issue.

    npm install -g npm@~1.4.6
    

    Another way around is to simply avoid installing the development dependencies:

    npm install --production
    

Author: Craig Thayer

License: MIT

See LICENSE for the full license text.