apm-optima 1.0.0 → 1.0.2

package/README.md

@@ -1,96 +1,37 @@
-<div align="center">
-
-<h1>Optima APM</h1>
+# apm-optima
 
-<img src="docs/assets/optima-icon.svg" alt="Optima Icon" width="64" />
+> Lightweight, real-time Application Performance Monitoring (APM) and telemetry library for Node.js web applications.
 
-<p><b>Lightweight, real-time Telemetry & Application Performance Monitoring for Node.js</b></p>
+<div align="center">
 
-[![npm version](https://img.shields.io/npm/v/@optima/core.svg?style=flat-square&color=fc6c26)](https://www.npmjs.com/package/@optima/core)
+[![npm version](https://img.shields.io/npm/v/apm-optima.svg?style=flat-square&color=fc6c26)](https://www.npmjs.com/package/apm-optima)
 [![license](https://img.shields.io/github/license/Nosalis1/Optima?style=flat-square&color=8A897C)](https://github.com/Nosalis1/Optima/blob/main/LICENSE)
-[![node version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen?style=flat-square)](https://nodejs.org)
-[![npm version](https://img.shields.io/badge/npm-%3E%3D10.0.0-red?style=flat-square)](https://www.npmjs.com/)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
-
-<br/>
-
-<a href="#key-features">Key Features</a> •
-<a href="#architecture">Architecture</a> •
-<a href="#quick-start">Quick Start</a> •
-<a href="#configuration-options">Configuration</a> •
-<a href="#dashboard-preview">Dashboard</a>
+[![github](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/Nosalis1/Optima.git)
 
 </div>
 
----
-
-## Overview
-
-**Optima** is an in-memory Application Performance Monitoring (APM) library designed for modern Node.js web services. It intercepts HTTP requests, tracks Event Loop lag, computes latency percentiles in real time, and identifies performance anomalies—all while serving an embedded React Dashboard with zero external database dependencies.
-
-> Built for **Express.js** and **NestJS** applications with low runtime overhead.
-
----
-
-## Key Features
-
-- **Real-time Latency Metrics:** On-the-fly computation of $P_{50}$, $P_{95}$, and $P_{99}$ percentiles.
-- **Z-Score Anomaly Detection:** Statistical detection of unexpected response time spikes.
-- **In-Memory Storage:** Efficient metric aggregation using typed array (`Uint32Array`) histogram buckets and circular ring buffers.
-- **Embedded React Dashboard:** Zero-config static dashboard served directly through your primary Node.js HTTP server.
-- **Framework Agnostic Core:** Native support for both **Express** (middleware) and **NestJS** (interceptors/modules).
-- **Live Updates:** Low-latency WebSocket layer pushing live metrics straight to the UI.
-
----
-
-## Dashboard Preview
+## Features
 
-<!-- ZAMENI SA STVARNOM SLIKOM KADA JE DODATNA U REPOZITORIJUM -->
-<div align="center">
-  <table border="0">
-    <tr>
-      <td width="33.3%"><img src="docs/assets/dashboard-1.png" alt="Optima Dashboard Preview 1" /></td>
-      <td width="33.3%"><img src="docs/assets/dashboard-2.png" alt="Optima Dashboard Preview 2" /></td>
-      <td width="33.3%"><img src="docs/assets/dashboard-3.png" alt="Optima Dashboard Preview 3" /></td>
-    </tr>
-  </table>
-  <td width="33.3%"><img src="docs/assets/dashboard-1-dark.png" alt="Optima Dashboard Preview 3" /></td>
-  <p><i>Real-time monitoring interface served directly via <code>/optima-metrics</code>.</i></p>
-</div>
+- **Real-Time Telemetry:** HTTP request latency, status codes, and throughput.
+- **Node.js Diagnostics:** Event Loop lag monitoring, process memory distribution, and active handles.
+- **Embedded Dashboard UI:** Instant built-in dashboard available directly at your metrics route.
+- **Console Logger:** Pretty-printed HTTP request duration and status output.
 
 ---
 
-## Architecture
+## Installation
 
-Optima is structured as a **Monorepo** managed with `npm workspaces`:
-
-```
-├── packages/
-│   └── core/          # Telemetry engine, interceptors, and WebSocket adapters (@optima-apm/core)
-│   └── dashboard/     # Next.js React Dashboard (exported statically into @optima-apm/core)
-├── apps/              # Integration & demo application (Express & NestJS)
+```bash
+npm install apm-optima
 ```
 
 ---
 
-## Quick Start
-
-### Installation
-
-```bash
-npm install @optima-apm/core
-# or
-pnpm add @optima-apm/core
-# or
-yarn add @optima-apm/core
-```
-
-### Express.js Integration
+## Quick Start (Express)
 
-Attach Optima using setupOptima and hook the HTTP server instance:
-```ts
+```typescript
 const express = require('express');
-const { setupOptima } = require('@optima-apm/core/express');
+const { setupOptima } = require('apm-optima/express');
 
 const app = express();
 app.use(express.json());
@@ -116,12 +57,13 @@ const server = app.listen(3000, () => {
 const stopMetrics = optima.attachServer(server);
 ```
 
-### NestJS Integration
+---
+
+## Quick Start (NestJS)
 
-Import MetricsModule into your root application module:
 ```ts
 import { Module } from '@nestjs/common';
-import { MetricsModule } from '@optima-apm/core/nest';
+import { MetricsModule } from 'apm-optima/nest';
 
 @Module({
   imports: [
@@ -138,10 +80,10 @@ import { MetricsModule } from '@optima-apm/core/nest';
 export class AppModule {}
 ```
 
-### Configuration Options
+## Configuration Options
 
 | Option | Type | Default | Description |
-| --- | --- | --- | --- |
+| :--- | :--- | :--- | :--- |
 | `dashboardPath` | `string \| false` | `/optima-metrics` | Route endpoint for serving the embedded UI (`false` to disable). |
 | `simulation` | `false \| { intervalMs: number, requestsPerTick: number }` | `false` | Generates synthetic traffic for local testing and load simulation. |
 | `publisher.intervalMs` | `number` | `1000` | Broadcast interval (in ms) for pushing telemetry updates over WebSockets. |
@@ -154,13 +96,6 @@ export class AppModule {}
 | `ringBufferSize` | `number` | `60` | Capacity of the internal ring buffer used for storing time-series data. |
 | `alertBufferSize` | `number` | `100` | Maximum capacity of the buffer holding recent alerts and detected anomalies. |
 
-## Contributing
-
-Contributions, issues, and feature requests are welcome!  
-Feel free to check out the [issues page](https://github.com/Nosalis1/Optima/issues).
-
-Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a Pull Request or opening an issue.
-
 ## License
 
-Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.
+[MIT](LICENSE)

package/dist/config/config.manager.js

@@ -25,7 +25,6 @@ class ConfigManager {
             '*.css',
             '/favicon.ico',
             '/metrics_pack',
-            '/',
             '/health',
             '/optima-metrics/**',
             '/optima-metrics/*',

package/dist/core/telemetry/logger.d.ts

@@ -5,7 +5,7 @@ declare class Logger {
     private static readonly DIM;
     private static readonly COLORS;
     static log(req: Request, res: Response, duration: number): void;
-    static debug(message: string): void;
+    static debug(message: string, ...args: unknown[]): void;
     static duration(message: string, duration: number): void;
 }
 export default Logger;

package/dist/core/telemetry/logger.js

@@ -41,9 +41,9 @@ class Logger {
             `•  ${statusCode}  • ` +
             `${timing}`);
     }
-    static debug(message) {
+    static debug(message, ...args) {
         const timestamp = new Date().toISOString().split('T')[1].slice(0, -1);
-        console.log(`${Logger.DIM}[${timestamp}]${Logger.RESET} ${Logger.DIM}${message}${Logger.RESET}`);
+        console.log(`${Logger.DIM}[${timestamp}]${Logger.RESET} [Optima] ${Logger.DIM}${message}${Logger.RESET}`, ...args);
     }
     static duration(message, duration) {
         return; // Disable duration logging for now

package/dist/express/index.js

@@ -1,21 +1,32 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupOptima = setupOptima;
 const config_1 = require("../config");
 const metrics_middleware_1 = require("./metrics.middleware");
 const metrics_dashboard_1 = require("./metrics.dashboard");
 const metrics_bootstrap_1 = require("./metrics.bootstrap");
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 function setupOptima(app, options) {
+    logger_1.default.debug('Initializing Optima with provided configuration options...');
     config_1.ConfigManager.getInstance().initialize(options);
     const config = config_1.ConfigManager.getInstance().get();
     // Registering the metrics middleware
     app.use(metrics_middleware_1.expressMetricsMiddleware);
+    logger_1.default.debug('Middlware for metrics collection has been registered successfully.');
     // Attaching the dashboard on provided path
     if (config.dashboardPath !== false) {
         (0, metrics_dashboard_1.attachDashboard)(app, config.dashboardPath);
+        logger_1.default.debug(`Dashboard has been attached at path: ${config.dashboardPath}`);
+    }
+    else {
+        logger_1.default.debug('Dashboard attachment skipped as per configuration.');
     }
     return {
         attachServer: (server) => {
+            logger_1.default.debug('Attaching server for metrics collection...');
             return (0, metrics_bootstrap_1.expressMetricsBootstrap)(server);
         }
     };

package/dist/express/metrics-websocket.adapter.js

@@ -1,9 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpressWebSocketAdapter = void 0;
 const socket_io_1 = require("socket.io");
 const delivery_1 = require("../core/delivery");
 const config_1 = require("../config");
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 class ExpressWebSocketAdapter {
     server;
     provider;
@@ -14,7 +18,7 @@ class ExpressWebSocketAdapter {
     }
     init() {
         if (this.io) {
-            console.warn('[Optima] WebSocket server is already initialized.');
+            logger_1.default.debug('WebSocket server is already initialized.');
             return;
         }
         this.io = new socket_io_1.Server(this.server, {
@@ -27,15 +31,15 @@ class ExpressWebSocketAdapter {
                 methods: ['GET', 'POST'],
             },
         });
-        console.log('[Optima] WebSocket server initialized successfully.');
+        logger_1.default.debug('WebSocket server initialized successfully.');
         this.setupEvents();
     }
     setupEvents() {
         if (!this.io)
             return;
-        console.log('[Optima] Setting up WebSocket event bindings.');
+        logger_1.default.debug('Setting up WebSocket event bindings.');
         this.io.on('connection', socket => {
-            console.log(`[Optima] New WebSocket connection: ${socket.id}`);
+            logger_1.default.debug(`New WebSocket connection: ${socket.id}`);
             this.setupClient(socket);
         });
     }
@@ -56,7 +60,7 @@ class ExpressWebSocketAdapter {
             socket.emit(delivery_1.WebSocketEvents.RESPONSE_HEALTH_DATA, this.provider.getHealthData());
         });
         socket.on('disconnect', () => {
-            console.log(`[Optima] WebSocket disconnected: ${socket.id}`);
+            logger_1.default.debug(`WebSocket disconnected: ${socket.id}`);
         });
     }
     broadcast(event, data) {

package/dist/express/metrics.bootstrap.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expressMetricsBootstrap = expressMetricsBootstrap;
 const metrics_websocket_adapter_1 = require("./metrics-websocket.adapter");
@@ -7,6 +10,7 @@ const simulation_1 = require("../simulation/simulation");
 const delivery_1 = require("../core/delivery");
 const correlation_service_1 = require("../core/telemetry/correlation.service");
 const config_1 = require("../config");
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 function expressMetricsBootstrap(server) {
     const config = (0, config_1.getConfig)();
     let simulator = null;
@@ -25,7 +29,7 @@ function expressMetricsBootstrap(server) {
         collector_service_1.collectorService.tick();
         correlation_service_1.correlationService.tick();
     }, config.tickIntervalMs);
-    console.log('[Optima] Uspešno inicijalizovani svi podsistemi monitoringa.');
+    logger_1.default.debug('Metrics bootstrap initialized successfully.');
     return () => {
         simulator?.stop();
         publisher.stop();

package/dist/nest/metrics-websocket.adapter.js

@@ -11,19 +11,23 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NestWebSocketAdapter = void 0;
 const websockets_1 = require("@nestjs/websockets");
 const delivery_1 = require("../core/delivery");
 const collector_service_1 = require("../core/telemetry/collector.service");
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 let NestWebSocketAdapter = class NestWebSocketAdapter {
     server;
     init() { }
     handleConnection(socket) {
-        console.log('[Optima] Dashboard klijent se povezao.', socket.id);
+        logger_1.default.debug('Dashboard client connected.', socket.id);
     }
     handleDisconnect(socket) {
-        console.log('[Optima] Dashboard klijent se odjavio.', socket.id);
+        logger_1.default.debug('Dashboard client disconnected.', socket.id);
     }
     handleSystemData(socket) {
         socket.emit(delivery_1.WebSocketEvents.RESPONSE_SYSTEM_DATA, collector_service_1.collectorService.getSystemStaticInfo());

package/dist/nest/metrics.bootstrap.service.js

@@ -11,6 +11,9 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetricsBootstrapService = void 0;
 const common_1 = require("@nestjs/common");
@@ -19,6 +22,7 @@ const correlation_service_1 = require("../core/telemetry/correlation.service");
 const delivery_1 = require("../core/delivery");
 const simulation_1 = require("../simulation/simulation");
 const metrics_websocket_adapter_1 = require("./metrics-websocket.adapter");
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 let MetricsBootstrapService = class MetricsBootstrapService {
     websocket;
     config;
@@ -44,7 +48,7 @@ let MetricsBootstrapService = class MetricsBootstrapService {
             collector_service_1.collectorService.tick();
             correlation_service_1.correlationService.tick();
         }, this.config.tickIntervalMs);
-        console.log('[Optima] Nest metrics bootstrap initialized.');
+        logger_1.default.debug('Nest metrics bootstrap initialized.');
     }
     onApplicationShutdown() {
         this.simulator?.stop();

package/dist/simulation/scenarios.js

@@ -1,7 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScenarioController = exports.scenario = void 0;
 exports.updateScenarios = updateScenarios;
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 const utility_1 = require("./utility");
 exports.scenario = {
     trafficMultiplier: 1,
@@ -16,7 +20,7 @@ function updateScenarios() {
     if (now > exports.scenario.latencySpikeUntil && (0, utility_1.probability)(0.002)) {
         exports.scenario.trafficMultiplier = 3;
         exports.scenario.latencySpikeUntil = now + 10000;
-        console.log("📈 Traffic spike started");
+        logger_1.default.debug("Traffic spike started");
     }
     if (now > exports.scenario.latencySpikeUntil) {
         exports.scenario.trafficMultiplier = 1;
@@ -24,17 +28,17 @@ function updateScenarios() {
     // database slowdown
     if (now > exports.scenario.databaseSlowUntil && (0, utility_1.probability)(0.001)) {
         exports.scenario.databaseSlowUntil = now + 12000;
-        console.log("🐢 Database slowdown");
+        logger_1.default.debug("Database slowdown");
     }
     // auth outage
     if (now > exports.scenario.authDownUntil && (0, utility_1.probability)(0.0005)) {
         exports.scenario.authDownUntil = now + 8000;
-        console.log("🔐 Auth outage");
+        logger_1.default.debug("Auth outage");
     }
     // memory leak
     if (!exports.scenario.memoryLeak && (0, utility_1.probability)(0.0002)) {
         exports.scenario.memoryLeak = true;
-        console.log("🧠 Memory leak started");
+        logger_1.default.debug("Memory leak started");
     }
 }
 class ScenarioController {
@@ -48,19 +52,19 @@ class ScenarioController {
             case "TRAFFIC_SPIKE":
                 this.state.trafficMultiplier = 4;
                 this.state.latencySpikeUntil = now + 30000;
-                console.log("Manual traffic spike!");
+                logger_1.default.debug("Manual traffic spike!");
                 break;
             case "DATABASE_SLOWDOWN":
                 this.state.databaseSlowUntil = now + 60000;
-                console.log("Manual database slowdown!");
+                logger_1.default.debug("Manual database slowdown!");
                 break;
             case "AUTH_OUTAGE":
                 this.state.authDownUntil = now + 30000;
-                console.log("Manual auth outage!");
+                logger_1.default.debug("Manual auth outage!");
                 break;
             case "MEMORY_LEAK":
                 this.state.memoryLeak = true;
-                console.log("Manual memory leak!");
+                logger_1.default.debug("Manual memory leak!");
                 break;
             case "RESET":
                 this.reset();
@@ -90,7 +94,7 @@ class ScenarioController {
         this.state.authDownUntil = 0;
         this.state.latencySpikeUntil = 0;
         this.state.memoryLeak = false;
-        console.log("Scenarios reset!");
+        logger_1.default.debug("Scenarios reset!");
     }
 }
 exports.ScenarioController = ScenarioController;

package/dist/simulation/simulation.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TrafficSimulator = void 0;
 const local_repository_1 = require("../core/storage/local.repository");
@@ -6,6 +9,7 @@ const config_1 = require("./config");
 const scenarios_1 = require("./scenarios");
 const journey_1 = require("./journey");
 const utility_1 = require("./utility");
+const logger_1 = __importDefault(require("../core/telemetry/logger"));
 function generateLatency(endpoint) {
     const r = Math.random();
     // 90% normal traffic
@@ -122,7 +126,7 @@ class TrafficSimulator {
         this.running = true;
         const interval = options?.intervalMs ?? 100;
         const baseRequests = options?.requestsPerTick ?? 20;
-        console.log("Traffic simulation started!");
+        logger_1.default.debug("Traffic simulation started!");
         this.timer = setInterval(() => {
             if (IS_STABLE) {
                 const request = createStableRequest();
@@ -145,7 +149,7 @@ class TrafficSimulator {
         clearInterval(this.timer);
         this.timer = undefined;
         this.running = false;
-        console.log("Traffic simulation stopped!");
+        logger_1.default.debug("Traffic simulation stopped!");
     }
     isRunning() {
         return this.running;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "apm-optima",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "publishConfig": {
@@ -34,6 +34,7 @@
     "files": [
         "dist",
         "README.md",
+        "LICENSE",
         "package.json"
     ],
     "scripts": {
@@ -68,4 +69,4 @@
         "ts-jest": "^29.0.0",
         "typescript": "^5.0.0"
     }
-}
+}