chore: updates docs and example to use transports

examples/custom-pipeline/index.js

@@ -0,0 +1,43 @@
+/**
+ * After running this example code with node,
+ * you can see the results in browser at:
+ * http://localhost:8080/items
+ */
+
+ const Catalyst = require('../..');
+ const Path = require('path');
+ const getResponse = [
+   {string: 'string1', number: 1, boolean: true},
+   {string: 'string2', number: 2, boolean: false},
+ ];
+
+ const hapiPino = require('hapi-pino');
+ const pino = require('pino');
+
+ async function start (options = {}) {
+   const server = await Catalyst.init({
+     ...options,
+     userConfigPath: Path.resolve(__dirname, 'manifest.json'),
+   });
+
+   server.route({
+     path: '/items',
+     method: 'GET',
+     options: {
+       log: { collect: true },
+       cache: { expiresIn: 5000 },
+     },
+     handler: async function (req, h) {
+       // you can also use a pino instance, which will be faster
+       req.logger.info('GET_items', getResponse);
+       return await h.response(getResponse);
+     },
+   });
+
+   await server.start()
+   server.log(['info'], `items endpoint : ${server.info.uri}/items`)
+   return server
+ }
+
+ start()
+

examples/custom-pipeline/manifest.json

@@ -0,0 +1,15 @@
+{
+    "server": {
+        "debug": false // disable Hapi debug console logging
+    },
+    "register": {
+        "hapi-pino": {
+            "plugin": "require:hapi-pino",
+            "options":{
+                "logRequestComplete": false,
+                "ignoredEventTags": { "log": ["client"], "request": "*" },
+                "logPayload": false
+              }
+        }
+    }
+}

examples/custom-pipeline/my-transport-process.js

@@ -0,0 +1,37 @@
+'use strict';
+const split = require('split2')
+const pump = require('pump')
+const through = require('through2')
+const args = require('args')
+const sonic = require('sonic-boom')
+
+/**
+ * Set up more options passing at the node cli
+ * node . | node my-transport-process.js --d="logs/log.log"
+*/
+args
+  .option(['d','destination'], 'The port on which the app will be running')
+
+const flagOptions = args.parse(process.argv);
+
+let destination = flagOptions.destination;
+
+if (!destination) throw new Error('destination is required');
+
+const myTransport = through.obj(async function (chunk, enc, cb) {
+  if(destination === 1 ){
+    console.log(chunk)
+  } else{
+    let WriteTodestination =  sonic({
+      dest: destination || 1,
+      append: true,
+      mkdir: true,
+      sync: true // by default sonic will be async
+    })
+
+    WriteTodestination.write(JSON.stringify(chunk) + '\n')
+  }
+  cb()
+})
+
+return pump(process.stdin, split(JSON.parse), myTransport)

examples/custom-pipeline/readme.md

@@ -0,0 +1,57 @@
+# Catalyst server log configuration
+
+## Pipe logs to the transport over custom pipeline input for production
+
+Example below will take logs from the `process.stdin` and pipe to either `stdout`
+
+my-transport-process.js
+```
+'use strict';
+const split = require('split2')
+const pump = require('pump')
+const through = require('through2')
+const args = require('args')
+const sonic = require('sonic-boom')
+
+/**
+ * Set up more options passing at the node cli
+ * node . | node my-transport-process.js --d="logs/log.log"
+*/
+args
+  .option(['d','destination'], 'The final destination for the logs')
+
+const flagOptions = args.parse(process.argv);
+
+let destination = flagOptions.destination;
+
+if (!destination) throw new Error('destination is required');
+
+const myTransport = through.obj(async function (chunk, enc, cb) {
+  if(destination === 1 ){
+    console.log(chunk)
+  } else{
+    let WriteTodestination =  sonic({
+      dest: destination || 1,
+      append: true,
+      mkdir: true,
+      sync: true // by default sonic will be async
+    })
+
+    WriteTodestination.write(JSON.stringify(chunk) + '\n')
+  }
+  cb()
+})
+
+return pump(process.stdin, split(JSON.parse), myTransport)
+```
+
+Logs can now be consumed using shell piping:
+
+```
+node --max-http-header-size=32768 ./examples/custom-pipeline/index.js | node ./examples/custom-pipeline/my-transport-process.js -d=1
+```
+Or logs can be transport to a file:
+
+```
+node --max-http-header-size=32768 ./examples/custom-pipeline/index.js | node ./examples/custom-pipeline/my-transport-process.js -d="logs/log.log"
+```

examples/simple/.pino-prettyrc

@@ -0,0 +1,5 @@
+{
+    "colorize": true,
+    "singleLine": true
+    // ... pass pino-pretty options here
+}

examples/simple/manifest.json

@@ -1,30 +1,15 @@
 {
     "server": {
+        "debug": false // disable Hapi debug console logging
     },
     "register": {
         "hapi-pino": {
             "plugin": "require:hapi-pino",
-            "options": {
-                "mergeHapiLogData": false,
-                // "level": "debug",
-                "ignorePaths": [
-                    "/health",
-                    "/alive.txt",
-                    "/private"
-                ],
-                "tags": { "GET_items": "info", "GET_error": "error" },
-                // transport option is not recomended for prod env
-                "transport": {
-                    "target": "pino-pretty",
-                    "options": {
-                        "singleLine": true,
-                        "colorize": true,
-                        "mkdir": true,
-                        "append": false,
-                        "destination": "logs/output.log"
-                    }
-                }
-            }
+            "options":{
+                "logRequestComplete": false,
+                "ignoredEventTags": { "log": ["client"], "request": "*" },
+                "logPayload": false
+              }
         }
     }
 }

examples/simple/readme.md

@@ -0,0 +1,65 @@
+# Catalyst server log configuration
+
+The follow diagram explains how our catalyst server manages logs
+
+![threads-diagram drawio](https://user-images.githubusercontent.com/88118994/149195822-de5d33ad-f29f-48ff-840b-ce2fb41eb08a.png)
+
+## [Pino-pretty](https://github.com/pinojs/pino-pretty) logs for development mode:
+
+install pino-pretty as a development dependency.
+
+` npm install --save-dev pino-pretty `
+
+manifest.json
+```
+    "hapi-pino": {
+        "plugin": "require:hapi-pino",
+        "options": {
+            "$filter": "env.NODE_ENV",
+            "$default": {},
+            "development": {
+                "transport": {
+                    "target": "pino-pretty",
+                    "options": {
+                        "colorize": true,
+                        "translateTime": true
+                    }
+                }
+            }      
+        }
+    }
+```
+
+## [Pino-pretty](https://github.com/pinojs/pino/blob/master/docs/pretty.md) logs for production mode(legacy transport):
+
+Install Pino-pretty
+
+`npm install pino-pretty`
+
+It is recommended to use pino-pretty with pino by piping output to the CLI tool:
+
+```
+node --max-http-header-size=32768 ./examples/simple/index.js | ./node_modules/.bin/pino-pretty --config=./examples/simple/.pino-prettyrc
+```
+
+.pino-prettyrc
+```
+{
+    "colorize": true,
+    "singleLine": true
+    // ... pass pino-pretty options here
+}
+```
+
+.pino-pretty pass the [CLI Arguments](https://github.com/pinojs/pino-pretty#cli-arguments)
+
+
+
+_node js profile review_
+
+```
+clinic doctor --autocannon [ /items ] -- node --max-http-header-size=32768 ./examples/simple/index.js | ./node_modules/.bin/pino-pretty --config=./examples/simple/.pino-prettyrc
+
+```
+
+

package.json

@@ -65,10 +65,11 @@
     "@hapi/crumb": "^8.0.0",
     "@hapi/hoek": "^9.0.4",
     "@vrbo/steerage": "^12.1.3",
-    "hapi-pino": "^9.0.0",
+    "hapi-pino": "^9.1.0",
     "joi": "^17.2.0",
     "pino-pretty": "^7.2.0",
-    "shortstop-handlers": "^1.0.1"
+    "shortstop-handlers": "^1.0.1",
+    "through2": "^4.0.2"
   },
   "devDependencies": {
     "@hapi/hapi": "^20.2.1",