@platformatic/watt-admin 0.6.0-alpha.8 → 0.6.0-alpha.9

package/README.md

@@ -1,72 +1,200 @@
-# watt-admin
+# 🔌 Watt Admin
 
-## CLI Tool
+**Real-time monitoring and administration for your Platformatic applications**
 
-The project includes a command-line interface tool to check available Platformatic runtimes.
+Watt Admin is an open-source developer monitoring tool that provides instant visibility into your Node.js services. Monitor performance, analyze logs, and troubleshoot issues—all from a single, intuitive dashboard.
+
+![Watt Admin Dashboard](https://blog.platformatic.dev/content/images/2025/01/CleanShot-2025-01-15-at-15.50.54@2x.png)
+
+## ✨ Features
+
+### 📊 **Performance Metrics**
+- **Memory tracking**: RSS, heap usage, new/old space allocation with interactive charts
+- **CPU monitoring**: Real-time CPU and event loop utilization
+- **Latency analysis**: P90, P95, P99 percentiles at a glance
+- **Request rates**: Monitor requests per second across all services
+
+### 📝 **Centralized Logging**
+- View logs from all services in one place
+- Filter by service or log level
+- Toggle between formatted and raw JSON views
+- Export logs for further analysis
+
+### 🎯 **Service Management**
+- Monitor service status at a glance
+- Drill down into individual service metrics
+- Compare performance across services
+- Restart services directly from the dashboard
+
+### 🔥 **Profiling & Recording** *(New!)*
+- **CPU profiling**: Capture flame graphs to identify performance bottlenecks
+- **Heap profiling**: Analyze memory allocation patterns
+- **Offline analysis**: Generate self-contained HTML bundles for sharing and review
+- **Recording mode**: Capture metrics and profiles over time for post-mortem analysis
+
+## 🚀 Quick Start
+
+### Using npx (Recommended)
+
+Launch Watt Admin with a single command:
+
+```bash
+npx wattpm admin
+```
+
+The dashboard will automatically discover your running Platformatic runtimes and open at `http://localhost:4042`.
 
 ### Installation
 
-After installing the project dependencies, you can run the tool directly:
+Install globally for convenient access:
 
 ```bash
-./cli.js
+npm install -g @platformatic/watt-admin
 ```
 
-To run the CLI on a custom port, you can just pass it as an argument with `./cli.js --port 4321`.
+Then run:
 
-To record a flamegraph session, and choose to profile either the `cpu` or the `heap`, you can run the CLI with `./cli.js --record --profile heap`. Once you will stop the process, an HTML one-file bundle will be auto-generated, and you will be able to navigate (even offline) the `watt-admin` app, looking at the flamegraph and at the metrics stored for the whole time you have run the CLI.
+```bash
+watt-admin
+```
 
-The tool is also available as a binary when installed globally or linked:
+## 💡 Usage
+
+### Basic Usage
+
+When you run `watt-admin`, it automatically discovers all available Platformatic runtimes:
 
 ```bash
-npm link  # Link the package locally
-watt-runtime  # Run the command
+$ watt-admin
+Select a runtime: (Use arrow keys)
+❯ my-app (PID: 12345) (Started at 3/10/2025, 10:00:00 AM)
+  api-service (PID: 54321) (Started at 3/10/2025, 9:30:00 AM)
 ```
 
-### Usage
+If only one runtime is running, it will be selected automatically.
+
+### Custom Port
 
-The tool automatically discovers all available Platformatic runtimes. If multiple runtimes are found, it will prompt you to select one using an interactive menu.
+Run Watt Admin on a different port:
 
+```bash
+watt-admin --port 4321
 ```
-$ watt-runtime
-Select a runtime: (Use arrow keys)
-❯ runtime-name (PID: 12345) (Started at 3/10/2025, 10:00:00 AM)
-  another-runtime (PID: 54321) (Started at 3/10/2025, 9:30:00 AM)
+
+### Recording Mode
+
+Capture metrics and profiling data for offline analysis:
+
+```bash
+# Profile CPU usage
+watt-admin --record --profile cpu
+
+# Profile heap allocation
+watt-admin --record --profile heap
 ```
 
-If only one runtime is available, it will be automatically selected.
+When recording, press `Ctrl+C` to stop. Watt Admin will:
+1. Collect all metrics and profiling data
+2. Generate a self-contained HTML bundle
+3. Automatically open the bundle in your browser
+
+The generated HTML file contains everything you need for offline analysis—perfect for sharing with your team or reviewing later.
+
+## 🏗️ Development
+
+### Prerequisites
 
-## Project setup
+- Node.js 18 or higher
+- A running Platformatic runtime to monitor
 
+### Setup
+
+```bash
+git clone https://github.com/platformatic/watt-admin.git
+cd watt-admin
+npm install
+cp .env.sample .env
 ```
-npm install && cp .env.sample .env
+
+### Development Mode
+
+Auto-reload both backend and frontend on changes:
+
+```bash
+npm run dev
 ```
 
 ### Build
 
-```
+```bash
 npm run build
 ```
 
-### Start
+### Run Tests
 
-```
-npm run start
+```bash
+# Run all tests
+npm test
+
+# Run specific test suites
+npm run test:cli        # CLI tests
+npm run test:backend    # Backend tests
+npm run test:frontend   # Frontend tests
+npm run test:e2e        # End-to-end tests
 ```
 
-### Dev Mode
-
-This will auto-reload both the backend and frontend when changes are made.
+### Project Structure
 
 ```
-npm run dev
+watt-admin/
+├── cli.js              # CLI entry point
+├── lib/                # Core CLI functionality
+├── web/
+│   ├── backend/        # Fastify API server
+│   ├── frontend/       # React dashboard
+│   └── composer/       # Platformatic Gateway
+├── watt.json           # Wattpm configuration
+└── test/               # Test suites
 ```
 
-### Navigate the app
+## 🎯 Use Cases
+
+### Development Workflow
+Monitor your application while developing locally. Instantly see the impact of code changes on performance.
+
+### Debugging Performance Issues
+Use CPU and heap profiling to identify bottlenecks and memory leaks before they reach production.
+
+### Team Collaboration
+Generate offline HTML bundles to share performance data and profiling results with your team.
+
+### Learning and Optimization
+Understand how your services behave under load and optimize based on real data.
+
+## 🔗 Related Tools
+
+For production monitoring and observability, check out [Platformatic Console](https://platformatic.dev/console)—the intelligent command center for Platformatic Cloud deployments.
+
+## 📚 Documentation
+
+- [Platformatic Documentation](https://docs.platformatic.dev)
+- [Watt Admin Blog Post](https://blog.platformatic.dev/introducing-watt-admin)
+- [Platformatic Wattpm](https://docs.platformatic.dev/docs/guides/wattpm)
+
+## 🤝 Contributing
+
+Contributions are welcome! Please check out our [contributing guidelines](CONTRIBUTING.md) to get started.
+
+## 📄 License
+
+Apache-2.0 License - see [LICENSE](LICENSE) for details.
+
+## 🙋 Support
+
+- [GitHub Issues](https://github.com/platformatic/watt-admin/issues)
+- [Discord Community](https://discord.gg/platformatic)
+- [Twitter](https://twitter.com/platformatic)
+
+---
 
-0. check you started `watt-admin`
-1. you should now see an info log like `Platformatic is now listening at http://127.0.0.1:{PORT}` (open the local URL)
-2. click on link above to navigate the frontend app
-3. you can call the backend by prefixing the local URL with `/api`
-4. call the `/api/runtimes` endpoint (you should receive the PID)
-5. call the `/api/runtimes/{pid}/metrics` endpoint
+Built with ❤️ by the [Platformatic](https://platformatic.dev) team

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@platformatic/watt-admin",
-  "version": "0.6.0-alpha.8",
+  "version": "0.6.0-alpha.9",
   "scripts": {
     "prepublishOnly": "npm run clean && npm run build",
     "dev": "wattpm dev",
@@ -9,12 +9,12 @@
     "start": "wattpm start",
     "typecheck": "cd web/backend && tsc && cd ../frontend && tsc",
     "client:openapi": "cd web/backend && node --experimental-strip-types utils/client.openapi.ts",
-    "client:generate": "./node_modules/.bin/massimo ./web/backend/openapi.json --name backend --folder web/frontend/src/client --language ts --frontend --full --skip-config-update --props-optional",
+    "client:generate": "massimo ./web/backend/openapi.json --name backend --folder web/frontend/src/client --language ts --frontend --full --skip-config-update --props-optional",
     "test": "npm run test:cli && npm run test:e2e && npm run test:backend && npm run test:frontend",
     "test:cli": "node --test --experimental-test-module-mocks --test-timeout 60000 test/*.test.ts",
     "test:backend": "node --test --experimental-test-module-mocks --test-timeout 60000 --test-concurrency 1 web/backend/**/*.test.ts",
     "test:frontend": "cd web/frontend && vitest run",
-    "pretest:e2e": "./node_modules/.bin/playwright install chromium",
+    "pretest:e2e": "playwright install chromium",
     "test:e2e": "cd web/frontend && playwright test",
     "test:e2e:ui": "npm run test:e2e -- --ui",
     "clean": "rm -rf ./web/*/dist ./playwright-report ./test-results",
@@ -24,7 +24,7 @@
   "dependencies": {
     "@fastify/websocket": "^11.2.0",
     "@fastify/type-provider-json-schema-to-ts": "^5.0.0",
-    "@inquirer/prompts": "^7.8.6",
+    "@inquirer/prompts": "^8.0.0",
     "@platformatic/control": "^3.15.0",
     "@platformatic/gateway": "^3.15.0",
     "@platformatic/runtime": "^3.15.0",
@@ -72,6 +72,6 @@
     "vitest": "^3.2.4"
   },
   "bin": {
-    "watt-admin": "./cli.js"
+    "watt-admin": "cli.js"
   }
 }