Merge pull request #2142 from vprashar2929/chore-pod-m

docs: include pod level metrics

Author: Sunil Thaha

.github/workflows/pr-checks.yaml

@@ -78,6 +78,22 @@ jobs:
         shell: bash
         run: make vet && git diff --exit-code
 
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout source
+        uses: actions/checkout@v4
+
+      - name: setup go
+        uses: actions/[email protected]
+        with:
+          go-version-file: go.mod
+          cache: false
+
+      - name: make gen-metrics-docs
+        shell: bash
+        run: make gen-metrics-docs && git diff --exit-code
+
   test-and-codecov:
     needs: check-changes
     if: needs.check-changes.outputs.changes == 'true'

docs/metrics/metrics.md

@@ -171,6 +171,30 @@ These metrics provide energy and power information for virtual machines.
   - `hypervisor`
   - `zone`
 
+### Pod Metrics
+
+These metrics provide energy and power information for pods.
+
+#### kepler_pod_cpu_joules_total
+
+- **Type**: COUNTER
+- **Description**: Energy consumption of cpu at pod level in joules
+- **Labels**:
+  - `pod_id`
+  - `pod_name`
+  - `pod_namespace`
+  - `zone`
+
+#### kepler_pod_cpu_watts
+
+- **Type**: GAUGE
+- **Description**: Power consumption of cpu at pod level in watts
+- **Labels**:
+  - `pod_id`
+  - `pod_name`
+  - `pod_namespace`
+  - `zone`
+
 ### Other Metrics
 
 Additional metrics provided by Kepler.
@@ -188,4 +212,4 @@ Additional metrics provided by Kepler.
 
 ---
 
-This documentation was automatically generated by the gen-metric-docs tool. Generated on 2025-06-08
+This documentation was automatically generated by the gen-metric-docs tool. Generated on 2025-06-11

hack/gen-metric-docs/main.go

@@ -135,6 +135,7 @@ func generateMarkdown(metrics []MetricInfo) string {
 	containerMetrics := []MetricInfo{}
 	processMetrics := []MetricInfo{}
 	vmMetrics := []MetricInfo{}
+	podMetrics := []MetricInfo{}
 	otherMetrics := []MetricInfo{}
 
 	for _, metric := range metrics {
@@ -147,6 +148,8 @@ func generateMarkdown(metrics []MetricInfo) string {
 			processMetrics = append(processMetrics, metric)
 		case strings.HasPrefix(metric.Name, "kepler_vm_"):
 			vmMetrics = append(vmMetrics, metric)
+		case strings.HasPrefix(metric.Name, "kepler_pod_"):
+			podMetrics = append(podMetrics, metric)
 		default:
 			otherMetrics = append(otherMetrics, metric)
 		}
@@ -172,6 +175,11 @@ func generateMarkdown(metrics []MetricInfo) string {
 		md.WriteString("These metrics provide energy and power information for virtual machines.\n\n")
 		writeMetricsSection(&md, vmMetrics)
 	}
+	if len(podMetrics) > 0 {
+		md.WriteString("### Pod Metrics\n\n")
+		md.WriteString("These metrics provide energy and power information for pods.\n\n")
+		writeMetricsSection(&md, podMetrics)
+	}
 	if len(otherMetrics) > 0 {
 		md.WriteString("### Other Metrics\n\n")
 		md.WriteString("Additional metrics provided by Kepler.\n\n")