adonisjs-server-stats 1.3.0 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/adonisjs-server-stats)
|
|
4
4
|
[](https://www.npmjs.com/package/adonisjs-server-stats)
|
|
5
|
-
[](https://bundlephobia.com/package/adonisjs-server-stats)
|
|
6
5
|
[](https://github.com/simulieren/adonisjs-server-stats/blob/main/LICENSE)
|
|
7
6
|
[](https://www.typescriptlang.org/)
|
|
8
7
|
[](https://adonisjs.com/)
|
|
8
|
+
[](https://adonisjs.com/)
|
|
9
9
|
|
|
10
10
|
A Laravel Telescope-inspired dev toolbar and real-time server monitor for **AdonisJS v6**.
|
|
11
11
|
|
|
@@ -231,7 +231,8 @@ export default class ServerStatsController {
|
|
|
231
231
|
| `dashboard` | `boolean` | `false` | Enable the full-page dashboard (requires `better-sqlite3`) |
|
|
232
232
|
| `dashboardPath` | `string` | `'/__stats'` | URL path for the dashboard page |
|
|
233
233
|
| `retentionDays` | `number` | `7` | Days to keep historical data in SQLite |
|
|
234
|
-
| `dbPath` | `string` | `'
|
|
234
|
+
| `dbPath` | `string` | `'.adonisjs/server-stats/dashboard.sqlite3'` | Path to the SQLite database file (relative to app root) |
|
|
235
|
+
| `excludeFromTracing` | `string[]` | `[]` | URL prefixes to exclude from tracing and dashboard persistence. Requests still count toward HTTP metrics but won't appear in the timeline or be stored. The stats endpoint is always excluded automatically. |
|
|
235
236
|
| `panes` | `DebugPane[]` | -- | Custom debug panel tabs |
|
|
236
237
|
|
|
237
238
|
---
|
|
@@ -513,8 +514,11 @@ devToolbar: {
|
|
|
513
514
|
// Days to retain historical data (default: 7)
|
|
514
515
|
retentionDays: 7,
|
|
515
516
|
|
|
516
|
-
// SQLite database file path, relative to app root (default: '
|
|
517
|
-
dbPath: '
|
|
517
|
+
// SQLite database file path, relative to app root (default: '.adonisjs/server-stats/dashboard.sqlite3')
|
|
518
|
+
dbPath: '.adonisjs/server-stats/dashboard.sqlite3',
|
|
519
|
+
|
|
520
|
+
// URL prefixes to exclude from tracing and dashboard persistence (default: [])
|
|
521
|
+
excludeFromTracing: ['/admin/api/debug'],
|
|
518
522
|
|
|
519
523
|
// Enable tracing for per-request timeline in the dashboard (recommended)
|
|
520
524
|
tracing: true,
|
|
@@ -569,10 +573,10 @@ The dashboard uses a dedicated SQLite database (separate from your app's databas
|
|
|
569
573
|
- **Self-cleaning** -- old data is automatically purged based on `retentionDays`
|
|
570
574
|
- **WAL mode** -- concurrent reads don't block writes
|
|
571
575
|
|
|
572
|
-
The SQLite file is created at the configured `dbPath` (default:
|
|
576
|
+
The SQLite file is created at the configured `dbPath` (default: `.adonisjs/server-stats/dashboard.sqlite3`). Add it to your `.gitignore`:
|
|
573
577
|
|
|
574
578
|
```
|
|
575
|
-
|
|
579
|
+
.adonisjs/server-stats/
|
|
576
580
|
```
|
|
577
581
|
|
|
578
582
|
#### Theme Support
|