Skip to content

Latest commit

 

History

History
103 lines (76 loc) · 2.18 KB

README.md

File metadata and controls

103 lines (76 loc) · 2.18 KB
Raw

winston-logstash-udp

A Logstash UDP transport for winston.

Forked from sazze, which is based on a gist by mbrevoort and inspired by winston-logstash.

Usage

Configuration

  • host
    • The host location of the logstash server.
    • Default: 127.0.0.1
  • port
    • The host port to connect.
    • Default: 5043
  • appName
    • The name of the application sending logs.
    • Default: process.title

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 { codec => "json_lines" port => 5043 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.