roarr - npm Package Compare versions

Comparing version 1.7.2 to 2.0.0

dist/bin/commands/pretty-print.js

@@ -29,2 +29,13 @@ 'use strict';
 
+/* eslint-disable quote-props */
+var logLevels = {
+  '10': 'TRACE',
+  '20': 'DEBUG',
+  '30': 'INFO',
+  '40': 'WARN',
+  '50': 'ERROR',
+  '60': 'FATAL'
+};
+/* eslint-enable */
+
 var logLevelColorMap = {
@@ -39,2 +50,6 @@ DEBUG: 'gray',
 
+var getLogLevelName = function getLogLevelName(logLevel /*: number*/) /*: string*/ {
+  return logLevels[logLevel] || 'INFO';
+};
+
 /*:: type LogFormatterConfigurationType = {|
@@ -58,8 +73,8 @@ +includeContext: boolean,
 
-    if (message.context.logLevel) {
-      var logLevel = message.context.logLevel.toUpperCase();
+    if (message.context.logLevel && typeof message.context.logLevel === 'number') {
+      var logLevelName = getLogLevelName(message.context.logLevel);
 
-      var logLevelColorName = logLevelColorMap[logLevel] || 'inverse';
+      var logLevelColorName = logLevelColorMap[logLevelName];
 
-      formattedMessage += ' ' + _chalk2.default[logLevelColorName](logLevel);
+      formattedMessage += ' ' + _chalk2.default[logLevelColorName](logLevelName + ' (' + message.context.logLevel + ')');
     }
@@ -66,0 +81,0 @@

dist/factories/createLogger.js

@@ -31,3 +31,10 @@ 'use strict';
 
-var logLevels = ['trace', 'debug', 'info', 'warn', 'error', 'fatal'];
+var logLevels = {
+  debug: 20,
+  error: 50,
+  fatal: 60,
+  info: 30,
+  trace: 10,
+  warn: 40
+};
 
@@ -71,7 +78,9 @@ var createLogger = function createLogger(onMessage /*: OnMessageEventHandlerType*/) {
 
-  var _loop = function _loop(logLevel) {
+  var logLevelNames = Object.keys(logLevels);
+
+  var _loop = function _loop(logLevelName) {
     // eslint-disable-next-line id-length
-    log[logLevel] = function (a, b, c, d, e, f, g, h, i, k) {
+    log[logLevelName] = function (a, b, c, d, e, f, g, h, i, k) {
       return log.child({
-        logLevel: logLevel
+        logLevel: logLevels[logLevelName]
       })(a, b, c, d, e, f, g, h, i, k);
@@ -86,6 +95,6 @@ };
   try {
-    for (var _iterator = logLevels[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-      var logLevel = _step.value;
+    for (var _iterator = logLevelNames[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+      var logLevelName = _step.value;
 
-      _loop(logLevel);
+      _loop(logLevelName);
     }
@@ -92,0 +101,0 @@ } catch (err) {

package.json

@@ -77,3 +77,3 @@ {
   },
-  "version": "1.7.2"
+  "version": "2.0.0"
 }

README.md

@@ -78,3 +78,3 @@ # Roarr
 const debug = log.child({
-  level: 'debug'
+  logLevel: 10
 });
@@ -95,4 +95,4 @@
 {"context":{},"message":"bar baz","sequence":1,"time":1506776210000,"version":"1.0.0"}
-{"context":{"level":"debug"},"message":"qux","sequence":2,"time":1506776210000,"version":"1.0.0"}
-{"context":{"level":"debug","quuz":"corge"},"sequence":3,"message":"quux","time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":10},"message":"qux","sequence":2,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":10,"quuz":"corge"},"sequence":3,"message":"quux","time":1506776210000,"version":"1.0.0"}
 
@@ -183,3 +183,3 @@ ```
 ```
-ROARR_LOG=true node ./index.js | jq 'select(.context.logLevel == "warning" or .context.logLevel == "error")'
+ROARR_LOG=true node ./index.js | jq 'select(.context.logLevel > 40)'
 
@@ -292,8 +292,8 @@ ```
 ```
-{"context":{"logLevel":"trace"},"message":"foo","sequence":0,"time":1506776210000,"version":"1.0.0"}
-{"context":{"logLevel":"debug"},"message":"foo","sequence":1,"time":1506776210000,"version":"1.0.0"}
-{"context":{"logLevel":"info"},"message":"foo","sequence":2,"time":1506776210000,"version":"1.0.0"}
-{"context":{"logLevel":"warn"},"message":"foo","sequence":3,"time":1506776210000,"version":"1.0.0"}
-{"context":{"logLevel":"error"},"message":"foo","sequence":4,"time":1506776210000,"version":"1.0.0"}
-{"context":{"logLevel":"fatal"},"message":"foo","sequence":5,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":10},"message":"foo","sequence":0,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":20},"message":"foo","sequence":1,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":30},"message":"foo","sequence":2,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":40},"message":"foo","sequence":3,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":50},"message":"foo","sequence":4,"time":1506776210000,"version":"1.0.0"}
+{"context":{"logLevel":60},"message":"foo","sequence":5,"time":1506776210000,"version":"1.0.0"}
 
@@ -317,8 +317,8 @@ ```
 ```
-{"context":{"package":"forward-proxy","namespace":"createHttpProxyServer","logLevel":"info"},"message":"Internal SSL Server running on localhost:62597","sequence":0,"time":1506803138704,"version":"1.0.0"}
-{"context":{"package":"forward-proxy","namespace":"createRequestProcessor","logLevel":"info"},"message":"request start -> http://localhost:62595/","sequence":1,"time":1506803138741,"version":"1.0.0"}
-{"context":{"package":"forward-proxy","namespace":"createLogInterceptor","logLevel":"debug","headers":{"host":"localhost:62595","connection":"close"}},"message":"received request","sequence":2,"time":1506803138741,"version":"1.0.0"}
-{"context":{"package":"forward-proxy","namespace":"createRequestProcessor","logLevel":"info"},"message":"request finished <- http://localhost:62595/","sequence":3,"time":1506803138749,"version":"1.0.0"}
-{"context":{"package":"forward-proxy","namespace":"createLogInterceptor","logLevel":"info","method":"GET","requestHeaders":{"host":"localhost:62595","connection":"close"},"responseHeaders":{"date":"Sat, 30 Sep 2017 20:25:38 GMT","connection":"close","content-length":"7","x-forward-proxy-request-id":"2b746d92-1a8b-4f36-b3cc-5bff57dad94d","x-forward-proxy-cache-hit":"false"},"statusCode":200,"url":"http://localhost:62595/"},"message":"response","sequence":4,"time":1506803138755,"version":"1.0.0"}
-{"context":{"package":"forward-proxy","namespace":"createLogInterceptor","logLevel":"info","method":"GET","requestHeaders":{"host":"localhost:62595","connection":"close"},"responseHeaders":{"date":"Sat, 30 Sep 2017 20:25:38 GMT","content-length":"7","x-forward-proxy-request-id":"2b746d92-1a8b-4f36-b3cc-5bff57dad94d","x-forward-proxy-cache-hit":"true"},"statusCode":200,"url":"http://localhost:62595/"},"message":"response","sequence":5,"time":1506803138762,"version":"1.0.0"}
+{"context":{"package":"forward-proxy","namespace":"createHttpProxyServer","logLevel":30},"message":"Internal SSL Server running on localhost:62597","sequence":0,"time":1506803138704,"version":"1.0.0"}
+{"context":{"package":"forward-proxy","namespace":"createRequestProcessor","logLevel":30},"message":"request start -> http://localhost:62595/","sequence":1,"time":1506803138741,"version":"1.0.0"}
+{"context":{"package":"forward-proxy","namespace":"createLogInterceptor","logLevel":20,"headers":{"host":"localhost:62595","connection":"close"}},"message":"received request","sequence":2,"time":1506803138741,"version":"1.0.0"}
+{"context":{"package":"forward-proxy","namespace":"createRequestProcessor","logLevel":30},"message":"request finished <- http://localhost:62595/","sequence":3,"time":1506803138749,"version":"1.0.0"}
+{"context":{"package":"forward-proxy","namespace":"createLogInterceptor","logLevel":30,"method":"GET","requestHeaders":{"host":"localhost:62595","connection":"close"},"responseHeaders":{"date":"Sat, 30 Sep 2017 20:25:38 GMT","connection":"close","content-length":"7","x-forward-proxy-request-id":"2b746d92-1a8b-4f36-b3cc-5bff57dad94d","x-forward-proxy-cache-hit":"false"},"statusCode":200,"url":"http://localhost:62595/"},"message":"response","sequence":4,"time":1506803138755,"version":"1.0.0"}
+{"context":{"package":"forward-proxy","namespace":"createLogInterceptor","logLevel":30,"method":"GET","requestHeaders":{"host":"localhost:62595","connection":"close"},"responseHeaders":{"date":"Sat, 30 Sep 2017 20:25:38 GMT","content-length":"7","x-forward-proxy-request-id":"2b746d92-1a8b-4f36-b3cc-5bff57dad94d","x-forward-proxy-cache-hit":"true"},"statusCode":200,"url":"http://localhost:62595/"},"message":"response","sequence":5,"time":1506803138762,"version":"1.0.0"}
 
@@ -374,3 +374,3 @@ ```
 |`instanceId`|Unique instance ID. Used to distinguish log source in high-concurrency environments. See `roarr augment --append-instance-id` option.|
-|`logLevel`|Human-readable name of the log-level, e.g. "error". See [API](#api) for build-in loggers with a pre-set log-level.|
+|`logLevel`|A numeric value indicating the [log level](#log-levels). See [API](#api) for the build-in loggers with a pre-set log-level.|
 |`namespace`|Namespace within a package, e.g. function name. Treat the same way that you would construct namespaces when using the [`debug`](https://github.com/visionmedia/debug) package.|
@@ -381,2 +381,15 @@ |`package`|Name of the package.|
 
+#### Log levels
+
+The `roarr pretty-print` [CLI program](#cli-program) translates `logLevel` values to the following human-readable names:
+
+|`logLevel`|Human-readable name|
+|---|---|
+|10|TRACE|
+|20|DEBUG|
+|30|INFO|
+|40|WARN|
+|50|ERROR|
+|60|FATAL|
+
 ### Using Roarr in an application
@@ -483,3 +496,3 @@
             "logLevel": {
-              "type": "keyword"
+              "type": "integer"
             },
@@ -486,0 +499,0 @@ "namespace": {

No alert changes

Improved metrics

Total package byte prevSize

61333

increased by3.61%

Lines of code

382

increased by5.82%

Number of lines in readme file

513

increased by2.6%

No dependency changes