server-devtools 0.1.3 → 0.1.4

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.
Files changed (2) hide show
  1. package/README.md +29 -39
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  **Chrome DevTools for your backend.**
4
4
 
5
5
  ServerDevTools is an embeddable backend inspector for Node.js
6
- applications.
6
+ applications: **Chrome DevTools for your Node.js backend.**
7
7
 
8
8
  It gives you a live dashboard for inspecting:
9
9
 
@@ -16,6 +16,9 @@ It gives you a live dashboard for inspecting:
16
16
  - database operations
17
17
  - errors
18
18
  - timing
19
+ - current/authenticated user context
20
+ - server-side request search
21
+ - request filtering by HTTP method and status
19
22
 
20
23
  Instead of jumping between logs, traces, and multiple observability
21
24
  tools, ServerDevTools lets you inspect what your backend is doing from
@@ -83,6 +86,9 @@ full production observability platforms.
83
86
  npm install server-devtools
84
87
  ```
85
88
 
89
+ ServerDevTools includes the supported OpenTelemetry instrumentation libraries;
90
+ you do not need to install the database instrumentation packages separately.
91
+
86
92
  ------------------------------------------------------------------------
87
93
 
88
94
  ## Quick Start
@@ -440,16 +446,27 @@ http://localhost:3000
440
446
 
441
447
  ## Current Support
442
448
 
443
- Initial support focuses on Node.js applications:
449
+ ServerDevTools currently supports:
444
450
 
445
- - Node.js HTTP
451
+ - Node.js
446
452
  - Express
447
453
  - NestJS middleware and error interception
448
- - MongoDB operations
454
+ - MongoDB
455
+ - PostgreSQL through `pg`
456
+ - MySQL through `mysql2`
449
457
  - native HTTP/HTTPS and fetch/Undici requests, including headers and bodies
458
+ - request search and filtering by HTTP method and status
459
+ - current/authenticated user context when supplied by the application
450
460
  - OpenTelemetry-powered activity capture
451
461
 
452
- Support will expand as the project develops.
462
+ ### Database tracing
463
+
464
+ Supported database operations automatically appear inside the request
465
+ execution trace when using these supported drivers:
466
+
467
+ - MongoDB
468
+ - PostgreSQL (`pg`)
469
+ - MySQL (`mysql2`)
453
470
 
454
471
  ------------------------------------------------------------------------
455
472
 
@@ -486,40 +503,13 @@ Expect APIs and configuration to evolve before `1.0`.
486
503
 
487
504
  ------------------------------------------------------------------------
488
505
 
489
- ## Roadmap
490
-
491
- Near-term:
492
-
493
- - [x] HTTP request capture
494
- - [x] Request headers
495
- - [x] Query parameters
496
- - [x] Route parameters
497
- - [x] Request body
498
- - [x] HTTP response status
499
- - [x] Response headers
500
- - [x] Response body
501
- - [x] Execution tree
502
- - [x] Native HTTP/HTTPS and fetch/Undici inspection
503
- - [x] MongoDB inspection
504
- - [x] Error inspection
505
- - [x] NestJS integration and error interception
506
- - [x] Encryption at rest for selected fields
507
- - [ ] Request/response redaction
508
- - [ ] Body-size limits
509
- - [ ] Production-safe configuration
510
- - [ ] Broader NestJS compatibility
511
- - [x] Static dashboard packaging
512
-
513
- Future ideas:
514
-
515
- - Redis
516
- - PostgreSQL
517
- - MySQL
518
- - additional Node frameworks
519
- - trace filtering
520
- - request search
521
- - configurable retention
522
- - multi-instance support
506
+ ## Coming next
507
+
508
+ Planned, not yet available:
509
+
510
+ - Redis visibility
511
+ - Configurable trace storage, including storing ServerDevTools data through
512
+ user-configured storage instead of only the default local SQLite storage
523
513
 
524
514
  ------------------------------------------------------------------------
525
515
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "server-devtools",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Chrome DevTools for your backend. Inspect HTTP requests, database operations, outbound calls, errors, and execution timing from an embedded dashboard.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Godwin Ehikhamhen",