hono-status-monitor 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,209 @@
+import type { Server as SocketServer } from 'socket.io';
+/**
+ * Configuration options for the status monitor
+ */
+export interface StatusMonitorConfig {
+    /** Path where the dashboard will be mounted (default: '/status') */
+    path?: string;
+    /** Dashboard title (default: 'Server Status') */
+    title?: string;
+    /** Socket.io path (default: '/status/socket.io') */
+    socketPath?: string;
+    /** Update interval in milliseconds (default: 1000) */
+    updateInterval?: number;
+    /** History retention in seconds (default: 60) */
+    retentionSeconds?: number;
+    /** Maximum recent errors to store (default: 10) */
+    maxRecentErrors?: number;
+    /** Maximum routes to show in analytics (default: 10) */
+    maxRoutes?: number;
+    /** Alert thresholds */
+    alerts?: AlertThresholds;
+    /** Optional async function to check database health */
+    healthCheck?: () => Promise<HealthCheckResult>;
+    /** Custom path normalization function */
+    normalizePath?: (path: string) => string;
+}
+/**
+ * Alert thresholds configuration
+ */
+export interface AlertThresholds {
+    /** CPU percentage threshold (default: 80) */
+    cpu?: number;
+    /** Memory percentage threshold (default: 90) */
+    memory?: number;
+    /** Response time in ms threshold (default: 500) */
+    responseTime?: number;
+    /** Error rate percentage threshold (default: 5) */
+    errorRate?: number;
+    /** Event loop lag in ms threshold (default: 100) */
+    eventLoopLag?: number;
+}
+/**
+ * Health check result from custom health check function
+ */
+export interface HealthCheckResult {
+    connected: boolean;
+    latencyMs: number;
+    name?: string;
+    details?: Record<string, unknown>;
+}
+/**
+ * Single metric data point
+ */
+export interface MetricDataPoint {
+    timestamp: number;
+    value: number;
+}
+/**
+ * Status code counts
+ */
+export interface StatusCodeCount {
+    [code: string]: number;
+}
+/**
+ * Route statistics
+ */
+export interface RouteStats {
+    path: string;
+    method: string;
+    count: number;
+    totalTime: number;
+    avgTime: number;
+    minTime: number;
+    maxTime: number;
+    errors: number;
+    lastAccess: number;
+}
+/**
+ * Error entry
+ */
+export interface ErrorEntry {
+    timestamp: number;
+    path: string;
+    method: string;
+    status: number;
+    message: string;
+}
+/**
+ * Response time percentiles
+ */
+export interface PercentileData {
+    p50: number;
+    p95: number;
+    p99: number;
+    avg: number;
+}
+/**
+ * Alert status flags
+ */
+export interface AlertStatus {
+    cpu: boolean;
+    memory: boolean;
+    responseTime: boolean;
+    errorRate: boolean;
+    eventLoopLag: boolean;
+}
+/**
+ * GC statistics
+ */
+export interface GCStats {
+    collections: number;
+    pauseTimeMs: number;
+    heapGrowthRate: number;
+}
+/**
+ * Database/Health check stats
+ */
+export interface DatabaseStats {
+    connected: boolean;
+    poolSize: number;
+    availableConnections: number;
+    waitQueueSize: number;
+    latencyMs: number;
+    name?: string;
+}
+/**
+ * Full metrics snapshot
+ */
+export interface MetricsSnapshot {
+    timestamp: number;
+    cpu: number;
+    memoryMB: number;
+    memoryPercent: number;
+    heapUsedMB: number;
+    heapTotalMB: number;
+    loadAvg: number;
+    uptime: number;
+    processUptime: number;
+    responseTime: number;
+    rps: number;
+    statusCodes: StatusCodeCount;
+    totalRequests: number;
+    activeConnections: number;
+    eventLoopLag: number;
+    hostname: string;
+    platform: string;
+    nodeVersion: string;
+    pid: number;
+    cpuCount: number;
+    percentiles: PercentileData;
+    topRoutes: RouteStats[];
+    slowestRoutes: RouteStats[];
+    errorRoutes: RouteStats[];
+    recentErrors: ErrorEntry[];
+    alerts: AlertStatus;
+    gc: GCStats;
+    database: DatabaseStats;
+    rateLimitStats: {
+        blocked: number;
+        total: number;
+    };
+    errorRate: number;
+}
+/**
+ * Chart data for all metrics
+ */
+export interface ChartData {
+    cpu: MetricDataPoint[];
+    memory: MetricDataPoint[];
+    heap: MetricDataPoint[];
+    loadAvg: MetricDataPoint[];
+    responseTime: MetricDataPoint[];
+    rps: MetricDataPoint[];
+    eventLoopLag: MetricDataPoint[];
+    errorRate: MetricDataPoint[];
+}
+/**
+ * Dashboard props
+ */
+export interface DashboardProps {
+    hostname: string;
+    uptime: string;
+    socketPath: string;
+    title: string;
+}
+/**
+ * Status monitor instance
+ */
+export interface StatusMonitor {
+    /** Hono middleware for tracking requests */
+    middleware: (c: any, next: () => Promise<void>) => Promise<void>;
+    /** Initialize socket.io server */
+    initSocket: (server: any) => SocketServer;
+    /** Get current metrics snapshot */
+    getMetrics: () => Promise<MetricsSnapshot>;
+    /** Get chart data */
+    getCharts: () => ChartData;
+    /** Start metrics collection */
+    start: () => void;
+    /** Stop metrics collection */
+    stop: () => void;
+    /** Track a rate limit event */
+    trackRateLimit: (blocked: boolean) => void;
+    /** Get dashboard HTML */
+    getDashboard: () => Promise<string>;
+    /** Configuration */
+    config: Required<StatusMonitorConfig>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,IAAI,YAAY,EAAE,MAAM,WAAW,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mDAAmD;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/C,yCAAyC;IACzC,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,GAAG,EAAE,OAAO,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,eAAe,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,cAAc,CAAC;IAC5B,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB,aAAa,EAAE,UAAU,EAAE,CAAC;IAC5B,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,YAAY,EAAE,UAAU,EAAE,CAAC;IAC3B,MAAM,EAAE,WAAW,CAAC;IACpB,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,aAAa,CAAC;IACxB,cAAc,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,GAAG,EAAE,eAAe,EAAE,CAAC;IACvB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,GAAG,EAAE,eAAe,EAAE,CAAC;IACvB,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,SAAS,EAAE,eAAe,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,4CAA4C;IAC5C,UAAU,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,kCAAkC;IAClC,UAAU,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,YAAY,CAAC;IAC1C,mCAAmC;IACnC,UAAU,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C,qBAAqB;IACrB,SAAS,EAAE,MAAM,SAAS,CAAC;IAC3B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,+BAA+B;IAC/B,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C,yBAAyB;IACzB,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,oBAAoB;IACpB,MAAM,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;CACzC"}

package/dist/types.js

@@ -0,0 +1,5 @@
+// =============================================================================
+// HONO STATUS MONITOR - TYPE DEFINITIONS
+// =============================================================================
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,yCAAyC;AACzC,gFAAgF"}

package/package.json

@@ -0,0 +1,57 @@
+{
+    "name": "hono-status-monitor",
+    "version": "1.0.0",
+    "description": "Real-time server monitoring dashboard for Hono.js with WebSocket updates. Express-status-monitor style metrics with Socket.io.",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "type": "module",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "prepublishOnly": "npm run build",
+        "clean": "rm -rf dist"
+    },
+    "keywords": [
+        "hono",
+        "status",
+        "monitor",
+        "dashboard",
+        "websocket",
+        "metrics",
+        "real-time",
+        "performance",
+        "cpu",
+        "memory",
+        "socket.io",
+        "express-status-monitor"
+    ],
+    "author": "Vinit Kumar Goel",
+    "email": "vinit928@gmail.com",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/vinitkumargoel/hono-status-monitor.git"
+    },
+    "homepage": "https://github.com/vinitkumargoel/hono-status-monitor#readme",
+    "bugs": {
+        "url": "https://github.com/vinitkumargoel/hono-status-monitor/issues"
+    },
+    "peerDependencies": {
+        "hono": ">=4.0.0",
+        "@hono/node-server": ">=1.0.0"
+    },
+    "dependencies": {
+        "socket.io": "^4.7.0"
+    },
+    "devDependencies": {
+        "@types/node": "^20.0.0",
+        "hono": "^4.6.0",
+        "@hono/node-server": "^1.19.0",
+        "typescript": "^5.3.0"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    }
+}