How anandrajjee981-max/tracesketch works
traceSketch is a local API debugging tool: Express middleware captures requests, a local collector stores traces, and the dashboard supports inspection, replay, and regression checks. The CLI can send endpoint requests, while a separate relay enables shared group sessions and archived history. The active implementation is under packages/tracesketch; the README identifies the split collector, SDK, and dashboard packages as deprecated. Some controller, storage, and dashboard details are unsampled, so edges rely on documented workflows where source excerpts do not show the call.
Main entry points: client.ts Dashboard API client · App.tsx Dashboard shell · TraceDetail.tsx Trace detail · index.ts Collector service
Components 26
Capture and storage
- Trace middleware
packages/tracesketch/src/sdk/middleware/Express.middleware.ts - Collector service
packages/tracesketch/src/collector/index.ts - Collector routes
packages/tracesketch/src/collector/routes - Trace handling
packages/tracesketch/src/collector/controller/Trace.ts - Trace events
packages/tracesketch/src/collector/controller/trace.Events.ts - Local trace storage
packages/tracesketch/src/collector/config/db.ts - Instance identity
packages/tracesketch/src/collector/service/instance.service.ts - Redaction and validation
packages/tracesketch/src/collector/utils/redact.ts
Trace workflows
- Trace browsing
packages/dashboard/src/pages/TracesList.tsx - Trace detail
packages/dashboard/src/pages/TraceDetail.tsx - Request replay
packages/tracesketch/src/collector/controller/replay.ts - Replay results
packages/dashboard/src/pages/ReplaysList.tsx - Regression checks
packages/tracesketch/src/collector/controller/regression.ts - Regression tests
packages/dashboard/src/pages/RegressionsList.tsx
Developer interface
- Dashboard shell
packages/dashboard/src/App.tsx - Dashboard API client
packages/dashboard/src/api/client.ts - Sketch CLI
packages/tracesketch/src/cli.ts - CLI request runner
packages/tracesketch/src/sketch-runner.ts
Shared sessions
- Relay dashboard
packages/dashboard/src/pages/Relay.tsx - Relay archiver
packages/tracesketch/src/collector/relay-archiver.ts - Group history
packages/tracesketch/src/collector/controller/Group.controller.ts - Group data access
packages/tracesketch/src/collector/dao/Group.ts - Relay service
packages/relay/src/index.ts
Other components
- API developer
- Express application
- Replay target API
Connections 31
- API developer → Express application: sends requests
README.md - Express application → Trace middleware: passes requests
README.md - Trace middleware → Collector service: submits captures
README.md - Collector service → Collector routes: registers routes
- Collector routes → Trace handling: routes traces
- Collector routes → Trace events: routes events
- Trace handling → Local trace storage: stores traces
- Trace events → Local trace storage: stores events
- Instance identity → Local trace storage: persists identity
packages/tracesketch/src/collector/service/instance.service.ts - Collector service → Redaction and validation: redacts data
- API developer → Dashboard shell: inspects traces
README.md - Dashboard shell → Trace browsing: routes to
packages/dashboard/src/App.tsx - Dashboard shell → Trace detail: routes to
packages/dashboard/src/App.tsx - Dashboard shell → Replay results: routes to
packages/dashboard/src/App.tsx - Dashboard shell → Regression tests: routes to
packages/dashboard/src/App.tsx - Trace browsing → Dashboard API client: loads traces
- Trace detail → Dashboard API client: loads details
- Dashboard API client → Collector service: calls collector
packages/dashboard/src/api/client.ts - Trace detail → Request replay: starts replay
README.md - Request replay → Replay target API: replays request
README.md - Replay results → Dashboard API client: loads results
- Trace detail → Regression checks: saves check
README.md - Regression tests → Dashboard API client: runs checks
- Sketch CLI → CLI request runner: dispatches request
- CLI request runner → Replay target API: sends request
README.md - Relay dashboard → Relay service: uses sessions
- Relay dashboard → Dashboard API client: loads relay data
packages/dashboard/src/api/client.ts - Relay archiver → Relay service: observes groups
- Relay archiver → Group history: archives entries
packages/tracesketch/src/collector/controller/Group.controller.ts - Group history → Group data access: reads and writes
packages/tracesketch/src/collector/controller/Group.controller.ts - Dashboard API client → Group history: mirrors group data
packages/dashboard/src/api/client.ts