@arnob-b/observability 1.0.0 → 1.0.1

package/README.md

@@ -1 +1,110 @@
 # Observability 
+
+
+# usage
+## install dependencies
+```bash
+npm install @arnob-b/observability
+```
+
+## initializing observability
+```javascript
+const { Observability } = require("@arnob-b/observability");
+Observability.initialize(OBSERVABILITY_CONFIG);
+```
+
+### Sample configuration 
+```javascript
+const path = require('path');
+const fs = require('fs');
+const LOG_ROTATION_SIZE = '1K'
+const LOG_WATCHER_FILE_SIZE = '1K'
+
+const LOG_DIR = "server_logs";
+if (!fs.existsSync(LOG_DIR)){
+	fs.mkdirSync(LOG_DIR);
+}
+const LOG_PATH=path.join(LOG_DIR,'main.%DATE%.log');
+const WATCH_FILE_PATH =path.join(LOG_DIR,'watcher.log');
+
+
+const OBSERVABILITY_CONFIG = {
+	LOG:{
+		LEVEL: 'debug',
+		TRANSPORTS: {
+			CONSOLE: {
+				NAME: "console-transport",
+				ENABLED: true,
+			},
+			FILE: {
+				NAME: "file-rotation-transport",
+				ENABLED: true,
+				PATH : LOG_PATH,
+				DIR : LOG_DIR,
+				SIZE: LOG_ROTATION_SIZE,
+				ZIP_ARCHIVE: true,
+			},
+			STREAM: {
+				NAME: "stream-transport",
+				ENABLED: false,
+				STREAM_URL: 'http://localhost:3000/logs',
+				HTTP_METHOD: 'POST',
+			},
+			WATCHER: {
+				NAME: "watcher-transport",
+				ENABLED: true,
+				PATH : WATCH_FILE_PATH,
+				SIZE: LOG_WATCHER_FILE_SIZE,
+			}
+		}
+	},
+	OTEL: {
+		SERVICE_NAME: 'electron-logger-service',
+		SERVICE_VERSION: 'http://localhost:4317',
+		INSTRUMENTS: {
+			HTTP: {
+				ENABLED: false,
+			},
+			UNDICI: {
+				ENABLED: true,
+			},
+			EXPRESS: {
+				ENABLED: false,
+			}
+		}
+	},
+}
+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.
+
+#### 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");
+```
+
+
+### adding hooks for events emmited by tranports
+
+```javascript
+const logger = Observability.getLogger("electron-application");
+attachHooksOnTransport("file-rotation-transport", {
+	'archive': (oldFilename, newFilename) => {
+		logger.info(`Log file rotated: ${oldFilename} -> ${newFilename}`);
+	}
+})
+```
+
+
+# architechture
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arnob-b/observability",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "observability for nodejs application using winston and opentelemetry",
   "keywords": ["observability", "nodejs", "winston", "opentelemetry", "electron", "desktop application"],
   "license": "MIT",
@@ -14,11 +14,9 @@
     "@opentelemetry/api": "^1.9.0",
     "@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"
-  },
-  "devDependencies": {
-    "@opentelemetry/instrumentation-express": "^0.59.0",
-    "@opentelemetry/instrumentation-http": "^0.212.0"
   }
 }

package/src/observability.js

@@ -1,7 +1,7 @@
 const {initOtel} = require("./otel");
 const {initLogger} = require("./logger");
 const { LoggerFactory } = require("./wrappers");
-class Observability {The
+class Observability {
 	constructor() {
 		if (Observability.instance) {
 			console.warn("Observability instance already exists. Returning existing instance.");