chore: deprecate logstash http appender

log4js-node · Jul 1, 2018 · 9371871 · 9371871
1 parent d164421
commit 9371871
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 36 deletions.
diff --git a/docs/appenders.md b/docs/appenders.md
@@ -27,7 +27,6 @@ The following appenders are included with log4js. Some require extra dependencie
 * [logFaces-HTTP](logFaces-HTTP.md)
 * [logFaces-UDP](logFaces-UDP.md)
 * [logLevelFilter](logLevelFilter.md)
-* [logstashHTTP](logstashHTTP.md)
 * [multiFile](multiFile.md)
 * [multiprocess](multiprocess.md)
 * [recording](recording.md)
@@ -41,6 +40,7 @@ The following appenders are supported by log4js, but will issue deprecation warn
 * [gelf](https://github.com/log4js-node/gelf)
 * [hipchat](https://github.com/log4js-node/hipchat)
 * [loggly](https://github.com/log4js-node/loggly)
+* [logstashHTTP](https://github.com/log4js-node/logstashHTTP)
 * [logstashUDP](https://github.com/log4js-node/logstashUDP)
 * [mailgun](https://github.com/log4js-node/mailgun)
 * [rabbitmq](https://github.com/log4js-node/rabbitmq)

diff --git a/docs/logstashHTTP.md b/docs/logstashHTTP.md
diff --git a/examples/logstashHTTP.js b/examples/logstashHTTP.js
@@ -7,7 +7,7 @@ log4js.configure({
     },
     logstash: {
       url: 'http://172.17.0.5:9200/_bulk',
-      type: 'logstashHTTP',
+      type: '@log4js-node/logstash-http',
       logType: 'application',
       logChannel: 'node',
       application: 'logstash-log4js',

diff --git a/lib/appenders/logstashHTTP.js b/lib/appenders/logstashHTTP.js
@@ -1,4 +1,6 @@
 /**
+ * This appender is deprecated, please apply any bugfixes or changes
+ * to https://github.com/log4js-node/logstash-http
  * logstashHTTP appender sends JSON formatted log events to logstashHTTP receivers.
  *
  * HTTP require 'axios', see 'https://www.npmjs.com/package/axios'
@@ -31,7 +33,7 @@ function logstashHTTPAppender(config) {
     withCredentials: true,
   });
 
-  return function log(event) {
+  const appender = function log(event) {
     const logstashEvent = [
       {
         index: {
@@ -61,6 +63,10 @@ function logstashHTTPAppender(config) {
         console.error(`log4js.logstashHTTP Appender error: ${error.message}`);
       });
   };
+
+  appender.deprecated = '@log4js-node/logstash-http';
+
+  return appender;
 }
 
 function configure(config) {