samanbayaka 0.0.12 → 0.0.13

package/README.md

@@ -39,10 +39,23 @@ nvm use 22
 ```
 
 #### Environment variables
-To configure all required environment variables, copy the <your_project_name>/bash/sbk.sh file into the /etc/profile.d/ directory and update the environment variable values as needed. Before copying, ensure that your current working directory is the project directory.
+To configure all required environment variables, create a Bash file:
+```bash
+sudo nano /etc/logrotate.d/sbk.sh
+```
+Paste this:
+```bash
+##Configurations files path
+export SBK_CONFIG_PATH=/usr/local/etc/<your_folder>
+
+##web server port 8760-8769
+export SBK_PORT=8765
+
+##Log level allowed values are fatal | error | warn | info | debug | trace
+export SBK_LOG_LEVEL=debug
+```
+Set environment variables in the current Bash session.
 ```bash
-pwd
-sudo cp bash/sbk.sh /etc/profile.d/
 source /etc/profile.d/sbk.sh
 ```
 Optionally, you may verify the set environment variables.
@@ -53,14 +66,41 @@ echo $SBK_PORT
 Create a directory to store the configuration files, then copy all configuration files from the current project path into this directory and update them as needed. Before copying, ensure that your current working directory is the project directory.
 ```bash
 pwd
-sudo mkdir -p /usr/local/etc/<your_project_name>
-sudo cp config/*.*  /usr/local/etc/<your_project_name>
+sudo mkdir -p /usr/local/etc/<your_folder>
+sudo cp config/*.*  /usr/local/etc/<your_folder>
+```
+#### Log files
+For production, it is recommended to create a new directory named "samanbayaka" under /var/log to store logs.
+```bash
+sudo mkdir -p /var/log/samanbayaka
+sudo chown -R $USER:$(id -gn) /var/log/samanbayaka
+sudo chmod 755 /var/log/samanbayaka
+```
+Empty your log files if they become very large, as follows:
+```bash
+truncate -s 0 /var/log/samanbayaka/sbk-*.log
+```
+#### Setup logrotate (optional)
+Create config file:
+```bash
+sudo nano /etc/logrotate.d/sbk
+```
+Paste this:
+```bash
+/var/log/samanbayaka/sbk-*.log {
+  daily
+  rotate 14
+  compress
+  delaycompress
+  missingok
+  notifempty
+  copytruncate
+  create 0640 node node
+}
 ```
-
-
 # Usage
-#### Create a service, gateway
-The gateway is an important service that exposes all endpoints as REST APIs. At least one Gateway service is mandatory in the project.
+#### Create gateway service
+The Gateway is a critical service that exposes all endpoints as REST APIs. At least one Gateway service must be running to make the REST APIs accessible.
 ```bash
 mkdir gateway
 cd gateway
@@ -69,18 +109,21 @@ pnpm install samanbayaka
 touch index.mjs
 ```
 
-Open and edit the index.mjs file as follows
+Open index.mjs and paste the following:
 ```bash
 import sbk from "samanbayaka"
 await sbk.loadGatewayService()
 ```
-Run the service, gateway
+#### Create feature service
 ```bash
-node index.mjs
+mkdir <your_service_name>
+cd <your_service_name>
+npm init -y
+pnpm install samanbayaka
+touch index.mjs
 ```
 
-
-#### Create your endpoints as a feature service, such as hello
+A feature service, such as "hello", can be created as follows:
 ```bash
 mkdir hello
 cd hello
@@ -89,7 +132,7 @@ pnpm install samanbayaka
 touch index.mjs
 ```
 
-Open and edit the index.mjs file as follows
+Open index.mjs and paste the following:
 ```bash
 import sbk from "samanbayaka"
 await sbk.loadFeatureService.mainBus({
@@ -109,9 +152,9 @@ await sbk.loadFeatureService.mainBus({
       cache: {
 
         /**
-         * These cache entries will be expired after 5 seconds instead of 30.
+         * These cache entries will be expired after 30 seconds.
          */      
-        ttl: 2*60
+        ttl: 30
       },
       handler(ctx){
         return "Hello Samanbayaka"
@@ -123,17 +166,30 @@ await sbk.loadFeatureService.mainBus({
         return `Welcome, ${ctx.params.query?.name || "Guest"} - ${ctx.broker.nodeID}`
       }
     },
-    createUser
   },
 })
 
 ```
-Run the service, hello
+
+#### Run the services 
+
+ * development/testing
 ```bash
+cd <your_path>/gateway
+node index.mjs
+cd <your_path>/hello
 node index.mjs
 ```
+ * production
+```bash
+cd <your_path>/gateway
+node index.mjs >> /var/log/samanbayaka/sbk-${HOSTNAME}-$$.log 2>&1
+cd <your_path>/hello
+node index.mjs >> /var/log/samanbayaka/sbk-${HOSTNAME}-$$.log 2>&1
+```
+
 # Demo
-You can also run the demo service to better understand how the system works.
+You can also run the demo service to better understand how microservices work in the Moleculer ecosystem and how REST APIs are exposed.
 ```bash
 mkdir demo
 cd demo

package/commit-hash.mjs

@@ -1 +1 @@
-export const COMMIT_HASH = '3290420';
+export const COMMIT_HASH = '289c98a';

package/helper/logger/pino.mjs

@@ -1,38 +1,82 @@
 import pino from "pino"
 
-// const logger = pino({
-//   level: (process.env.SBK_LOG_LEVEL || "info").toLowerCase(),
-//   // base: {
-//   //   service: "gateway",
-//   //   env: process.env.NODE_ENV || "prod"
-//   // }
-// });
+import { serviceDtls } from '#hFil/esm-loading.mjs'
 
 
+const pinoOptions = {
+  level: (process.env.SBK_LOG_LEVEL || "info").toLowerCase(),
 
+  /**
+   * ISO timestamps (better for Loki/Grafana)
+   */
+  timestamp: pino.stdTimeFunctions.isoTime,
 
-const logger = pino(
-  {
-    level: (process.env.SBK_LOG_LEVEL || "info").toLowerCase(),
+  /**
+   * base fields = Loki labels candidates
+   */
+  base: null,
+
+  /**
+   * Rename default fields (optional but cleaner for Loki)
+   * @type {Object}
+   */
+  // formatters: {
+  //   level(label) {
+  //     return { level: label } // instead of numeric
+  //   }
+  // },
+
+  serializers: {
+    err: pino.stdSerializers.err
   },
-  pino.transport({
-    target: "pino-loki",
-    options: {
-      host: "http://10.250.35.15:3100",   // Docker service name
-      labels: {
-        app: "moleculer",
-        env: "dev"
-      },
-      batching: true,
-      interval: 5
+
+  // messageKey: "message",
+  nestedKey: 'data',
+  // msgPrefix: " ❖❖ SBK ❖❖ ",
+  hooks: {
+    logMethod(args, method, level) {
+      let mergedObj = {}
+      let messages = []
+
+      for (const arg of args) {
+        if (typeof arg === 'string') {
+          messages.push(arg)
+        } else if (arg && typeof arg === 'object') {
+          mergedObj = { ...mergedObj, ...arg }
+        }
+      }
+
+      /**
+       * Concatinate all string seperte with white space
+       */
+      // if( messages.length > 0 ) messages.unshift(" ❖❖ SBK ❖❖ ")
+      const finalMsg = messages.join(' ')     
+
+
+      /**
+       * Rebuild args into standard Pino format
+       */
+      if (finalMsg && Object.keys(mergedObj).length > 0) {
+        args = [{...mergedObj, ...{tag: "SBK", message: finalMsg}}]
+      } else if (finalMsg) {
+        args = [{tag: "MOL", message: finalMsg}]
+      } else {
+        args = [{...mergedObj, ...{tag: "SBK"}}]
+      }
+
+      method.apply(this, args)
     }
-  })
-);
+  },
+}
 
 
 export default Object.freeze({
   type: "Pino",
-  options: logger
+  options: {
+    pino: {
+      options: pinoOptions
+    }
+  }
 })
 
 

package/helper/utility/error-handler.mjs

@@ -158,18 +158,18 @@ export const validateServiceName = (name, pkgName) => {
  */
 export const shutdownHdl = async (broker, signal, err=null) => {
   if(err){
-    broker.logger.error('SBKERR ❖', `${signal}: `, err)
+    broker.logger.error({err}, `${signal}: `)
   }
 
-  broker.logger.info('SBKMSG ❖', `Received ${signal}. Stopping broker...`)
+  broker.logger.info({message: `Received ${signal}, Stopping broker...`})
   
   try {
     await broker.stop()
-    broker.logger.info('SBKMSG ❖', "Broker stopped gracefully.")
+    broker.logger.info({message: "Broker stopped gracefully."})
       
     process.exit(0)
   } catch (err) {
-    broker.logger.error('SBKERR ❖', "Error during broker shutdown:", err)
+    broker.logger.error({err}, "Error during broker shutdown:")
     process.exit(1)
   }
 }
@@ -208,10 +208,10 @@ export const SbkErrorMiddleware = {
           const timestamp = new Date().toISOString()
 
           if(err.code){
-            ctx.broker.logger.error('❖ SBK', {traceId, type, instance, detail, stack: ""})
+            ctx.broker.logger.error({traceId, type, instance, detail, stack: ""})
           }
           else{
-            ctx.broker.logger.error('❖ SBK', {traceId, type, instance, detail, stack})
+            ctx.broker.logger.error({traceId, type, instance, detail, stack})
           }
 
 
@@ -269,7 +269,7 @@ const sbkValidateObj = async() => {
     })
   }
   catch(err){
-    console.error("\x1b[31m%s\x1b[0m", `SBKERR ❖ ${err.message}`)
+    console.error("\x1b[31m%s\x1b[0m", ` ❖❖ SBKERR ❖❖ ${err.message}`)
     process.exit(1)
   }
 }

package/index.mjs

@@ -39,20 +39,17 @@ const isReplEnabled = (
  * @type {ServiceBroker}
  */
 const broker = new ServiceBroker({
+  ...BROKER_CONFIG,
   ...{
-    ...BROKER_CONFIG,
-    namespace: initSbk.namespaceTxt
-  },
-  ...{
+    namespace: initSbk.namespaceTxt,
     nodeID: serviceDtls.id,
     transporter: NATS_CONFIG,
     validator: new AjvValidator(),
-    logger: 'Console', //pinoLogger,
+    logger: pinoLogger,
   },
   middlewares: [SbkErrorMiddleware],
 })
 
-
 /**
  * Listen for force stop signals
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "samanbayaka",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Moleculer Gateway service with kafka transporter",
   "homepage": "https://gitlab.com/dalal.suvendu/samanbayaka#readme",
   "bugs": {

package/bash/sbk.sh

@@ -1,8 +0,0 @@
-##Configurations files path
-export SBK_CONFIG_PATH=/usr/local/etc/<your_folder>
-
-##web server port 8760-8769
-export SBK_PORT=8765
-
-##Log level allowed values are fatal | error | warn | info | debug | trace
-export SBK_LOG_LEVEL=debug