yog-log - npm Package Compare versions

Comparing version 0.1.10 to 0.1.11

index.js

@@ -7,2 +7,4 @@ var fs = require('fs'),
 
+const callsites = require('callsites');
+
 var util = require('./lib/util.js'),
@@ -20,4 +22,4 @@ stackTrace = require('stack-trace'),
 var LEVELS = {
-    //访问日志 编号？
-    0: 'ACCESS',
+    // 不显示 access 日志
+    // 0: 'ACCESS',
     3: 'ACCESS_ERROR',
@@ -63,15 +65,19 @@ //应用日志等级 ODP格式
 
-    this.opts = this.extend({
-        'stdout_only': false,  // 只输出 stdout，不写文件
-        'debug': 0,
-        'intLevel': 16,
-        'auto_rotate': 1,
-        'use_sub_dir': 1,
-        'IS_ODP': true,
-        'IS_OMP': 0,
-        'log_path': log_path,
-        'access_log_path': log_path + '/access',
-        'access_error_log_path': log_path + '/access',
-        'data_path': data_path + 'data'
-    }, opts);
+    this.opts = this.extend(
+        {
+            stdout_only: false, // 只输出 stdout，不写文件
+            debug: 0,
+            intLevel: 16,
+            auto_rotate: 1,
+            use_sub_dir: 1,
+            IS_ODP: true,
+            IS_OMP: 0,
+            IS_JSON: false,
+            log_path: log_path,
+            access_log_path: log_path + '/access',
+            access_error_log_path: log_path + '/access',
+            data_path: data_path + 'data'
+        },
+        opts
+    );
 
@@ -86,15 +92,19 @@ //保存一次错误及请求的详情信息
     this.format = {
-        'ACCESS': this.opts['access'] || '%h - - [%{%d/%b/%Y:%H:%M:%S %Z}t] "%m %U %H/%{http_version}i" %{status}i %b %{Referer}i %{Cookie}i %{User-Agent}i %D',
-        'ACCESS_ERROR': '%h - - [%{%d/%b/%Y:%H:%M:%S %Z}t] "%m %U %H/%{http_version}i" %{status}i %b %{Referer}i %{Cookie}i %{User-Agent}i %D',
-        'WF': this.opts['format_wf'] ||
+        ACCESS:
+            this.opts['access'] ||
+            '%h - - [%{%d/%b/%Y:%H:%M:%S %Z}t] "%m %U %H/%{http_version}i" %{status}i %b %{Referer}i %{Cookie}i %{User-Agent}i %D',
+        ACCESS_ERROR:
+            '%h - - [%{%d/%b/%Y:%H:%M:%S %Z}t] "%m %U %H/%{http_version}i" %{status}i %b %{Referer}i %{Cookie}i %{User-Agent}i %D',
+        WF:
+            this.opts['format_wf'] ||
             '%L: %t [%f:%N] errno[%E] logId[%l] uri[%U] user[%u] refer[%{referer}i] cookie[%{cookie}i] custom[%{encoded_str_array}x] %S %M',
-        'DEFAULT': this.opts['format'] ||
+        DEFAULT:
+            this.opts['format'] ||
             '%L: %t [%f:%N] errno[%E] logId[%l] uri[%U] user[%u] refer[%{referer}i] cookie[%{cookie}i] custom[%{encoded_str_array}x] %S %M',
-        'STD': '%L: %{%m-%d %H:%M:%S}t %{app}x * %{pid}x [logid=%l filename=%f lineno=%N errno=%{err_no}x %{encoded_str_array}x errmsg=%{u_err_msg}x]',
-        'STD_DETAIL': '%L: %{%m-%d %H:%M:%S}t %{app}x * %{pid}x [logid=%l filename=%f lineno=%N errno=%{err_no}x %{encoded_str_array}x errmsg=%{u_err_msg}x cookie=%{u_cookie}x]'
+        STD: '%L: %{%m-%d %H:%M:%S}t %{app}x * %{pid}x [logid=%l filename=%f lineno=%N errno=%{err_no}x %{encoded_str_array}x errmsg=%{u_err_msg}x]',
+        STD_DETAIL:
+            '%L: %{%m-%d %H:%M:%S}t %{app}x * %{pid}x [logid=%l filename=%f lineno=%N errno=%{err_no}x %{encoded_str_array}x errmsg=%{u_err_msg}x cookie=%{u_cookie}x]'
     };
-
 };
 
-
 Logger.prototype = {
@@ -128,4 +138,3 @@ fatal: function () {
                 option['msg'] = obj;
-            }
-            else if (typeof obj === 'object') {
+            } else if (typeof obj === 'object') {
                 option = obj;
@@ -142,6 +151,6 @@ }
 
-        if (intLevel === 0 || intLevel === 3) { //访问日志
+        if (intLevel === 0 || intLevel === 3) {
+            //访问日志
             this.writeLog(intLevel, option, format);
-        }
-        else {
+        } else {
             //IS_OMP等于0打印两种格式日志，等于1打印STD日志，等于2打印WF/Default日志
@@ -159,4 +168,2 @@ if (this.opts['IS_OMP'] === 0 || this.opts['IS_OMP'] === 2) {
             }
-
-
         }
@@ -184,7 +191,5 @@ },
             format = formats['ACCESS'];
-        }
-        else if (level === 'ACCESS_ERROR') {
+        } else if (level === 'ACCESS_ERROR') {
             format = formats['ACCESS_ERROR']; //访问错误 404 301等单独存储
-        }
-        else {
+        } else {
             //warning和fatal格式不一样,且单独存储
@@ -197,3 +202,2 @@ if (level === 'WARNING' || level === 'FATAL') {
         return format;
-
     },
@@ -217,4 +221,5 @@ /**
                 if (!option['msg']) {
-                    this.params['error_msg'] = this.opts['debug'] ? option['stack'] : String(option['stack']).replace(
-                        /(\n)+|(\r\n)+/g, ' ');
+                    this.params['error_msg'] = this.opts['debug']
+                        ? option['stack']
+                        : String(option['stack']).replace(/(\n)+|(\r\n)+/g, ' ');
                 }
@@ -228,4 +233,3 @@ var trace = stackTrace.parse(option['stack']);
                 this.params['isNative'] = trace[0].native;
-            }
-            catch (e) {
+            } catch (e) {
                 //this.log('notice','wrong error obj');
@@ -238,3 +242,3 @@ }
     parseCustomLog: function (obj) {
-        if ('object' !== typeof (obj)) {
+        if ('object' !== typeof obj) {
             return false;
@@ -258,4 +262,4 @@ }
         }
-        this.params['CLIENT_IP'] = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.headers[
-            'x-real-ip'];
+        this.params['CLIENT_IP'] =
+            req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.headers['x-real-ip'];
         this.params['REFERER'] = req.headers['referer'];
@@ -292,4 +296,3 @@ this.params['COOKIE'] = req.headers['cookie'];
             return urlObj.query || '';
-        }
-        catch (e) {
+        } catch (e) {
             console.log(e);
@@ -325,7 +328,5 @@ }
                 logId = parseInt(req.headers[logIDName], 10);
-            }
-            else if (parseInt(req.query['logid'], 10) > 0) {
+            } else if (parseInt(req.query['logid'], 10) > 0) {
                 logId = parseInt(req.query['logid'], 10);
-            }
-            else if (parseInt(this.getCookie('logid'), 10) > 0) {
+            } else if (parseInt(this.getCookie('logid'), 10) > 0) {
                 logId = parseInt(this.getCookie('logid'), 10);
@@ -337,3 +338,3 @@ }
             var obj = util.gettimeofday();
-            logId = ((obj['sec'] * 100000 + obj['usec'] / 10 + Math.floor(Math.random() * 100) & 0x7FFFFFFF));
+            logId = (obj['sec'] * 100000 + obj['usec'] / 10 + Math.floor(Math.random() * 100)) & 0x7fffffff;
         }
@@ -349,14 +350,15 @@ return logId;
         switch (intLevel) {
-        case '0': //访问日志前缀默认access
-            logFile = this.opts['access_log_file'] || 'access'; //访问日志
-            log_path = this.opts['access_log_path'] || this.opts['log_path'];
-            break;
-        case '3':
-            logFile = this.opts['access_error_log_file'] || 'error'; //访问日志
-            log_path = this.opts['access_error_log_path'] || this.opts['log_path'];
-            break;
-        default: //错误日志为app前缀
-            //是否使用子目录，app区分
-            log_path = this.opts['use_sub_dir'] ? (this.opts['log_path'] + '/' + prefix) : this.opts['log_path'];
-            logFile = prefix;
+            case '0': //访问日志前缀默认access
+                logFile = this.opts['access_log_file'] || 'access'; //访问日志
+                log_path = this.opts['access_log_path'] || this.opts['log_path'];
+                break;
+            case '3':
+                logFile = this.opts['access_error_log_file'] || 'error'; //访问日志
+                log_path = this.opts['access_error_log_path'] || this.opts['log_path'];
+                break;
+            default:
+                //错误日志为app前缀
+                //是否使用子目录，app区分
+                log_path = this.opts['use_sub_dir'] ? this.opts['log_path'] + '/' + prefix : this.opts['log_path'];
+                logFile = prefix;
         }
@@ -400,6 +402,22 @@
         if (this.params['error_msg'] && !this.opts['debug']) {
-            this.params['error_msg'] = options['escape_msg'] === true ?
-                escape(this.params['error_msg']) : unescape(this.params['error_msg']);
+            this.params['error_msg'] =
+                options['escape_msg'] === true ? escape(this.params['error_msg']) : unescape(this.params['error_msg']);
         }
 
+        if (this.opts['IS_JSON']) {
+            const caller = callsites()[3];
+            const callerFileName = caller.getFileName();
+            const callerFunctionName = caller.getFunctionName();
+            console.log(
+                JSON.stringify({
+                    level: this.params['current_level'],
+                    msg: options['msg'],
+                    file: callerFileName,
+                    function: callerFunctionName,
+                    uri: this.params['REQUEST_URI'] || ''
+                })
+            );
+            return;
+        }
+
         var format = log_format || this.format['DEFAULT'];
@@ -413,8 +431,8 @@ var str = this.getLogString(format);
         if (this.opts['stdout_only']) {
-           console.log(str); 
-        // debug 模式，console.log输出颜色标记的日志
-        } else if (this.opts['debug'] && COLORS[intLevel]){
-           var color = COLORS[intLevel];
-           var _str = unescape(str);
-           console.log(_str[color]); 
+            console.log(str);
+            // debug 模式，console.log输出颜色标记的日志
+        } else if (this.opts['debug'] && COLORS[intLevel]) {
+            var color = COLORS[intLevel];
+            var _str = unescape(str);
+            console.log(_str[color]);
         }
@@ -435,4 +453,3 @@
                         fdCache[oldFile].end();
-                    }
-                    catch (e) {}
+                    } catch (e) {}
                     delete fdCache[oldFile];
@@ -446,3 +463,3 @@ }
             fdCache[logFile] = fs.createWriteStream(logFile, {
-                'flags': 'a'
+                flags: 'a'
             });
@@ -455,3 +472,2 @@ }
 
-
     //获取字符串标识对应的日志等级，没有返回-1
@@ -474,4 +490,3 @@ getLogLevelInt: function (level) {
                 LOGGER_CACHE[format] = requireFromString(jsStr);
-            }
-            catch (e) {
+            } catch (e) {
                 console.error(e);
@@ -485,3 +500,2 @@ //mail("生成日志模板js失败");
 
-
     //生产环境是否应当使用
@@ -508,147 +522,146 @@ md5: function (data, len) {
             switch (code) {
-            case 'h':
-                action.push("logger.getParams('CLIENT_IP')");
-                break;
-            case 't':
-                var _act = "util.strftime(new Date(),'%y-%m-%d %H:%M:%S')";
-                if (param && param !== '') {
-                    _act = "util.strftime(new Date(), '" + String(param) + "')";
-                }
-                action.push(_act);
-                break;
-            case 'i':
-                var key = String(param).toUpperCase().replace(/-/g, '_');
-                action.push("logger.getParams('" + key + "')");
-                break;
-            // 不转换参数格式, 方便获取自定义 header 参数
-            case 'I':
-                action.push("logger.getParams('" + param + "')");
-                break;
-            case 'a':
-                action.push("logger.getParams('CLIENT_IP')");
-                break;
-            case 'A':
-                action.push("logger.getParams('SERVER_ADDR')");
-                break;
-            case 'b':
-                action.push("logger.getParams('CONTENT_LENGTH')");
-                break;
-            case 'C':
-                if (param === '') {
-                    action.push("logger.getParams('HTTP_COOKIE')");
-                }
-                else {
-                    action.push("logger.getCookie('" + param + "')");
-                }
-                break;
-            case 'D':
-                //暂不确定计算准确
-                action.push("logger.getParams('REQUEST_TIME')");
-                break;
-            case 'e':
-                //TODO
-                action.push("''");
-                break;
-            case 'f':
-                action.push("logger.getParams('FileName')");
-                break;
-            case 'H':
-                action.push("logger.getParams('SERVER_PROTOCOL')");
-                break;
-            case 'm':
-                action.push("logger.getParams('REQUEST_METHOD')");
-                break;
-            case 'p':
-                action.push("logger.getParams('SERVER_PORT')");
-                break;
-            case 'q':
-                action.push("logger.getParams('QUERY_STRING')");
-                break;
-            case 'T':
-                //TODO
-                action.push("''");
-                break;
-            case 'U':
-                action.push("logger.getParams('REQUEST_URI')");
-                break;
-            case 'v':
-                action.push("logger.getParams('HOSTNAME')");
-                break;
-            case 'V':
-                action.push("logger.getParams('HTTP_HOST')");
-                break;
-            case 'L':
-                action.push("logger.getParams('current_level')");
-                break;
-            case 'N':
-                action.push("logger.getParams('LineNumber')");
-                break;
-            case 'E':
-                action.push("logger.getParams('errno')");
-                break;
-            case 'l':
-                action.push("logger.getParams('LogId')");
-                break;
-            case 'u':
-                //TODO 用户ID 用户名
-                action.push("logger.getParams('user')");
-                break;
-            case 'S':
-                //TODO
-                action.push("''");
-                break;
-            case 'M':
-                action.push("logger.getParams('error_msg')");
-                break;
-            case 'x':
-                //TODO
-                if (param.indexOf("u_") == 0) {
-                    param = param.substr(2);
-                }
-                switch (param) {
-                case 'log_level':
+                case 'h':
+                    action.push("logger.getParams('CLIENT_IP')");
+                    break;
+                case 't':
+                    var _act = "util.strftime(new Date(),'%y-%m-%d %H:%M:%S')";
+                    if (param && param !== '') {
+                        _act = "util.strftime(new Date(), '" + String(param) + "')";
+                    }
+                    action.push(_act);
+                    break;
+                case 'i':
+                    var key = String(param).toUpperCase().replace(/-/g, '_');
+                    action.push("logger.getParams('" + key + "')");
+                    break;
+                // 不转换参数格式, 方便获取自定义 header 参数
+                case 'I':
+                    action.push("logger.getParams('" + param + "')");
+                    break;
+                case 'a':
+                    action.push("logger.getParams('CLIENT_IP')");
+                    break;
+                case 'A':
+                    action.push("logger.getParams('SERVER_ADDR')");
+                    break;
+                case 'b':
+                    action.push("logger.getParams('CONTENT_LENGTH')");
+                    break;
+                case 'C':
+                    if (param === '') {
+                        action.push("logger.getParams('HTTP_COOKIE')");
+                    } else {
+                        action.push("logger.getCookie('" + param + "')");
+                    }
+                    break;
+                case 'D':
+                    //暂不确定计算准确
+                    action.push("logger.getParams('REQUEST_TIME')");
+                    break;
+                case 'e':
+                    //TODO
+                    action.push("''");
+                    break;
+                case 'f':
+                    action.push("logger.getParams('FileName')");
+                    break;
+                case 'H':
+                    action.push("logger.getParams('SERVER_PROTOCOL')");
+                    break;
+                case 'm':
+                    action.push("logger.getParams('REQUEST_METHOD')");
+                    break;
+                case 'p':
+                    action.push("logger.getParams('SERVER_PORT')");
+                    break;
+                case 'q':
+                    action.push("logger.getParams('QUERY_STRING')");
+                    break;
+                case 'T':
+                    //TODO
+                    action.push("''");
+                    break;
+                case 'U':
+                    action.push("logger.getParams('REQUEST_URI')");
+                    break;
+                case 'v':
+                    action.push("logger.getParams('HOSTNAME')");
+                    break;
+                case 'V':
+                    action.push("logger.getParams('HTTP_HOST')");
+                    break;
+                case 'L':
                     action.push("logger.getParams('current_level')");
                     break;
-                case 'line':
+                case 'N':
                     action.push("logger.getParams('LineNumber')");
                     break;
-                case 'function':
-                    action.push("logger.getParams('FunctionName')");
-                    break;
-                case 'err_no':
+                case 'E':
                     action.push("logger.getParams('errno')");
                     break;
-                case 'err_msg':
-                    action.push("logger.getParams('error_msg')");
-                    break;
-                case 'log_id':
+                case 'l':
                     action.push("logger.getParams('LogId')");
                     break;
-                case 'app':
-                    action.push("logger.getLogPrefix()");
+                case 'u':
+                    //TODO 用户ID 用户名
+                    action.push("logger.getParams('user')");
                     break;
-                    /*case 'function_param':
+                case 'S':
+                    //TODO
+                    action.push("''");
+                    break;
+                case 'M':
+                    action.push("logger.getParams('error_msg')");
+                    break;
+                case 'x':
+                    //TODO
+                    if (param.indexOf('u_') == 0) {
+                        param = param.substr(2);
+                    }
+                    switch (param) {
+                        case 'log_level':
+                            action.push("logger.getParams('current_level')");
+                            break;
+                        case 'line':
+                            action.push("logger.getParams('LineNumber')");
+                            break;
+                        case 'function':
+                            action.push("logger.getParams('FunctionName')");
+                            break;
+                        case 'err_no':
+                            action.push("logger.getParams('errno')");
+                            break;
+                        case 'err_msg':
+                            action.push("logger.getParams('error_msg')");
+                            break;
+                        case 'log_id':
+                            action.push("logger.getParams('LogId')");
+                            break;
+                        case 'app':
+                            action.push('logger.getLogPrefix()');
+                            break;
+                        /*case 'function_param':
                             $action[] = 'Bd_Log::flattenArgs(Bd_Log::$current_instance->current_function_param)';
                             break;*/
-                    /*case 'argv':
+                        /*case 'argv':
                             $action[] = '(isset($GLOBALS["argv"])? Bd_Log::flattenArgs($GLOBALS["argv"]) : \'\')';
                             break;*/
-                case 'pid':
-                    action.push("logger.getParams('pid')");
+                        case 'pid':
+                            action.push("logger.getParams('pid')");
+                            break;
+                        case 'encoded_str_array':
+                            action.push("logger.getParams('encoded_str_array')");
+                            break;
+                        case 'cookie':
+                            action.push("logger.getParams('cookie')");
+                            break;
+                        default:
+                            action.push("''");
+                    }
                     break;
-                case 'encoded_str_array':
-                    action.push("logger.getParams('encoded_str_array')");
+                case '%':
+                    action.push("'%'");
                     break;
-                case 'cookie':
-                    action.push("logger.getParams('cookie')");
-                    break;
                 default:
                     action.push("''");
-                }
-                break;
-            case '%':
-                action.push("'%'");
-                break;
-            default:
-                action.push("''");
             }
@@ -667,7 +680,6 @@ }
         return str;
-
     },
 
     getParams: function (name) {
-        if (this.params.hasOwnProperty(name) && this.params[name] !== undefined && this.params[name] !== "") {
+        if (this.params.hasOwnProperty(name) && this.params[name] !== undefined && this.params[name] !== '') {
             return this.params[name];
@@ -703,5 +715,3 @@ }
 
-
 module.exports = function (config) {
-
     config = config || {};
@@ -732,3 +742,2 @@
 
-
         //只在请求过来的时候才设置LogId
@@ -735,0 +744,0 @@ logger.params['LogId'] = logger.getLogID(req, config.LogIdName || 'x_bd_logid');

package.json

 {
   "name": "yog-log",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "yog logger",
@@ -14,6 +14,7 @@ "main": "index.js",
   "dependencies": {
+    "callsites": "^3.1.0",
+    "colors": "0.6.2",
+    "fast-strftime": "1.1.1",
     "mkdirp": "0.5.0",
-    "stack-trace": "0.0.9",
-    "fast-strftime": "1.1.1",
-    "colors": "0.6.2"
+    "stack-trace": "0.0.9"
   },
@@ -20,0 +21,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

75062

increased by2.23%

Number of package files

13

increased by8.33%

Lines of code

1339

increased by1.36%

Worsened metrics

Dependency count

5

increased by25%

Dependency changes

• + Addedcallsites@^3.1.0

• + Addedcallsites@3.1.0(transitive)