Add support for winston 3.x

CHANGELOG.md

@@ -1,10 +1,10 @@
 # Changelog
 
-## 1.0.0 (2022-11-02) - Not released yet
+## 1.0.0 (2022-11-02)
 
 Features:
 
-- release 1.x branch for for supporting Winston ^2.x
+- Add support for winston 3.x
 
 Bugfixes:
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jaakko Suutarla
+Copyright (c) 2022 Jaakko Suutarla
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -4,33 +4,46 @@
 
 A [Logstash TCP][0] transport for [winston][1].
 
-## OBS
+## Usage
 
-Due changes to Winston version >= 1.0.0 supports winston < 3.x. Updated version with Winston 3.x support will be released soon.
+### Winston 2.x
 
-## Usage
+``` js
+  // See test cases from test-bench/winston-2x/test/smoke.js
+  const winston = require('winston');
+  const transports = require('winston-logstash');
+
+    const logger = new (winston.Logger)({
+      transports: [
+        new transports.Logstash({
+              port: 28777,
+              node_name: 'my node name',
+              host: '127.0.0.1'})]});
+
+    log.info("Hello world!");
+```
 
-### Node
+### Winston 2.x
 
 ``` js
-  var winston = require('winston');
-
-  //
-  // Requiring `winston-logstash` will expose
-  // `winston.transports.Logstash`
-  //
-  require('winston-logstash');
-
-  winston.add(winston.transports.Logstash, {
-    port: 28777,
-    node_name: 'my node name',
-    host: '127.0.0.1'
-  });
+  // See test cases from test-bench/winston-3x/test/smoke.js
+  const winston = require('winston');
+  const LogstashTransport = require('winston-logstash/lib/winston-logstash-latest');
+
+    const logger = winston.createLogger({
+      transports: [
+        new LogstashTransport({
+              port: 28777,
+              node_name: 'my node name',
+              host: '127.0.0.1'})]});
+
+    log.info("Hello world!");
 ```
 
 ### Logstash config
 
 ``` ruby
+  # See example from test-bench/logstash/logstash/pipeline/default.conf
   input {
     # Sample input over TCP
     tcp { port => 28777 type=>"sample" }
@@ -56,14 +69,6 @@ Due changes to Winston version >= 1.0.0 supports winston < 3.x. Updated version
   npm test
 ```
 
-## TODO
-
-1. Rethink logstash integration ( https://github.com/flatiron/winston/blob/master/lib/winston/common.js#L149 )
-2. Rewrite
-3. Release major after rewrite
-
-N. Clean up tests ( refactor )
-
 #### Author: [Jaakko Suutarla](https://github.com/jaakkos)
 
 #### License: MIT

lib/winston-logstash-latest.js

@@ -0,0 +1,35 @@
+/* eslint-disable require-jsdoc */
+const Transport = require('winston-transport');
+const Manager = require('./manager');
+
+//
+// Inherit from `winston-transport` so you can take advantage
+// of the base functionality and `.exceptions.handle()`.
+//
+module.exports = class LogstashTransport extends Transport {
+  constructor(options) {
+    super(options);
+
+    this.name = 'logstash';
+
+    this.manager = new Manager(options, this.onError.bind(this));
+    this.manager.start();
+  }
+
+  onError(error) {
+    this.silent = true;
+    this.emit('error', error);
+  }
+
+  log(info, callback) {
+    setImmediate(() => {
+      this.emit('logged', info);
+    });
+
+    // Perform the writing to the remote service
+
+    this.manager.log(JSON.stringify(info), () => {
+      callback();
+    });
+  }
+};

lib/winston-logstash.js

@@ -1,7 +1,7 @@
 /* eslint-disable require-jsdoc */
 /*
  *
- * (C) 2013 Jaakko Suutarla
+ * (C) 2022 Jaakko Suutarla
  * MIT LICENCE
  *
  */
@@ -18,8 +18,6 @@ class Logstash extends winston.Transport {
 
     this.name = 'logstash';
     this.localhost = options.localhost || os.hostname();
-    this.host = options.host || '127.0.0.1';
-    this.port = options.port || 28777;
     this.node_name = options.node_name || process.title;
     this.pid = options.pid || process.pid;