Merge pull request #747 from log4js-node/deprecate-logfaces-http

deprecated logFaces-HTTP appender
log4js-node · Jul 5, 2018 · 111fced · 111fced
2 parents 83440fa + 29a238a
commit 111fced
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 33 deletions.
diff --git a/docs/appenders.md b/docs/appenders.md
@@ -24,7 +24,6 @@ The following appenders are included with log4js. Some require extra dependencie
 * [dateFile](dateFile.md)
 * [file](file.md)
 * [fileSync](fileSync.md)
-* [logFaces-HTTP](logFaces-HTTP.md)
 * [logFaces-UDP](logFaces-UDP.md)
 * [logLevelFilter](logLevelFilter.md)
 * [multiFile](multiFile.md)
@@ -39,6 +38,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)
+* [logFaces-HTTP](https://github.com/log4js-node/logFaces-HTTP)
 * [loggly](https://github.com/log4js-node/loggly)
 * [logstashHTTP](https://github.com/log4js-node/logstashHTTP)
 * [logstashUDP](https://github.com/log4js-node/logstashUDP)

diff --git a/docs/logFaces-HTTP.md b/docs/logFaces-HTTP.md
diff --git a/lib/appenders/logFaces-HTTP.js b/lib/appenders/logFaces-HTTP.js
@@ -1,4 +1,7 @@
 /**
+ * This appender is deprecated. All bugfixes and improvements should be made in
+ * https://github.com/log4js-node/logFaces-HTTP
+ *
  * logFaces appender sends JSON formatted log events to logFaces receivers.
  * There are two types of receivers supported - raw UDP sockets (for server side apps),
  * and HTTP (for client side apps). Depending on the usage, this appender
@@ -33,7 +36,7 @@ function logFacesAppender(config) {
     withCredentials: true
   });
 
-  return function log(event) {
+  const appender = function log(event) {
     // convert to logFaces compact json format
     const lfsEvent = {
       a: config.application || '', // application name
@@ -58,6 +61,9 @@ function logFacesAppender(config) {
         console.error(`log4js.logFaces-HTTP Appender error: ${error.message}`);
       });
   };
+
+  appender.deprecated = '@log4js-node/logfaces-http';
+  return appender;
 }
 
 function configure(config) {