customresource as metric appendix and label prefix

docs/customresourcestate-metrics.md

@@ -49,7 +49,7 @@ spec:
           - --resources=certificatesigningrequests,configmaps,cronjobs,daemonsets,deployments,endpoints,foos,horizontalpodautoscalers,ingresses,jobs,limitranges,mutatingwebhookconfigurations,namespaces,networkpolicies,nodes,persistentvolumeclaims,persistentvolumes,poddisruptionbudgets,pods,replicasets,replicationcontrollers,resourcequotas,secrets,services,statefulsets,storageclasses,validatingwebhookconfigurations,volumeattachments,verticalpodautoscalers
 ```
 
-NOTE: The `cr_group`, `cr_version`, and `cr_kind` common labels are reserved, and will be overwritten by the values from the `groupVersionKind` field.
+NOTE: The `customresource_group`, `customresource_version`, and `customresource_kind` common labels are reserved, and will be overwritten by the values from the `groupVersionKind` field.
 
 ### Examples
 

pkg/customresourcestate/config.go

@@ -26,6 +26,10 @@ import (
 	"k8s.io/kube-state-metrics/v2/pkg/customresource"
 )
 
+// customResourceState is used to prefix the auto-generated GVK labels as well as an appendix for the metric itself
+// if no custom metric name is defined
+const customResourceState string = "customresource"
+
 // Metrics is the top level configuration object.
 type Metrics struct {
 	Spec MetricsSpec `yaml:"spec" json:"spec"`
@@ -64,7 +68,7 @@ type Resource struct {
 func (r Resource) GetMetricNamePrefix() string {
 	p := r.MetricNamePrefix
 	if p == nil {
-		return "kube_crd"
+		return "kube_" + customResourceState
 	}
 	return *p
 }

pkg/customresourcestate/registry_factory.go

@@ -32,17 +32,15 @@ import (
 	generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
 )
 
-const gvkLabelPrefix string = "cr_"
-
 func compile(resource Resource) ([]compiledFamily, error) {
 	var families []compiledFamily
 	// Explicitly add GVK labels to all CR metrics.
 	if resource.CommonLabels == nil {
 		resource.CommonLabels = map[string]string{}
 	}
-	resource.CommonLabels[gvkLabelPrefix+"group"] = resource.GroupVersionKind.Group
-	resource.CommonLabels[gvkLabelPrefix+"version"] = resource.GroupVersionKind.Version
-	resource.CommonLabels[gvkLabelPrefix+"kind"] = resource.GroupVersionKind.Kind
+	resource.CommonLabels[customResourceState+"_group"] = resource.GroupVersionKind.Group
+	resource.CommonLabels[customResourceState+"_version"] = resource.GroupVersionKind.Version
+	resource.CommonLabels[customResourceState+"_kind"] = resource.GroupVersionKind.Kind
 	for _, f := range resource.Metrics {
 		family, err := compileFamily(f, resource)
 		if err != nil {

pkg/customresourcestate/registry_factory_test.go

@@ -333,7 +333,7 @@ func Test_fullName(t *testing.T) {
 				resource: r(nil),
 				f:        count,
 			},
-			want: "kube_crd_count",
+			want: "kube_customresource_count",
 		},
 		{
 			name: "no prefix",