|
8 | 8 |
|
9 | 9 | Two independent tools in one package: |
10 | 10 |
|
11 | | -- **`argus` CLI** β 47 diagnostic commands that work on any running JVM via `jcmd`/`jstat` |
| 11 | +- **`argus` CLI** β 50 diagnostic commands that work on any running JVM via `jcmd`/`jstat` |
12 | 12 | - **Argus Agent** β Real-time web dashboard with JFR streaming, flame graphs, and metric export |
13 | 13 |
|
14 | 14 | ```bash |
@@ -77,9 +77,13 @@ Diagnose any running JVM process directly from the terminal. No agent, no instru |
77 | 77 | | `argus gclog <file>` | GC log analysis with pause distribution and tuning (GCEasy alternative) | |
78 | 78 | | `argus flame <pid>` | One-shot flame graph β profiles, generates HTML, opens browser | |
79 | 79 | | `argus suggest` | JVM flag optimization based on workload analysis | |
| 80 | +| `argus ci` | CI/CD health gate β exit codes + GitHub annotations | |
| 81 | +| `argus compare <pid1> <pid2>` | Side-by-side JVM comparison (live or baseline) | |
| 82 | +| `argus slowlog <pid>` | Real-time slow method detection via JFR streaming | |
80 | 83 | | **Monitoring** | | |
81 | 84 | | `argus top` | Real-time monitoring (agent required) | |
82 | | -| `argus watch` | Real-time terminal dashboard (htop for JVM) | |
| 85 | +| `argus watch <pid>` | Real-time terminal dashboard (htop for JVM) | |
| 86 | +| `argus tui [pid]` | Interactive terminal UI β browse all commands (k9s-style) | |
83 | 87 | | `argus init` | First-time setup (language selection) | |
84 | 88 |
|
85 | 89 | ### `argus report` β Comprehensive Diagnostic |
@@ -232,7 +236,7 @@ $ argus --lang=ko report 39113 |
232 | 236 | --version, -v Show version |
233 | 237 | ``` |
234 | 238 |
|
235 | | -> See [CLI Command Reference](docs/cli-commands.md) for all 47 commands with full output examples. |
| 239 | +> See [CLI Command Reference](docs/cli-commands.md) for all 50 commands with full output examples. |
236 | 240 |
|
237 | 241 | --- |
238 | 242 |
|
@@ -373,7 +377,7 @@ Argus adapts its capabilities based on the target JVM version at runtime: |
373 | 377 |
|
374 | 378 | | Feature | Java 11+ | Java 17+ | Java 21+ | |
375 | 379 | |---------|:--------:|:--------:|:--------:| |
376 | | -| CLI (47 commands) | β
| β
| β
| |
| 380 | +| CLI (50 commands) | β
| β
| β
| |
377 | 381 | | Dashboard & Web UI | β | β
| β
| |
378 | 382 | | GC Analysis | CLI only | β
MXBean | β
JFR | |
379 | 383 | | CPU Monitoring | CLI only | β
MXBean | β
JFR | |
@@ -431,10 +435,38 @@ rm -rf ~/.argus |
431 | 435 | | **argus-agent** | Java agent with JFR streaming engine | |
432 | 436 | | **argus-server** | Netty HTTP/WS server, 10 analyzers, Prometheus + OTLP | |
433 | 437 | | **argus-frontend** | Static dashboard with Chart.js and d3-flamegraph | |
434 | | -| **argus-cli** | 47 diagnostic commands, auto source detection, i18n | |
| 438 | +| **argus-cli** | 50 diagnostic commands, auto source detection, i18n | |
435 | 439 | | **argus-micrometer** | Micrometer MeterBinder exposing ~25 JVM metrics | |
436 | 440 | | **argus-spring-boot-starter** | Spring Boot 3.2+ auto-configuration for Argus agent | |
437 | 441 |
|
| 442 | +## Docker |
| 443 | + |
| 444 | +```bash |
| 445 | +docker run --pid=host ghcr.io/rlaope/argus ps |
| 446 | +docker run --pid=host ghcr.io/rlaope/argus doctor |
| 447 | +docker run --pid=host ghcr.io/rlaope/argus watch |
| 448 | +``` |
| 449 | + |
| 450 | +## CI/CD Integration |
| 451 | + |
| 452 | +Add JVM health checks to your GitHub Actions pipeline: |
| 453 | + |
| 454 | +```yaml |
| 455 | +- name: JVM Health Check |
| 456 | + uses: rlaope/Argus/action@master |
| 457 | + with: |
| 458 | + command: ci |
| 459 | + fail-on: critical |
| 460 | + format: github-annotations |
| 461 | +``` |
| 462 | +
|
| 463 | +Or use `argus ci` directly: |
| 464 | + |
| 465 | +```bash |
| 466 | +argus ci --pid=auto --fail-on=critical --format=summary |
| 467 | +# Exit code: 0=pass, 1=warnings, 2=critical |
| 468 | +``` |
| 469 | + |
438 | 470 | ## Spring Boot Integration |
439 | 471 |
|
440 | 472 | The `argus-spring-boot-starter` provides zero-configuration auto-setup for Spring Boot 3.2+ applications. |
|
0 commit comments