chore: deprecated logFaces-UDP

log4js-node · Jul 11, 2018 · db9271b · db9271b
1 parent 111fced
commit db9271b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 38 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-UDP](logFaces-UDP.md)
 * [logLevelFilter](logLevelFilter.md)
 * [multiFile](multiFile.md)
 * [multiprocess](multiprocess.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)
+* [logFaces-UDP](https://github.com/log4js-node/logFaces-UDP)
 * [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-UDP.md b/docs/logFaces-UDP.md
diff --git a/examples/logFaces-appender.js b/examples/logFaces-appender.js
@@ -8,11 +8,11 @@ const log4js = require('../lib/log4js');
 log4js.configure({
   appenders: {
     logFaces: {
-      type: 'logFaces-UDP',       // (mandatory) appender type
-      application: 'MY-NODEJS',       // (optional) name of the application (domain)
-      remoteHost: 'localhost',        // (optional) logFaces server host or IP address
-      port: 55201,                    // (optional) logFaces UDP receiver port (must use JSON format)
-      layout: {                       // (optional) the layout to use for messages
+      type: '@log4js-node/logfaces-udp', // (mandatory) appender type
+      application: 'MY-NODEJS', // (optional) name of the application (domain)
+      remoteHost: 'localhost', // (optional) logFaces server host or IP address
+      port: 55201, // (optional) logFaces UDP receiver port (must use JSON format)
+      layout: { // (optional) the layout to use for messages
         type: 'pattern',
         pattern: '%m'
       }

diff --git a/lib/appenders/logFaces-UDP.js b/lib/appenders/logFaces-UDP.js
@@ -1,4 +1,7 @@
 /**
+ * This appender has been deprecated. Any bug fixes or improvements should be
+ * made against https://github.com/log4js-node/logFaces-UDP
+ *
  * 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
@@ -43,7 +46,7 @@ function datagram(config) {
 function logFacesUDPAppender(config) {
   const send = datagram(config);
 
-  return function log(event) {
+  const appender = function log(event) {
     // convert to logFaces compact json format
     const lfsEvent = {
       a: config.application || '', // application name
@@ -61,6 +64,9 @@ function logFacesUDPAppender(config) {
     // send to server
     send(lfsEvent);
   };
+
+  appender.deprecated = '@log4js-node/logfaces-udp';
+  return appender;
 }
 
 function configure(config) {