zeddemore-logger 1.0.1 → 1.0.3

package/lib/zeddemore-logger.js

@@ -21,6 +21,17 @@ const DEFAULT_REQUEST_ID_ATTRIBUTE = 'requestId';
 const DEFAULT_USER_LOG_LEVEL = -1;
 const WINSTON_CONSOLE_TRANSPORT_NAME = 'console';
 
+function massageLogLevel(logLevel) {
+    if (!logLevel) return wlln.VERBOSE;
+    if (!_.isInteger(logLevel)) return logLevel;
+    return winstonLogLevelIdToName(logLevel);
+}
+
+function winstonLogLevelIdToName(levelId) {
+    const logLevelEntry =  _.find(logLevelMap, { winstonLevel: levelId });
+    return logLevelEntry ? logLevelEntry.winstonName : wlln.HTTP;
+}
+
 class ZeddemoreLogger {
 
     constructor(options) {
@@ -62,7 +73,7 @@ class ZeddemoreLogger {
 
     #buildWinstonTransport = (logLevel = this.logLevel) => {
         logLevel = logLevel || this.logLevel;
-        const level = ZeddemoreLogger.winstonLogLevelIdToName(logLevel);
+        const level = winstonLogLevelIdToName(logLevel);
         return new transports.Console({ level, name: WINSTON_CONSOLE_TRANSPORT_NAME });
     }
 
@@ -121,7 +132,7 @@ class ZeddemoreLogger {
      * @param [options] {Object}
      * @returns {Logger}
      */
-    #createLogger = (options) => {
+    createLogger = (options) => {
         options = options || { };
         return createWinstonLogger({
             format: this.#buildWinstonFormat(options, options.formats),
@@ -129,29 +140,19 @@ class ZeddemoreLogger {
         });
     }
 
-    static createLogger = (options) => {
-        const zeddemoreLogger = new ZeddemoreLogger();
-        return zeddemoreLogger.#createLogger(options);
-    }
-
-    #createRequestLogger = (requestId = null, ipAddress = null) => {
+    createRequestLogger = (requestId = null, ipAddress = null) => {
         requestId = requestId || this.#generateUuid();
         const loggerOptions = { id: requestId };
         if (ipAddress) loggerOptions.ip = ipAddress;
-        return this.#createLogger(loggerOptions);
-    }
-
-    static createRequestLogger = (requestId = null, ipAddress = null) => {
-        const zeddemoreLogger = new ZeddemoreLogger();
-        return zeddemoreLogger.#createRequestLogger(requestId, ipAddress);
+        return this.createLogger(loggerOptions);
     }
 
-    #createUserLogger = (requestId = null, username = null, logLevel = this.defaultUserLogLevel, ipAddress = null) => {
+    createUserLogger = (requestId = null, username = null, logLevel = this.defaultUserLogLevel, ipAddress = null) => {
         requestId = requestId || this.#generateUuid();
         logLevel = logLevel || this.defaultUserLogLevel;
         const loggerOptions = { id: requestId, level: logLevel, user: username };
         if (ipAddress) loggerOptions.ip = ipAddress;
-        return this.#createLogger(loggerOptions);
+        return this.createLogger(loggerOptions);
     }
 
     #generateUuid() {
@@ -187,7 +188,7 @@ class ZeddemoreLogger {
         const logger = options.logger || (options.user ? options.user.logger : null) || ((app && app.locals) ? app.locals.logger : null);
         if (logger) return logger;
         const zeddemoreLogger = new ZeddemoreLogger();
-        return zeddemoreLogger.#createLogger(options);
+        return zeddemoreLogger.createLogger(options);
     }
 
     morganMiddleware = (options) => {
@@ -220,7 +221,7 @@ class ZeddemoreLogger {
         res.header(rqh.REQUEST_ID, requestId);
         const ipAddress = requestValues.ipAddress;
         res.locals.user = res.locals.user || { };
-        res.locals.user.logger = this.#createRequestLogger(requestId, ipAddress);
+        res.locals.user.logger = this.createRequestLogger(requestId, ipAddress);
         return next();
     }
 
@@ -242,32 +243,47 @@ class ZeddemoreLogger {
         if (userLogLevel < 0) userLogLevel = this.logLevel;
         const level = this.forceLogLevel ? this.logLevel : userLogLevel;
         res.locals.user = res.locals.user || user;
-        res.locals.user.logger = this.#createUserLogger(requestId, username, level, ipAddress);
+        res.locals.user.logger = this.createUserLogger(requestId, username, level, ipAddress);
         return next();
     }
 
-    static winstonLogLevelIdToName(levelId) {
-        const logLevelEntry =  _.find(logLevelMap, { winstonLevel: levelId });
-        return logLevelEntry ? logLevelEntry.winstonName : wlln.HTTP;
+    static writeAxiosErrorLog(axiosError, logOptions, options) {
+        logOptions = logOptions || { };
+        options = options || { };
+        if (!axiosError || !axiosError.response) return;
+        const response = axiosError.response;
+        if (!response.request) return;
+        const request = response.request;
+        const logLevel = massageLogLevel(logOptions.logLevel);
+        const logger = options.logger || ZeddemoreLogger.log(options);
+        if (!logger) return;
+        const _method = request.method || null;
+        const method = _method ? chalkHttpVerb(_method) : null;
+        const path = response.config.url || '';
+        const prefix = logOptions.prefix ? `[${ logOptions.prefix }]` : null;
+        const status = chalkHttpStatus(response.status);
+        const _duration = axiosError.duration || response.duration;
+        const duration = _duration ? convertMilliseconds(_duration) : '-';
+        const _contentLength = response.headers ? response.headers[ rsh.CONTENT_LENGTH ] : null;
+        const contentLength = _contentLength ? `- ${ convertBytes(_contentLength) }` : null;
+        const parts = [ prefix, method, path, status, duration, contentLength ];
+        const message = _.compact(parts).join(' ');
+        logger[ logLevel ](message);
     }
 
-    static writeAxiosLog(axiosResponse, logOptions, options) {
-        function massageLogLevel(logLevel) {
-            if (!logLevel) return wlln.VERBOSE;
-            if (!_.isInteger(logLevel)) return logLevel;
-            return ZeddemoreLogger.winstonLogLevelIdToName(logLevel);
-        }
-        if (!axiosResponse || !axiosResponse.request) return;
+    static writeAxiosResponseLog(axiosResponse, logOptions, options) {
         logOptions = logOptions || { };
         options = options || { };
+        if (!axiosResponse || !axiosResponse.request) return;
+        const request = axiosResponse.request;
         const axiosConfig = logOptions.axios || { };
         const configData = logOptions.data ? JSON.stringify(axiosConfig.data) : null;
         const logLevel = massageLogLevel(logOptions.logLevel);
         const logger = options.logger || ZeddemoreLogger.log(options);
         if (!logger) return;
-        const _method = axiosResponse.request.method || null;
+        const _method = request.method || null;
         const method = _method ? chalkHttpVerb(_method) : null;
-        const path = axiosResponse.request.path || '';
+        const path = request.path || '';
         const prefix = logOptions.prefix ? `[${ logOptions.prefix }]` : null;
         const responseData = logOptions.response ? JSON.stringify(axiosResponse.data) : null;
         const status = chalkHttpStatus(axiosResponse.status);
@@ -283,10 +299,10 @@ class ZeddemoreLogger {
 }
 
 module.exports = {
-    createLogger: ZeddemoreLogger.createLogger,
-    createRequestLogger: ZeddemoreLogger.createRequestLogger,
     log: ZeddemoreLogger.log,
+    winstonLogLevelIdToName,
+    writeAxiosErrorLog: ZeddemoreLogger.writeAxiosResponseLog,
+    writeAxiosLog: ZeddemoreLogger.writeAxiosResponseLog, // deprecated
+    writeAxiosResponseLog: ZeddemoreLogger.writeAxiosResponseLog,
     ZeddemoreLogger,
-    winstonLogLevelIdToName: ZeddemoreLogger.winstonLogLevelIdToName,
-    writeAxiosLog: ZeddemoreLogger.writeAxiosLog,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zeddemore-logger",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Node.js Express logger using Morgan and Winston for thread and caller info tracking",
   "repository": {
     "type": "git",