micronodelib 1.0.6 → 1.0.8

package/README.md

@@ -20,22 +20,38 @@ yarn add micronodelib
 
 ## Usage
 
-```shell
+```javascript
 import express, {Application} from "express";
 import {Logger, httpContextMiddleware, requestLogMiddleware} from "micronodelib";
 const app: Application = express();
 
-# Enable request context
+// Optional, if you want to override default console log
+console.log = Logger.info
+console.error = Logger.error
+
+// Enable request context
 app.use(httpContextMiddleware());
 
-# Enable http request log
+// Enable http request log
 app.use(requestLogMiddleware({
-  # Ignore request log for specific routes
+  // Ignore request log for specific routes
   ignoreRoutes: ["/actuator/health"]
 }));
 
 app.listen(3000, () => {
-  # Using standard log level: debug, info, warn, error
+  // Using standard log level: debug, info, warn, error
   Logger.info('App started');
 })
-```
+```
+
+## Sample output format
+
+**Standard log format**
+```json
+ {"level":"INFO","msg":"Test log message","request_meta":{"request_id":"a06dd50a-7127-4f87-bfe0-b7104fb453c9"},"ts":1652842663}
+```
+
+**Http request log format**
+```json
+{"level":"INFO","msg":"finish router","request_meta":{"client_ip":null,"execution_time":4,"query":"","request_id":"a06dd50a-7127-4f87-bfe0-b7104fb453c9","request_method":"GET","request_path":"/example-path","request_pattern":"/example-path","status":200,"url":"/example-path","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.64 Safari/537.36"},"ts":1652842718}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "micronodelib",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Common core for NodeJs project",
   "author": "Thang Bui",
   "license": "MIT",