go-duck-cli 1.3.372 → 1.4.6

package/templates/docs/pages/observability.hbs

@@ -32,3 +32,58 @@ go-duck:
     <h3 class="font-semibold mb-2 mt-6">3. System Infrastructure Metrics (Statsd)</h3>
     <p class="mb-4 text-gray-700">The <code>logger</code> package has a sidecar implementation for Datadog's <code>statsd</code>. A developer can quickly drop custom <code>logger.Count("api.hit")</code> or <code>logger.Histogram("db.latency")</code> functions into their services to populate dashboard charts.</p>
 </section>
+
+<section class="mb-10">
+    <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">4. Prometheus & Kubernetes Autoscaling (HPA)</h2>
+    <p class="mb-4">For Kubernetes environments, the generated microservices automatically expose a standard <code>GET /metrics</code> Prometheus scraping endpoint powered by <code>github.com/prometheus/client_golang</code>. This allows the Kubernetes Metrics Server or Prometheus Adapter to constantly poll your API and scale up your Pod Replicas horizontally when traffic increases.</p>
+</section>
+
+<section class="mb-10">
+    <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">5. Real-Time System Streams (SSE)</h2>
+    <p class="mb-4">Need to see exactly how much your server is "holding up" in real time without refreshing a dashboard? GO-DUCK injects a Server-Sent Events (SSE) streaming endpoint at <code>GET /api/system/stream</code>.</p>
+    <p class="mb-4">Powered by <code>github.com/shirou/gopsutil</code>, this endpoint streams live JSON payloads directly to your browser containing CPU utilization, Memory consumption, and an aggregated Load Percentage metric at a configurable interval (defaults to 1 second).</p>
+    
+    <pre><code class="language-json">{
+  "timestamp": "2026-05-28T19:30:01Z",
+  "cpu_percent": 45.2,
+  "mem_percent": 68.4,
+  "mem_used_mb": 1024,
+  "mem_total_mb": 4096,
+  "load_percentage": 56.8
+}</code></pre>
+</section>
+
+<section class="mb-10">
+    <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">6. Full JHipster-Style System Metrics JSON</h2>
+    <p class="mb-4">For developers who prefer a deep dive into the JVM-style metrics (Go equivalents), a massive, rich telemetry JSON payload is natively exposed at <code>GET /api/system/metrics</code>.</p>
+    <p class="mb-4">This endpoint acts identically to the classic JHipster <code>/management/jhimetrics</code> endpoint, and will output:</p>
+    <ul class="list-disc pl-6 mb-4 text-gray-700">
+        <li><strong>System/Go Stats:</strong> Process Uptime, GC Pauses, Goroutine counts, Heap allocations, and Open Files.</li>
+        <li><strong>HTTP Tracking Middleware:</strong> Live request counts, mean execution times, and max execution times grouped by both HTTP Status Codes and specific API Endpoints.</li>
+    </ul>
+
+    <pre><code class="language-json">{
+  "system": {
+    "uptime": "10 days 4 hours 7 minutes 35 seconds",
+    "process_cpu_usage": 1.76,
+    "system_cpu_usage": 1.76,
+    "process_files_open": 359,
+    "heap_alloc_mb": 104,
+    "heap_sys_mb": 629,
+    "num_gc": 12,
+    "gc_pause_total_ms": 45,
+    "goroutines": 52
+  },
+  "endpoints": {
+    "GET /api/account": {
+      "count": 1733,
+      "mean_time_ms": 338.208,
+      "max_time_ms": 1050.2
+    }
+  },
+  "status_codes": {
+    "200": { "count": 546626, "mean_time_ms": 487.64, "max_time_ms": 3.45 }
+  },
+  "failed_calls": 284
+}</code></pre>
+</section>