@arnob-b/observability 1.0.1 → 1.0.3

package/README.md

@@ -10,7 +10,7 @@ npm install @arnob-b/observability
 ## initializing observability
 ```javascript
 const { Observability } = require("@arnob-b/observability");
-Observability.initialize(OBSERVABILITY_CONFIG);
+Observability.init(OBSERVABILITY_CONFIG);
 ```
 
 ### Sample configuration 
@@ -79,21 +79,26 @@ module.exports = OBSERVABILITY_CONFIG;
 
 ### predefined logger object from factory
 ```javascript
-const electronLogger = Observability.getLogger("electron-application");
-
-module.exports = electronLogger;
-```
-
-there are two products from logger factory, one is for electron-application another is for backend node environment.
+const {logFunction} = require("@arnob-b/observability")
+const {normalizeData} = require("./helper.cjs")
+
+const log  = {
+		info: (msg, data = null) => logFunction('info', msg, {process:'main', data:normalizeData(data)}),
+		error: (msg, data = null) => logFunction('warn', msg, {process:'main', data:normalizeData(data)}),
+		debug: (msg, data = null) => logFunction('debug', msg, {process:'main', data:normalizeData(data)}),
+		warn: (msg, data = null) => logFunction('warn', msg, {process:'main', data:normalizeData(data)}),
+
+		renderer: {
+			info: (msg, data) => logFunction('info', msg, {process:'renderer', data:normalizeData(data)}),
+			error: (msg, data) => logFunction('error', msg, {process:'renderer', data:normalizeData(data)}),
+			warn: (msg, data) => logFunction('warn', msg, {process:'renderer', data:normalizeData(data)}),
+			debug: (msg, data) => logFunction('debug', msg, {process:'renderer', data:normalizeData(data)}),
+		}
+} 
 
-#### using logger in electron application
-```javascript
-const log = require('./utils/logger');
-log.info("This is an info log from electron application");
-log.render.info("This is a render log from electron application");
+module.exports = log;
 ```
 
-
 ### adding hooks for events emmited by tranports
 
 ```javascript
@@ -105,6 +110,31 @@ attachHooksOnTransport("file-rotation-transport", {
 })
 ```
 
+## using tracers
+```javascript
+const {startTracedExecution, traceExecution, traceAsyncExecution} = require("@arnob-b/observability");
+
+startTracedExecution("main_execution", async () => {
+	logger.debug("Starting main execution block");
+	startTracedExecution("nested_execution", async () => {
+		logger.debug("Starting main execution block");
+	})
+});
+
+const asyncFunc = traceAsyncExecution("async_execution", async () => {
+    logger.debug("Starting async execution block");
+    await new Promise(resolve => setTimeout(resolve, 1000));
+    logger.debug("Finished async execution block");
+});
+const nonAsyncFunc = traceExecution("async_execution", async () => {
+    logger.debug("Starting execution block");
+    logger.debug("Finished execution block");
+});
+
+asyncFunc();
+nonAsyncFunc();
+```
+
 
 # architechture
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arnob-b/observability",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "observability for nodejs application using winston and opentelemetry",
   "keywords": ["observability", "nodejs", "winston", "opentelemetry", "electron", "desktop application"],
   "license": "MIT",
@@ -10,13 +10,15 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "peerDependencies": {
-    "@opentelemetry/api": "^1.9.0",
+	"dependencies": {
     "@opentelemetry/instrumentation-undici": "^0.21.0",
     "@opentelemetry/sdk-node": "^0.212.0",
     "@opentelemetry/instrumentation-express": "^0.59.0",
     "@opentelemetry/instrumentation-http": "^0.212.0",
-    "winston": "^3.19.0",
     "winston-daily-rotate-file": "^5.0.0"
+	},
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "winston": "^3.19.0"
   }
 }

package/src/index.js

@@ -1,10 +1,11 @@
 const { traceExecution, traceAsyncExecution, startTracedExecution } = require("./otel");
-const {attachHooksOnTransport} = require("./logger");
+const {attachHooksOnTransport, logFunction} = require("./logger");
 const Observability = require("./observability");
 
 
 module.exports = {
 	Observability,
+	logFunction,
 	traceExecution,
 	traceAsyncExecution,
 	startTracedExecution,

package/src/logger.js

@@ -38,8 +38,16 @@ function attachHooksOnTransport(transportName, hooks = {}){
 	}
 }
 
+const logFunction = (level, message, extra = {}) =>{
+	logger.log({
+		level,
+		message,
+		...extra
+	});
+}
 
 module.exports = {
 	initLogger,
-	attachHooksOnTransport
+	attachHooksOnTransport,
+	logFunction
 }

package/src/observability.js

@@ -1,6 +1,5 @@
 const {initOtel} = require("./otel");
 const {initLogger} = require("./logger");
-const { LoggerFactory } = require("./wrappers");
 class Observability {
 	constructor() {
 		if (Observability.instance) {
@@ -21,13 +20,6 @@ class Observability {
 
 		this.initialized = true;
 	}
-	getLogger(loggerName){
-		if (!this.initialized) {
-			console.warn("Observability not initialized. Call init() first.");
-			return null;
-		}
-		return LoggerFactory(loggerName, this.logger);
-	}
 }
 
 

package/src/transports/file.rotation.transport.js

@@ -30,6 +30,10 @@ const FileRotationTransport = (CONFIG) =>{
 			const fileName = path.join(info.dir, timestamp);
 			const finalPath = fileName + '.log' + info.ext;
 			fs.renameSync(oldFilename, finalPath);
+			transport.emit('post-archive',{
+				originalPath: oldFilename,
+				archivedPath: finalPath
+			})
 		} catch (e) {
 			// logger object avoided o prevent recursive logging
 			console.error('Error during log file archiving:', e);

package/src/helper/index.js

@@ -1,17 +0,0 @@
-function normalizeData(data){
-	if (data === null || data === undefined) {
-		return '';
-	}
-	if (data instanceof Error) {
-		data = {
-			name: data.name,
-			message: data.message,
-			stack: data.stack
-		};
-	}
-	return data;
-}
-
-module.exports = { 
-	normalizeData
-};

package/src/wrappers/backend.wrapper.js

@@ -1,10 +0,0 @@
-const { normalizeData } = require('../helper');
-
-const log = (logFunction)=> {return {
-	info: (msg, data = null) => logFunction('info', msg, {data:normalizeData(data)}),
-	warn: (msg, data = null) => logFunction('warn', msg, {data:normalizeData(data)}),
-	error: (msg, data = null) => logFunction('error', msg, {data:normalizeData(data)}),
-	debug: (msg, data = null) => logFunction('debug', msg, {data:normalizeData(data)}),
-}};
-
-module.exports =  log;

package/src/wrappers/electron.wrapper.js

@@ -1,19 +0,0 @@
-const {normalizeData} = require('../helper');
-
-const log = (logFunction)=>{
-	return {
-		info: (msg, data = null) => logFunction('info', msg, {process:'main', data:normalizeData(data)}),
-		error: (msg, data = null) => logFunction('warn', msg, {process:'main', data:normalizeData(data)}),
-		debug: (msg, data = null) => logFunction('debug', msg, {process:'main', data:normalizeData(data)}),
-		warn: (msg, data = null) => logFunction('warn', msg, {process:'main', data:normalizeData(data)}),
-
-		renderer: {
-			info: (msg, data) => logFunction('info', msg, {process:'renderer', data:normalizeData(data)}),
-			error: (msg, data) => logFunction('error', msg, {process:'renderer', data:normalizeData(data)}),
-			warn: (msg, data) => logFunction('warn', msg, {process:'renderer', data:normalizeData(data)}),
-			debug: (msg, data) => logFunction('debug', msg, {process:'renderer', data:normalizeData(data)}),
-		}
-	};
-} 
-
-module.exports = log;

package/src/wrappers/factory.js

@@ -1,28 +0,0 @@
-const electronLogger = require("./electron.wrapper");
-const backendLogger = require("./backend.wrapper");
-
-
-
-const LoggerFactory = function (loggerName, logger){
-	const logFunction = (level, message, extra = {}) =>{
-		logger.log({
-			level,
-			message,
-			...extra
-		});
-	}
-	if (loggerName === "default") {
-		return logFunction;
-	}
-	if (loggerName === "electron-application") {
-		return electronLogger(logFunction);
-	}
-	if (loggerName === "backend"){
-		return backendLogger(logFunction);
-	}
-	return logFunction;
-}
-
-
-
-module.exports = LoggerFactory;

package/src/wrappers/index.js

@@ -1,4 +0,0 @@
-const LoggerFactory = require('./factory');
-module.exports = {
-	LoggerFactory
-}