apm-optima 0.0.1

package/dist/simulation/simulation.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrafficSimulator = void 0;
+const local_repository_1 = require("../core/storage/local.repository");
+const config_1 = require("./config");
+const scenarios_1 = require("./scenarios");
+const journey_1 = require("./journey");
+const utility_1 = require("./utility");
+function generateLatency(endpoint) {
+    const r = Math.random();
+    // 90% normal traffic
+    if (r < 0.90) {
+        return (0, utility_1.random)(endpoint.latency.normal * 0.7, endpoint.latency.normal * 1.3);
+    }
+    // p95 range
+    if (r < 0.99) {
+        return (0, utility_1.random)(endpoint.latency.normal, endpoint.latency.p95);
+    }
+    // p99 tail
+    return (0, utility_1.random)(endpoint.latency.p95, endpoint.latency.p99);
+}
+function applyDependencies(endpoint, latency, status) {
+    const now = Date.now();
+    // Database affects users and orders
+    if (now < scenarios_1.scenario.databaseSlowUntil && (endpoint.service === "USER" || endpoint.service === "ORDER")) {
+        latency *= (0, utility_1.random)(2, 3);
+        if ((0, utility_1.probability)(0.1)) {
+            status = 503;
+        }
+    }
+    // Auth outage
+    if (now < scenarios_1.scenario.authDownUntil && (endpoint.service === "AUTH" || endpoint.service === "ORDER")) {
+        latency *= (0, utility_1.random)(2, 3);
+        if (endpoint.service === "AUTH") {
+            status = 401;
+        }
+        else {
+            status = 503;
+        }
+    }
+    // Global latency spike
+    if (now < scenarios_1.scenario.latencySpikeUntil) {
+        latency *= (0, utility_1.random)(2, 3);
+    }
+    return { latency, status };
+}
+function generateStatus(endpoint) {
+    const r = Math.random();
+    // client errors
+    if (r < endpoint.errors.client) {
+        return (0, utility_1.random)(400, 499);
+    }
+    // server errors
+    if (r < endpoint.errors.client + endpoint.errors.server) {
+        return (0, utility_1.random)(500, 599);
+    }
+    return 200;
+}
+function findEndpoint(url) {
+    return config_1.endpoints.find(e => e.url === url) ?? config_1.endpoints[0];
+}
+function createRequest() {
+    (0, scenarios_1.updateScenarios)();
+    const journey = (0, journey_1.pickJourney)();
+    const url = journey.endpoints[(0, utility_1.random)(0, journey.endpoints.length - 1)];
+    const endpoint = findEndpoint(url);
+    const method = endpoint.methods[(0, utility_1.random)(0, endpoint.methods.length - 1)];
+    let latency = generateLatency(endpoint);
+    let status = generateStatus(endpoint);
+    // apply service failures
+    const result = applyDependencies(endpoint, latency, status);
+    latency = result.latency;
+    status = result.status;
+    // memory leak simulation
+    // increases response time slowly
+    if (scenarios_1.scenario.memoryLeak) {
+        latency *= (0, utility_1.random)(1, 2);
+    }
+    return {
+        timestamp: Date.now(),
+        endpoint: endpoint.url,
+        method,
+        statusCode: status,
+        responseTime: Math.round(latency),
+        clientIp: (0, utility_1.randomIp)(),
+    };
+}
+function generateStableLatency(endpoint) {
+    // 2% chance of a spike in latency, simulating a rare event
+    if ((0, utility_1.random)(0, 1) < 0.02) {
+        return (0, utility_1.random)(endpoint.latency.normal * 5, endpoint.latency.normal * 8.5);
+    }
+    return (0, utility_1.random)(endpoint.latency.normal * 0.85, endpoint.latency.normal * 1.15);
+}
+function createStableRequest() {
+    const journey = (0, journey_1.pickJourney)();
+    const url = journey.endpoints[(0, utility_1.random)(0, journey.endpoints.length - 1)];
+    const endpoint = config_1.endpoints.find(e => e.url === url) ?? config_1.endpoints[0];
+    const method = endpoint.methods[(0, utility_1.random)(0, endpoint.methods.length - 1)];
+    const latency = generateStableLatency(endpoint);
+    return {
+        timestamp: Date.now(),
+        endpoint: endpoint.url,
+        method,
+        statusCode: 200,
+        responseTime: Math.round(latency),
+        clientIp: (0, utility_1.randomIp)(),
+    };
+}
+const IS_STABLE = true;
+class TrafficSimulator {
+    repository;
+    timer;
+    running = false;
+    constructor(repository = local_repository_1.storage) {
+        this.repository = repository;
+    }
+    start(options) {
+        if (this.running) {
+            return;
+        }
+        this.running = true;
+        const interval = options?.intervalMs ?? 100;
+        const baseRequests = options?.requestsPerTick ?? 20;
+        console.log("Traffic simulation started!");
+        this.timer = setInterval(() => {
+            if (IS_STABLE) {
+                const request = createStableRequest();
+                this.repository.record(request);
+            }
+            else {
+                const multiplier = scenarios_1.scenario.trafficMultiplier;
+                const amount = Math.floor(baseRequests * multiplier);
+                for (let i = 0; i < amount; i++) {
+                    const request = createRequest();
+                    this.repository.record(request);
+                }
+            }
+        }, interval);
+    }
+    stop() {
+        if (!this.timer) {
+            return;
+        }
+        clearInterval(this.timer);
+        this.timer = undefined;
+        this.running = false;
+        console.log("Traffic simulation stopped!");
+    }
+    isRunning() {
+        return this.running;
+    }
+}
+exports.TrafficSimulator = TrafficSimulator;

package/dist/simulation/utility.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generates a random integer between min and max (inclusive).
+ * @param min Minimum integer value (inclusive).
+ * @param max Maximum integer value (inclusive).
+ * @returns A random integer between min and max.
+ */
+export declare function random(min: number, max: number): number;
+/**
+ * Generates a random boolean value based on the given probability.
+ * @param value A number between 0 and 1 representing the probability of returning true.
+ * @returns A boolean value that is true with the specified probability and false otherwise.
+ */
+export declare function probability(value: number): boolean;
+/**
+ * Picks a random endpoint from the list of endpoints based on their weights.
+ * @returns The selected endpoint object.
+ */
+export declare function pickEndpoint(): import("./config").EndpointConfig;
+/**
+ * Generates a random IP address in the format of "X.X.X.X", where each octet is a random integer within specified ranges.
+ * @returns A string representing the generated IP address.
+ */
+export declare function randomIp(): string;

package/dist/simulation/utility.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.random = random;
+exports.probability = probability;
+exports.pickEndpoint = pickEndpoint;
+exports.randomIp = randomIp;
+const config_1 = require("./config");
+/**
+ * Generates a random integer between min and max (inclusive).
+ * @param min Minimum integer value (inclusive).
+ * @param max Maximum integer value (inclusive).
+ * @returns A random integer between min and max.
+ */
+function random(min, max) {
+    return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+/**
+ * Generates a random boolean value based on the given probability.
+ * @param value A number between 0 and 1 representing the probability of returning true.
+ * @returns A boolean value that is true with the specified probability and false otherwise.
+ */
+function probability(value) {
+    return Math.random() < value;
+}
+/**
+ * Picks a random endpoint from the list of endpoints based on their weights.
+ * @returns The selected endpoint object.
+ */
+function pickEndpoint() {
+    let r = Math.random() * config_1.TOTAL_WEIGHT;
+    for (const endpoint of config_1.endpoints) {
+        r -= endpoint.weight;
+        if (r <= 0) {
+            return endpoint;
+        }
+    }
+    return config_1.endpoints[0];
+}
+/**
+ * Generates a random IP address in the format of "X.X.X.X", where each octet is a random integer within specified ranges.
+ * @returns A string representing the generated IP address.
+ */
+function randomIp() {
+    return [
+        random(10, 250),
+        random(0, 255),
+        random(0, 255),
+        random(1, 254)
+    ].join(".");
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+    "name": "apm-optima",
+    "version": "0.0.1",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "publishConfig": {
+        "access": "public"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./express": {
+            "types": "./dist/express/index.d.ts",
+            "default": "./dist/express/index.js"
+        },
+        "./nest": {
+            "types": "./dist/nest/index.d.ts",
+            "default": "./dist/nest/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "typesVersions": {
+        "*": {
+            "express": [
+                "dist/express/index.d.ts"
+            ],
+            "nest": [
+                "dist/nest/index.d.ts"
+            ]
+        }
+    },
+    "files": [
+        "dist",
+        "README.md",
+        "package.json"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "test": "jest"
+    },
+    "peerDependencies": {
+        "express": "^4.0.0",
+        "@nestjs/websockets": "^10.0.0 || ^11.0.0",
+        "socket.io": "^4.0.0"
+    },
+    "peerDependenciesMeta": {
+        "express": {
+            "optional": true
+        },
+        "@nestjs/websockets": {
+            "optional": true
+        },
+        "socket.io": {
+            "optional": true
+        }
+    },
+    "devDependencies": {
+        "@nestjs/websockets": "^11.2.1",
+        "express": "^4.19.2",
+        "socket.io": "^4.8.3",
+        "@types/express": "^4.17.21",
+        "@types/jest": "^29.5.14",
+        "@types/node": "^20.0.0",
+        "@types/socket.io": "^3.0.1",
+        "jest": "^29.0.0",
+        "ts-jest": "^29.0.0",
+        "typescript": "^5.0.0"
+    }
+}