adonisjs-server-stats 1.0.8 → 1.0.10

package/README.md

@@ -118,16 +118,39 @@ import {
 } from 'adonisjs-server-stats/collectors'
 
 export default defineConfig({
+  // How often to collect and broadcast stats (in milliseconds)
   intervalMs: 3000,
+
+  // Real-time transport: 'transmit' for SSE via @adonisjs/transmit, 'none' for polling only
   transport: 'transmit',
+
+  // Transmit channel name clients subscribe to
   channelName: 'admin/server-stats',
+
+  // HTTP endpoint that serves the latest stats snapshot (set to false to disable)
   endpoint: '/admin/api/server-stats',
+
   collectors: [
+    // CPU usage, event loop lag, heap/RSS memory, uptime, Node.js version
     processCollector(),
+
+    // OS load averages, total/free system memory, system uptime
     systemCollector(),
+
+    // Requests/sec, avg response time, error rate, active connections
+    // maxRecords: size of the circular buffer for request tracking
     httpCollector({ maxRecords: 10_000 }),
+
+    // Lucid connection pool: used/free/pending/max connections
+    // Requires @adonisjs/lucid
     dbPoolCollector({ connectionName: 'postgres' }),
+
+    // Redis server stats: memory, connected clients, keys, hit rate
+    // Requires @adonisjs/redis
     redisCollector(),
+
+    // BullMQ queue stats: active/waiting/delayed/failed jobs
+    // Requires bullmq -- connects directly to Redis (not via @adonisjs/redis)
     queueCollector({
       queueName: 'default',
       connection: {
@@ -136,7 +159,12 @@ export default defineConfig({
         password: env.get('QUEUE_REDIS_PASSWORD'),
       },
     }),
+
+    // Log file stats: errors/warnings in a 5-minute window, entries/minute
     logCollector({ logPath: 'logs/adonisjs.log' }),
+
+    // App-level metrics: online users, pending webhooks, pending emails
+    // Requires @adonisjs/lucid
     appCollector(),
   ],
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adonisjs-server-stats",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "Real-time server monitoring for AdonisJS v6 applications",
   "type": "module",
   "main": "./dist/src/index.js",
@@ -65,7 +65,6 @@
   },
   "files": [
     "dist",
-    "screenshots",
     "README.md",
     "LICENSE"
   ],