Merge pull request #674 from r0fls/add-pv-capacity-metric

add persistent volume capacity metric
kubernetes · Feb 22, 2019 · fb19057 · fb19057
2 parents 83302c9 + 58fd352
commit fb19057
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/docs/persistentvolume-metrics.md b/docs/persistentvolume-metrics.md
@@ -2,6 +2,7 @@
 
 | Metric name| Metric type | Labels/tags | Status |
 | ---------- | ----------- | ----------- | ----------- |
+| kube_persistentvolume_capacity_bytes | Gauge | `persistentvolume`=&lt;pv-name&gt; | STABLE |
 | kube_persistentvolume_status_phase | Gauge | `persistentvolume`=&lt;pv-name&gt; <br>`phase`=&lt;Bound\|Failed\|Pending\|Available\|Released&gt;| STABLE |
 | kube_persistentvolume_labels | Gauge | `persistentvolume`=&lt;persistentvolume-name&gt; <br> `label_PERSISTENTVOLUME_LABEL`=&lt;PERSISTENTVOLUME_LABEL&gt;  | STABLE |
 | kube_persistentvolume_info | Gauge | `persistentvolume`=&lt;pv-name&gt; <br> `storageclass`=&lt;storageclass-name&gt; | STABLE |

diff --git a/internal/collector/persistentvolume.go b/internal/collector/persistentvolume.go
@@ -108,6 +108,21 @@ var (
 				}
 			}),
 		},
+		{
+			Name: "kube_persistentvolume_capacity_bytes",
+			Type: metric.MetricTypeGauge,
+			Help: "Persistentvolume capacity in bytes.",
+			GenerateFunc: wrapPersistentVolumeFunc(func(p *v1.PersistentVolume) *metric.Family {
+				storage := p.Spec.Capacity[v1.ResourceStorage]
+				return &metric.Family{
+					Metrics: []*metric.Metric{
+						{
+							Value: float64(storage.Value()),
+						},
+					},
+				}
+			}),
+		},
 	}
 )
 

diff --git a/internal/collector/persistentvolume_test.go b/internal/collector/persistentvolume_test.go
@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/kube-state-metrics/pkg/metric"
 )
@@ -34,6 +35,8 @@ func TestPersistentVolumeCollector(t *testing.T) {
 			# TYPE kube_persistentvolume_labels gauge
 			# HELP kube_persistentvolume_info Information about persistentvolume.
 			# TYPE kube_persistentvolume_info gauge
+			# HELP kube_persistentvolume_capacity_bytes The size of the Persistentvolume in bytes.
+			# TYPE kube_persistentvolume_capacity_bytes gauge
 	`
 	cases := []generateMetricsTestCase{
 		// Verify phase enumerations.
@@ -201,6 +204,22 @@ func TestPersistentVolumeCollector(t *testing.T) {
 				`,
 			MetricNames: []string{"kube_persistentvolume_labels"},
 		},
+		{
+			Obj: &v1.PersistentVolume{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "test-pv",
+				},
+				Spec: v1.PersistentVolumeSpec{
+					Capacity: v1.ResourceList{
+						v1.ResourceStorage: resource.MustParse("5Gi"),
+					},
+				},
+			},
+			Want: `
+					kube_persistentvolume_capacity_bytes{persistentvolume="test-pv"} 5.36870912e+09
+				`,
+			MetricNames: []string{"kube_persistentvolume_capacity_bytes"},
+		},
 	}
 	for i, c := range cases {
 		c.Func = metric.ComposeMetricGenFuncs(persistentVolumeMetricFamilies)