adonisjs-server-stats 1.0.4 → 1.0.7

package/README.md

@@ -13,7 +13,7 @@ Drop a single Edge tag into your layout and get a live stats bar showing CPU, me
 
 Zero frontend dependencies. Zero build step. Just `@serverStats()` and go.
 
-![adonisjs-server-stats](https://raw.githubusercontent.com/simulieren/adonisjs-server-stats/main/screenshots/hero.png)
+<video src="https://github.com/simulieren/adonisjs-server-stats/raw/main/screenshots/adonisjs-server-stats.mp4" controls muted loop width="100%"></video>
 
 ## Screenshots
 
@@ -89,6 +89,23 @@ server.use([
 ```ts
 // config/server_stats.ts
 import { defineConfig } from 'adonisjs-server-stats'
+import { processCollector, systemCollector, httpCollector } from 'adonisjs-server-stats/collectors'
+
+export default defineConfig({
+  collectors: [
+    processCollector(),
+    systemCollector(),
+    httpCollector(),
+  ],
+})
+```
+
+That's it -- this gives you CPU, memory, event loop lag, and HTTP throughput out of the box. All other options have sensible defaults. Add more collectors as needed:
+
+```ts
+// config/server_stats.ts
+import env from '#start/env'
+import { defineConfig } from 'adonisjs-server-stats'
 import {
   processCollector,
   systemCollector,
@@ -99,14 +116,12 @@ import {
   logCollector,
   appCollector,
 } from 'adonisjs-server-stats/collectors'
-import env from '#start/env'
 
 export default defineConfig({
   intervalMs: 3000,
   transport: 'transmit',
   channelName: 'admin/server-stats',
   endpoint: '/admin/api/server-stats',
-  shouldShow: (ctx) => !!ctx.auth?.user?.isAdmin,
   collectors: [
     processCollector(),
     systemCollector(),
@@ -133,7 +148,7 @@ export default defineConfig({
 // start/routes.ts
 router
   .get('/admin/api/server-stats', '#controllers/admin/server_stats_controller.index')
-  .use(middleware.superadmin())
+  .use(middleware.superadmin()) // Replace with your own middleware
 ```
 
 ### 5. Create the controller
@@ -278,23 +293,35 @@ interface MetricCollector {
 
 ## Visibility Control (`shouldShow`)
 
-Control who sees the stats bar via the `shouldShow` config callback. It receives the AdonisJS `HttpContext` and returns `true` to render.
+By default the stats bar renders for every request. Use `shouldShow` to restrict it. The callback receives the AdonisJS `HttpContext` and should return `true` to show the bar, `false` to hide it.
+
+Because `shouldShow` runs **after** middleware (including auth), you have full access to `ctx.auth`.
 
 ```ts
 export default defineConfig({
-  // Only admin users
-  shouldShow: (ctx) => !!ctx.auth?.user?.isAdmin,
+  // Only show in development
+  shouldShow: () => env.get('NODE_ENV'),
+})
+```
 
-  // Only in development
-  shouldShow: () => process.env.NODE_ENV === 'development',
+```ts
+export default defineConfig({
+  // Only show for logged-in admin users
+  shouldShow: (ctx) => ctx.auth?.user?.isAdmin === true,
+})
+```
 
-  // Multiple roles
-  shouldShow: (ctx) =>
-    ctx.auth?.user?.role === 'admin' || ctx.auth?.user?.role === 'superadmin',
+```ts
+export default defineConfig({
+  // Only show for specific roles
+  shouldShow: (ctx) => {
+    const role = ctx.auth?.user?.role
+    return role === 'admin' || role === 'superadmin'
+  },
 })
 ```
 
-When `shouldShow` is not set, the stats bar always renders.
+> **Tip:** When `shouldShow` is not set, the bar renders for everyone. In production you almost always want to set this.
 
 ---
 

package/dist/src/debug/event_collector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event_collector.d.ts","sourceRoot":"","sources":["../../../src/debug/event_collector.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAA0B;IACxC,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,OAAO,CAAa;gBAEhB,SAAS,GAAE,MAAY;IAInC,KAAK,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAuBzB,IAAI,IAAI,IAAI;IAQZ,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,YAAY;IAapB,SAAS,IAAI,WAAW,EAAE;IAI1B,SAAS,CAAC,CAAC,GAAE,MAAY,GAAG,WAAW,EAAE;IAIzC,aAAa,IAAI,MAAM;IAIvB,KAAK,IAAI,IAAI;CAGd"}
+{"version":3,"file":"event_collector.d.ts","sourceRoot":"","sources":["../../../src/debug/event_collector.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAA0B;IACxC,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,OAAO,CAAa;gBAEhB,SAAS,GAAE,MAAY;IAInC,KAAK,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IA0BzB,IAAI,IAAI,IAAI;IAQZ,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,YAAY;IAapB,SAAS,IAAI,WAAW,EAAE;IAI1B,SAAS,CAAC,CAAC,GAAE,MAAY,GAAG,WAAW,EAAE;IAIzC,aAAa,IAAI,MAAM;IAIvB,KAAK,IAAI,IAAI;CAGd"}

package/dist/src/debug/event_collector.js

@@ -17,11 +17,13 @@ export class EventCollector {
         this.originalEmit = emitter.emit.bind(emitter);
         const self = this;
         emitter.emit = function (event, data) {
+            // Resolve event name: class-based events use the class name, string events are used as-is
+            const eventName = typeof event === "string" ? event : event?.name || "unknown";
             // Skip internal/noisy events
-            if (!event.startsWith("__") && event !== "db:query") {
+            if (!eventName.startsWith("__") && eventName !== "db:query") {
                 const record = {
                     id: self.buffer.getNextId(),
-                    event,
+                    event: eventName,
                     data: self.summarizeData(data),
                     timestamp: Date.now(),
                 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adonisjs-server-stats",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "description": "Real-time server monitoring for AdonisJS v6 applications",
   "type": "module",
   "main": "./dist/src/index.js",