Skip to content

Commit 58f3fc8

Browse files
authored
Merge pull request #100 from rlaope/docs/final-overhaul
docs: final overhaul β€” 50 commands, Docker, CI/CD
2 parents 575ea84 + 66aadce commit 58f3fc8

File tree

4 files changed

+45
-13
lines changed

4 files changed

+45
-13
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
99
Two independent tools in one package:
1010

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`
1212
- **Argus Agent** β€” Real-time web dashboard with JFR streaming, flame graphs, and metric export
1313

1414
```bash
@@ -77,9 +77,13 @@ Diagnose any running JVM process directly from the terminal. No agent, no instru
7777
| `argus gclog <file>` | GC log analysis with pause distribution and tuning (GCEasy alternative) |
7878
| `argus flame <pid>` | One-shot flame graph β€” profiles, generates HTML, opens browser |
7979
| `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 |
8083
| **Monitoring** | |
8184
| `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) |
8387
| `argus init` | First-time setup (language selection) |
8488

8589
### `argus report` β€” Comprehensive Diagnostic
@@ -232,7 +236,7 @@ $ argus --lang=ko report 39113
232236
--version, -v Show version
233237
```
234238

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.
236240
237241
---
238242

@@ -373,7 +377,7 @@ Argus adapts its capabilities based on the target JVM version at runtime:
373377

374378
| Feature | Java 11+ | Java 17+ | Java 21+ |
375379
|---------|:--------:|:--------:|:--------:|
376-
| CLI (47 commands) | βœ… | βœ… | βœ… |
380+
| CLI (50 commands) | βœ… | βœ… | βœ… |
377381
| Dashboard & Web UI | β€” | βœ… | βœ… |
378382
| GC Analysis | CLI only | βœ… MXBean | βœ… JFR |
379383
| CPU Monitoring | CLI only | βœ… MXBean | βœ… JFR |
@@ -431,10 +435,38 @@ rm -rf ~/.argus
431435
| **argus-agent** | Java agent with JFR streaming engine |
432436
| **argus-server** | Netty HTTP/WS server, 10 analyzers, Prometheus + OTLP |
433437
| **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 |
435439
| **argus-micrometer** | Micrometer MeterBinder exposing ~25 JVM metrics |
436440
| **argus-spring-boot-starter** | Spring Boot 3.2+ auto-configuration for Argus agent |
437441

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+
438470
## Spring Boot Integration
439471

440472
The `argus-spring-boot-starter` provides zero-configuration auto-setup for Spring Boot 3.2+ applications.

β€Ždocs/README.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Welcome to the Project Argus documentation.
66

77
1. [Getting Started](getting-started.md) - Installation and quick start guide
88
2. [Usage Guide](usage.md) - CLI and Agent dashboard usage
9-
3. [CLI Command Reference](cli-commands.md) - All 47 commands with usage and output examples
9+
3. [CLI Command Reference](cli-commands.md) - All 50 commands with usage and output examples
1010
4. [Configuration](configuration.md) - Configuration options and tuning
1111
5. [Architecture](architecture.md) - System architecture and design
1212
6. [Troubleshooting](troubleshooting.md) - Common issues and solutions

β€Ždocs/cli-commands.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Argus CLI Command Reference
22

3-
Complete reference for all 47 Argus CLI commands with usage examples and actual output.
3+
Complete reference for all 50 Argus CLI commands with usage examples and actual output.
44

55
## Global Options
66

β€Žsite/index.htmlβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -629,14 +629,14 @@ <h1>Argus JVM Observability Platform</h1>
629629
<span class="badge green">Java 11+ CLI</span>
630630
<span class="badge green">Java 17+ Dashboard</span>
631631
<span class="badge green">Java 21+ Full Features</span>
632-
<span class="badge">47 Commands</span>
632+
<span class="badge">50 Commands</span>
633633
<span class="badge">Zero Dependencies</span>
634634
</div>
635635
</div>
636636

637637
<p>Argus gives you two tools for JVM diagnostics:</p>
638638
<ul>
639-
<li><strong>Argus CLI</strong> β€” 47 diagnostic commands that work on any running JVM. No agent, no restart, no configuration. Point at a PID and get answers in seconds.</li>
639+
<li><strong>Argus CLI</strong> β€” 50 diagnostic commands that work on any running JVM. No agent, no restart, no configuration. Point at a PID and get answers in seconds.</li>
640640
<li><strong>Argus Agent</strong> β€” Attach as a Java agent and get a live web dashboard with GC timelines, CPU graphs, heap usage, flame graphs, and thread analysis, all streaming in real time.</li>
641641
</ul>
642642

@@ -659,7 +659,7 @@ <h2>Why Argus?</h2>
659659
<div class="feature-grid">
660660
<div class="feature-card">
661661
<h4>Instant CLI Diagnostics</h4>
662-
<p>47 commands that work on any running JVM. No agent, no restart, no configuration. Just point at a PID and get answers in seconds.</p>
662+
<p>50 commands that work on any running JVM. No agent, no restart, no configuration. Just point at a PID and get answers in seconds.</p>
663663
</div>
664664
<div class="feature-card">
665665
<h4>Real-time Dashboard</h4>
@@ -725,7 +725,7 @@ <h3>Your First Diagnosis</h3>
725725
<p class="video-caption">Argus CLI in action β€” diagnosing a running JVM process</p>
726726

727727
<span class="section-anchor" id="command-reference"></span>
728-
<h3>All 47 Commands</h3>
728+
<h3>All 50 Commands</h3>
729729

730730
<p>Every command follows the same pattern: <code>argus &lt;command&gt; &lt;pid&gt;</code>. All commands support <code>--format=json</code> for scripting and <code>--source=auto|agent|jdk</code> to control the data source.</p>
731731

@@ -912,7 +912,7 @@ <h2>Java Version Compatibility</h2>
912912
<tr><th>Feature</th><th>Java 11+</th><th>Java 17+</th><th>Java 21+</th></tr>
913913
</thead>
914914
<tbody>
915-
<tr><td>CLI (47 commands)</td><td>Yes</td><td>Yes</td><td>Yes</td></tr>
915+
<tr><td>CLI (50 commands)</td><td>Yes</td><td>Yes</td><td>Yes</td></tr>
916916
<tr><td>Dashboard &amp; Web UI</td><td>β€”</td><td>Yes (MXBean)</td><td>Yes (JFR)</td></tr>
917917
<tr><td>GC / CPU / Memory</td><td>CLI only</td><td>Yes</td><td>Yes</td></tr>
918918
<tr><td>Allocation Tracking</td><td>β€”</td><td>β€”</td><td>Yes</td></tr>
@@ -947,7 +947,7 @@ <h2>Architecture</h2>
947947
<tr><td><code>argus-agent</code></td><td>Java agent entry point, JFR streaming engine, MXBean polling engine</td></tr>
948948
<tr><td><code>argus-server</code></td><td>Netty HTTP/WebSocket server, 10 analyzers, metrics export</td></tr>
949949
<tr><td><code>argus-frontend</code></td><td>Dashboard web UI (vanilla JS, Chart.js, D3 flame graph)</td></tr>
950-
<tr><td><code>argus-cli</code></td><td>47 diagnostic commands using jcmd/jstat</td></tr>
950+
<tr><td><code>argus-cli</code></td><td>50 diagnostic commands using jcmd/jstat</td></tr>
951951
<tr><td><code>argus-micrometer</code></td><td>Framework-agnostic Micrometer MeterBinder</td></tr>
952952
<tr><td><code>argus-spring-boot-starter</code></td><td>Spring Boot auto-configuration</td></tr>
953953
</tbody>

0 commit comments

Comments
Β (0)