From 169627a4647209343b4bfc124e0c8e8ee28f12a9 Mon Sep 17 00:00:00 2001 From: sparklton Date: Sun, 6 Nov 2016 08:45:19 +0200 Subject: [PATCH] added description for using dependancies --- lib/appenders/logFacesAppender.js | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/lib/appenders/logFacesAppender.js b/lib/appenders/logFacesAppender.js index 7f2c6dc..efe6858 100644 --- a/lib/appenders/logFacesAppender.js +++ b/lib/appenders/logFacesAppender.js @@ -1,3 +1,15 @@ +/** +* 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 +* requires either of the two: +* +* For UDP require 'dgram', see 'https://nodejs.org/api/dgram.html' +* For HTTP require 'axios', see 'https://www.npmjs.com/package/axios' +* +* Make sure your project have relevant dependancy installed before using this appender. +*/ + "use strict"; var util = require('util'); var context = {}; @@ -41,11 +53,9 @@ function servlet(config){ } /** -* logFaces appender sends JSON formatted log events to logFaces receivers. -* There are two types of receivers targetted - raw UDP sockets and HTTP. * For UDP (node.js) use the following configuration params: * { -* "type": "logFacesAppender", +* "type": "logFacesAppender", // must be present for instantiation * "application": "LFS-TEST", // name of the application (domain) * "remoteHost": "127.0.0.1", // logFaces server address (hostname) * "port": 55201 // UDP receiver listening port @@ -53,9 +63,9 @@ function servlet(config){ * * For HTTP (browsers or node.js) use the following configuration params: * { -* "type": "logFacesAppender", -* "application": "LFS-TEST", // name of the application (domain) -* "url": "http://lfs-server/..", // logFaces receiver binding name +* "type": "logFacesAppender", // must be present for instantiation +* "application": "LFS-TEST", // name of the application (domain) +* "url": "http://lfs-server/logs", // logFaces receiver servlet URL * } */ function logFacesAppender(config) {