@deniscuciuc/redis-analyzer 1.0.0

package/dist/tests/analysis-and-reports.test.js

@@ -0,0 +1,172 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_fs_1 = require("node:fs");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
+const node_test_1 = __importDefault(require("node:test"));
+const memory_analyzer_1 = require("../src/analyzers/memory-analyzer");
+const performance_analyzer_1 = require("../src/analyzers/performance-analyzer");
+const persistence_analyzer_1 = require("../src/analyzers/persistence-analyzer");
+const replication_analyzer_1 = require("../src/analyzers/replication-analyzer");
+const health_1 = require("../src/health");
+const report_generator_1 = require("../src/reporters/report-generator");
+function createInfo() {
+    return {
+        redisVersion: "7.2.5",
+        redisMode: "standalone",
+        os: "Linux",
+        uptimeInSeconds: 86400,
+        uptimeInDays: 1,
+        tcpPort: 6379,
+        executablePath: "/usr/bin/redis-server",
+        configFile: "/etc/redis/redis.conf",
+        connectedClients: 12,
+        blockedClients: 1,
+        maxClients: 1000,
+        clientRecentMaxInputBuffer: 2048,
+        clientRecentMaxOutputBuffer: 4096,
+        usedMemory: 50 * 1024 * 1024,
+        usedMemoryHuman: "50.00M",
+        usedMemoryRss: 75 * 1024 * 1024,
+        usedMemoryRssHuman: "75.00M",
+        usedMemoryPeak: 60 * 1024 * 1024,
+        usedMemoryPeakHuman: "60.00M",
+        usedMemoryPeakPerc: 83.33,
+        usedMemoryOverhead: 10 * 1024 * 1024,
+        usedMemoryDataset: 40 * 1024 * 1024,
+        memFragmentationRatio: 1.75,
+        memFragmentationBytes: 25 * 1024 * 1024,
+        maxmemory: 64 * 1024 * 1024,
+        maxmemoryHuman: "64.00M",
+        maxmemoryPolicy: "allkeys-lru",
+        totalCommandsProcessed: 1000,
+        instantaneousOpsPerSec: 150,
+        totalNetInputBytes: 1024,
+        totalNetOutputBytes: 2048,
+        rejectedConnections: 2,
+        expiredKeys: 100,
+        evictedKeys: 5,
+        keyspaceHits: 900,
+        keyspaceMisses: 100,
+        role: "master",
+        connectedSlaves: 0,
+        rdbChangesSinceLastSave: 500,
+        rdbBgsaveInProgress: false,
+        rdbLastSaveTime: Math.floor(Date.now() / 1000) - 3600,
+        rdbLastBgsaveStatus: "ok",
+        rdbLastBgsaveTimeSec: 2,
+        aofEnabled: true,
+        aofRewriteInProgress: false,
+        aofLastRewriteTimeSec: 4,
+        aofLastBgrewriteStatus: "ok",
+        aofCurrentSize: 20480,
+        keyspaces: [
+            { db: 0, keys: 1234, expires: 234, avgTtl: 60000 },
+            { db: 1, keys: 100, expires: 10, avgTtl: 1000 },
+        ],
+    };
+}
+(0, node_test_1.default)("analyzers produce actionable redis report data", () => {
+    const info = createInfo();
+    const memory = new memory_analyzer_1.MemoryAnalyzer().analyze(info);
+    const performance = new performance_analyzer_1.PerformanceAnalyzer();
+    const hitRate = performance.analyzeHitRate(info);
+    const persistence = new persistence_analyzer_1.PersistenceAnalyzer().analyze(info);
+    const replication = new replication_analyzer_1.ReplicationAnalyzer().analyze(info);
+    const slowCommands = performance.analyzeSlowCommands([
+        {
+            id: 1,
+            timestamp: 1718500000,
+            durationMicros: 12000,
+            durationMs: 12,
+            command: ["KEYS", "*"],
+            commandPreview: "KEYS *",
+        },
+    ], 1, 10000);
+    strict_1.default.equal(memory.fragSeverity, "warning");
+    strict_1.default.equal(Number(hitRate.hitRate.toFixed(1)), 90);
+    strict_1.default.equal(persistence.severity, "ok");
+    strict_1.default.equal(replication.role, "standalone");
+    strict_1.default.equal(slowCommands.topCommandTypes[0].command, "KEYS");
+});
+(0, node_test_1.default)("computeHealthScore deducts for redis risks", () => {
+    const info = createInfo();
+    const memory = new memory_analyzer_1.MemoryAnalyzer().analyze(info);
+    const performance = new performance_analyzer_1.PerformanceAnalyzer();
+    const report = {
+        generatedAt: new Date(),
+        host: "localhost",
+        port: 6379,
+        db: 0,
+        metrics: {
+            version: info.redisVersion,
+            mode: info.redisMode,
+            uptimeDays: info.uptimeInDays,
+            connectedClients: info.connectedClients,
+            blockedClients: info.blockedClients,
+            maxClients: info.maxClients,
+            opsPerSec: info.instantaneousOpsPerSec,
+            totalKeyCount: 1334,
+            keyspacesCount: 2,
+            rejectedConnections: info.rejectedConnections,
+        },
+        memory,
+        hitRate: performance.analyzeHitRate(info),
+        persistence: new persistence_analyzer_1.PersistenceAnalyzer().analyze(info),
+        replication: new replication_analyzer_1.ReplicationAnalyzer().analyze(info),
+        slowCommands: performance.analyzeSlowCommands([], 0, 10000),
+        keyspaces: info.keyspaces,
+        config: {},
+    };
+    strict_1.default.ok((0, health_1.computeHealthScore)(report) < 100);
+});
+(0, node_test_1.default)("ReportGenerator writes markdown, json, and html reports", async () => {
+    const info = createInfo();
+    const memory = new memory_analyzer_1.MemoryAnalyzer().analyze(info);
+    const performance = new performance_analyzer_1.PerformanceAnalyzer();
+    const report = {
+        generatedAt: new Date(),
+        host: "localhost",
+        port: 6379,
+        db: 0,
+        healthScore: 87,
+        metrics: {
+            version: info.redisVersion,
+            mode: info.redisMode,
+            uptimeDays: info.uptimeInDays,
+            connectedClients: info.connectedClients,
+            blockedClients: info.blockedClients,
+            maxClients: info.maxClients,
+            opsPerSec: info.instantaneousOpsPerSec,
+            totalKeyCount: 1334,
+            keyspacesCount: 2,
+            rejectedConnections: info.rejectedConnections,
+        },
+        memory,
+        hitRate: performance.analyzeHitRate(info),
+        persistence: new persistence_analyzer_1.PersistenceAnalyzer().analyze(info),
+        replication: new replication_analyzer_1.ReplicationAnalyzer().analyze(info),
+        slowCommands: performance.analyzeSlowCommands([], 0, 10000),
+        keyspaces: info.keyspaces,
+        config: { maxmemory: "67108864" },
+        recommendations: [
+            {
+                priority: "medium",
+                category: "memory",
+                message: "Monitor fragmentation.",
+            },
+        ],
+    };
+    const outputDir = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), "redis-analyzer-"));
+    const generator = new report_generator_1.ReportGenerator(outputDir);
+    const markdown = await generator.generateFullReport(report, "2026-06-14T00-00-00-000Z");
+    const json = await generator.generateJsonReport(report, "2026-06-14T00-00-00-000Z");
+    const html = await generator.generateHtmlReport(report, "2026-06-14T00-00-00-000Z");
+    strict_1.default.ok(markdown.endsWith(".md"));
+    strict_1.default.ok(json.endsWith(".json"));
+    strict_1.default.ok(html.endsWith(".html"));
+});

package/dist/tests/collector-and-options.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=collector-and-options.test.d.ts.map

package/dist/tests/collector-and-options.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector-and-options.test.d.ts","sourceRoot":"","sources":["../../tests/collector-and-options.test.ts"],"names":[],"mappings":""}

package/dist/tests/collector-and-options.test.js

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_test_1 = __importDefault(require("node:test"));
+const options_1 = require("../src/cli/options");
+const stats_collector_1 = require("../src/collectors/stats-collector");
+const SAMPLE_INFO = `# Server\r
+redis_version:7.2.5\r
+redis_mode:standalone\r
+os:Linux\r
+uptime_in_seconds:86400\r
+uptime_in_days:1\r
+tcp_port:6379\r
+executable:/usr/bin/redis-server\r
+config_file:/etc/redis/redis.conf\r
+# Clients\r
+connected_clients:12\r
+blocked_clients:1\r
+maxclients:1000\r
+client_recent_max_input_buffer:2048\r
+client_recent_max_output_buffer:4096\r
+# Memory\r
+used_memory:52428800\r
+used_memory_human:50.00M\r
+used_memory_rss:78643200\r
+used_memory_rss_human:75.00M\r
+used_memory_peak:62914560\r
+used_memory_peak_human:60.00M\r
+used_memory_peak_perc:83.33%\r
+used_memory_overhead:10485760\r
+used_memory_dataset:41943040\r
+mem_fragmentation_ratio:1.75\r
+mem_fragmentation_bytes:26214400\r
+maxmemory:67108864\r
+maxmemory_human:64.00M\r
+maxmemory_policy:allkeys-lru\r
+# Stats\r
+total_commands_processed:1000\r
+instantaneous_ops_per_sec:150\r
+total_net_input_bytes:1024\r
+total_net_output_bytes:2048\r
+rejected_connections:2\r
+expired_keys:100\r
+evicted_keys:5\r
+keyspace_hits:900\r
+keyspace_misses:100\r
+# Replication\r
+role:master\r
+connected_slaves:0\r
+# Persistence\r
+rdb_changes_since_last_save:500\r
+rdb_bgsave_in_progress:0\r
+rdb_last_save_time:1718352000\r
+rdb_last_bgsave_status:ok\r
+rdb_last_bgsave_time_sec:2\r
+aof_enabled:1\r
+aof_rewrite_in_progress:0\r
+aof_last_rewrite_time_sec:4\r
+aof_last_bgrewrite_status:ok\r
+aof_current_size:20480\r
+# Keyspace\r
+db0:keys=1234,expires=234,avg_ttl=60000\r
+db1:keys=100,expires=10,avg_ttl=1000\r
+`;
+(0, node_test_1.default)("parseOptions reads Redis CLI flags", () => {
+    const options = (0, options_1.parseOptions)([
+        "--host",
+        "redis.internal",
+        "--port",
+        "6380",
+        "--db",
+        "2",
+        "--slow-threshold",
+        "5000",
+        "--max-slow-commands",
+        "10",
+        "--command",
+        "health",
+    ]);
+    strict_1.default.equal(options.host, "redis.internal");
+    strict_1.default.equal(options.port, 6380);
+    strict_1.default.equal(options.db, 2);
+    strict_1.default.equal(options.slowCommandThreshold, 5000);
+    strict_1.default.equal(options.maxSlowCommands, 10);
+    strict_1.default.equal(options.command, "health");
+});
+(0, node_test_1.default)("parseRedisInfo parses INFO output and keyspaces", () => {
+    const info = (0, stats_collector_1.parseRedisInfo)(SAMPLE_INFO);
+    strict_1.default.equal(info.redisVersion, "7.2.5");
+    strict_1.default.equal(info.connectedClients, 12);
+    strict_1.default.equal(info.maxmemoryPolicy, "allkeys-lru");
+    strict_1.default.equal(info.keyspaces.length, 2);
+    strict_1.default.deepEqual(info.keyspaces[0], {
+        db: 0,
+        keys: 1234,
+        expires: 234,
+        avgTtl: 60000,
+    });
+});
+(0, node_test_1.default)("parseSlowLogEntries normalizes slowlog rows", () => {
+    const slowCommands = (0, stats_collector_1.parseSlowLogEntries)([
+        [1, 1718500000, 12000, ["KEYS", "*"], "127.0.0.1:50000"],
+    ]);
+    strict_1.default.equal(slowCommands[0].durationMs, 12);
+    strict_1.default.equal(slowCommands[0].commandPreview, "KEYS *");
+    strict_1.default.equal(slowCommands[0].clientAddr, "127.0.0.1:50000");
+});

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@deniscuciuc/redis-analyzer",
+  "version": "1.0.0",
+  "description": "CLI tool that analyzes Redis servers for memory pressure, cache efficiency, persistence safety, replication health, and slow commands.",
+  "keywords": [
+    "redis",
+    "database",
+    "analyzer",
+    "performance",
+    "cache",
+    "cli",
+    "memory",
+    "replication",
+    "slowlog",
+    "devops"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/deniscuciuc/db-analyzer-redis.git"
+  },
+  "bugs": {
+    "url": "https://github.com/deniscuciuc/db-analyzer-redis/issues"
+  },
+  "license": "MIT",
+  "author": "Denis Cuciuc <denis@deniscuciuc.dev>",
+  "homepage": "https://github.com/deniscuciuc/db-analyzer-redis#readme",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "redis-analyzer": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "analyzerrc.example.json"
+  ],
+  "dependencies": {
+    "@inquirer/prompts": "^8.1.0",
+    "ioredis": "^5.4.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.3.11",
+    "@types/node": "^22.15.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=10"
+  },
+  "scripts": {
+    "start": ". ./.env && npx ts-node index.ts start",
+    "analyze": ". ./.env && npx ts-node index.ts",
+    "analyze:help": "npx ts-node index.ts --help",
+    "analyze:health": ". ./.env && npx ts-node index.ts -j -c health",
+    "analyze:memory": ". ./.env && npx ts-node index.ts -j -c memory",
+    "analyze:hit-rate": ". ./.env && npx ts-node index.ts -j -c hit-rate",
+    "analyze:slow": ". ./.env && npx ts-node index.ts -j -c slow-commands",
+    "analyze:keys": ". ./.env && npx ts-node index.ts -j -c keys",
+    "analyze:connections": ". ./.env && npx ts-node index.ts -j -c connections",
+    "analyze:persistence": ". ./.env && npx ts-node index.ts -j -c persistence",
+    "analyze:replication": ". ./.env && npx ts-node index.ts -j -c replication",
+    "analyze:config": ". ./.env && npx ts-node index.ts -j -c config",
+    "analyze:html": ". ./.env && npx ts-node index.ts --html -c full",
+    "analyze:watch": ". ./.env && npx ts-node index.ts -c health --watch 30",
+    "server:info": ". ./.env && npx ts-node index.ts -j -c server-info",
+    "build": "tsc",
+    "postbuild": "node scripts/add-shebang.js",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "test": "node --test dist/tests/*.test.js",
+    "release:patch": "npm version patch && git push && git push --tags",
+    "release:minor": "npm version minor && git push && git push --tags",
+    "release:major": "npm version major && git push && git push --tags"
+  }
+}