go-duck-cli 1.3.371 → 1.4.5

package/templates/docs/pages/configuration.hbs

@@ -68,11 +68,15 @@
     gcs: { enabled: false, bucket: "bucket-name", credentials-file: "keys.json" }
     minio: { enabled: true, bucket: "dev", endpoint: "localhost:9000" }
 
-  # --- Search Engine ---
-  elasticsearch:
-    enabled: true
-    addresses: ["http://localhost:9200"]
-    auto_sync: true</code></pre>
+  # --- Telemetry & Metrics ---
+  telemetry:
+    otel:
+      enabled: true
+      endpoint: "localhost:4317"
+    metrics:
+      prometheus-enabled: true
+      stream-enabled: true
+      stream-interval: "1s"
     </div>
 
     <!-- PARAMETER REFERENCE -->
@@ -203,6 +207,43 @@
         </div>
     </section>
 
+    <!-- SECTION: TELEMETRY -->
+    <section class="mb-16">
+        <h3 class="text-xl font-bold text-rose-700 mb-4 flex items-center">
+            <span class="w-2 h-2 rounded-full bg-rose-600 mr-2"></span>
+            5. Telemetry & Metrics (telemetry)
+        </h3>
+        <p class="text-sm text-slate-500 mb-4 italic leading-relaxed">Integrated observability stack powering OpenTelemetry traces, Prometheus metrics, and Server-Sent Events (SSE) streaming dashboards.</p>
+        <div class="overflow-hidden border border-slate-200 rounded-2xl shadow-sm">
+            <table class="w-full text-left border-collapse">
+                <thead class="bg-slate-50 border-b border-slate-200">
+                    <tr>
+                        <th class="p-4 text-xs font-black text-slate-500 uppercase tracking-widest">Parameter</th>
+                        <th class="p-4 text-xs font-black text-slate-500 uppercase tracking-widest">Purpose</th>
+                    </tr>
+                </thead>
+                <tbody class="text-sm text-slate-600">
+                    <tr class="border-b border-slate-100 italic">
+                        <td class="p-4 font-mono text-rose-600">otel.enabled</td>
+                        <td class="p-4 text-slate-600">Enables OpenTelemetry context propagation across Gin routers and GORM database drivers.</td>
+                    </tr>
+                    <tr class="border-b border-slate-100 italic font-medium">
+                        <td class="p-4 font-mono text-rose-600">metrics.prometheus-enabled</td>
+                        <td class="p-4 text-slate-600">Exposes a <code>/metrics</code> endpoint for Kubernetes Horizontal Pod Autoscaling (HPA) and Prometheus scraping.</td>
+                    </tr>
+                    <tr class="border-b border-slate-100 italic">
+                        <td class="p-4 font-mono text-rose-600">metrics.stream-enabled</td>
+                        <td class="p-4 text-slate-600">Exposes a <code>/api/system/stream</code> Server-Sent Events endpoint streaming CPU, Memory, and Load percentages.</td>
+                    </tr>
+                    <tr>
+                        <td class="p-4 font-mono text-rose-600">metrics.stream-interval</td>
+                        <td class="p-4 text-slate-600">The refresh rate of the SSE stream (e.g., "1s", "500ms").</td>
+                    </tr>
+                </tbody>
+            </table>
+        </div>
+    </section>
+
     <!-- RESILIENCE & SEARCH -->
     <div class="grid grid-cols-1 md:grid-cols-2 gap-8 mb-20">
         <div class="p-8 bg-rose-50 rounded-[2.5rem] border border-rose-100">

package/templates/docs/pages/mosquitto.hbs

@@ -29,6 +29,12 @@ messaging.Publish("events/users", event)</code></pre>
 mosquitto_sub -h localhost -p {{mqttPort}} -t "audit/logs/#" -v</code></pre>
 </section>
 
+<section class="mb-10">
+    <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">Interactive Swagger Console</h2>
+    <p class="mb-4">GO-DUCK's automatically generated Swagger UI features a built-in <strong>Interactive MQTT Topics Dictionary</strong>. By connecting via WebSockets, it allows authenticated users to dynamically <strong>SUBSCRIBE</strong> to event streams or <strong>PUBLISH</strong> payloads directly from the documentation interface!</p>
+    <p class="mb-4 text-sm text-gray-600 italic">Note: Ensure your Mosquitto broker is configured to accept WebSocket connections (default port 9001) for this feature to work.</p>
+</section>
+
 <section class="mb-10">
     <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">External Resources</h2>
     <ul class="space-y-2">

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>