adonisjs-server-stats 1.0.3 → 1.0.5

package/README.md

@@ -1,5 +1,12 @@
 # adonisjs-server-stats
 
+[![npm version](https://img.shields.io/npm/v/adonisjs-server-stats.svg)](https://www.npmjs.com/package/adonisjs-server-stats)
+[![npm downloads](https://img.shields.io/npm/dm/adonisjs-server-stats.svg)](https://www.npmjs.com/package/adonisjs-server-stats)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/adonisjs-server-stats)](https://bundlephobia.com/package/adonisjs-server-stats)
+[![license](https://img.shields.io/npm/l/adonisjs-server-stats.svg)](https://github.com/simulieren/adonisjs-server-stats/blob/main/LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.9+-blue.svg)](https://www.typescriptlang.org/)
+[![AdonisJS](https://img.shields.io/badge/AdonisJS-v6-5A45FF.svg)](https://adonisjs.com/)
+
 A Laravel Telescope-inspired dev toolbar and real-time server monitor for **AdonisJS v6**.
 
 Drop a single Edge tag into your layout and get a live stats bar showing CPU, memory, requests/sec, database pool, Redis, queues, and logs -- plus a full debug toolbar with SQL query inspection, event tracing, route listing, live log tailing, and custom panels.
@@ -82,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,
@@ -92,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(),
@@ -126,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
@@ -271,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/package.json

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